WebSocket API

認証について

  • APIを利用するには、認証のためにユーザIDとパスワードを利用します。

  • ユーザIDとパスワードは利用申請時に発行されます。

  • 認証は以下の手順で行います。

    1. WebSocket APIサーバとwebsocket接続を確立します。
    2. 認証のリクエストメッセージを生成します。
    3. websocketサーバにリクエストメッセージ(認証要求)を送信します。
    4. websocketサーバからレスポンスメッセージ(認証応答)を受信します。
    • 認証エラーとなった場合、websocket接続が切断されます。
    • 一定時間以内に認証メッセージがサーバに通知されない場合、websocket接続が切断されます。
  • 具体的な認証手順は、 利用例 をご参照ください。


通信シーケンスについて

  • 認証シーケンス
  • 情報配信シーケンス

WebSocket API一覧

No タイプ エンドポイントURL データ形式 文字コード 概要
1 情報配信(SEND) 利用申請時に通知 JSON UTF-8 配信情報データを通知する。
2 情報受信(RECEIVE) 利用申請時に通知 JSON UTF-8 配信情報データを受信する。