WebSocket API

認証について

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

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

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

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

  • 具体的な認証手順は、 利用例 をご参照ください。


通信シーケンスについて

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

使用するプロトコル

項目 規格
プロトコル Sec-WebSocket-Version 13(RFC 6455)
リクエスト(送信)フォーマット JSON
レスポンス(受信)フォーマット JSON
文字コード UTF-8
http通信(ws通信)のサポート サポートしておりません
https通信(wss通信)のサポート
TLS 1.2、TLS 1.3をサポート
※TLS 1.1、TLS 1.0のサポートは、2021年3月17日をもって終了いたしました。
エンドポイントURL 利用申請時に通知
keepalive通知間隔 3分
keepalive応答タイムアウト 30秒
websocket認証タイムアウト 5秒
  • APIを利用するには、websocketを利用します。
    • 利用者が作成したクライアントプログラムから、エンドポイントURLに対してwebsocket接続をしてください。
    • websocket接続は、セキュアなwssでのみ接続を受け付けます。
    • websocketのkeepalive機能により、クライアントからの通信が一定時間発生しなかった場合、Pingフレームを通知します。
      • 一定時間内にPongフレームを通知しない場合、クライアントとのwebsocket接続を切断します。
  • 短時間に大量の接続やデータ通信が行われた場合、サービスの健全性を保つためリクエストを制限する場合があります。

WebSocket API一覧

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