アラート通知API
監視したいリスクテーマを登録・購読（送信：setAlert）すると，サーバ側で監視し，リスク発生時にプッシュ通知（着信：notifyAlert）します。
登録した登録した監視対象はいつでも変更（送信：alterAlert）可能です。
アラート通知APIのメッセージのやりとりはWebSocketを利用しますが、入出力内容はJSON-RPCの形式で行います。
一般的なウェブブラウザからの通信を想定して、より簡単に使用できるアラート通知APIクライアントを提供しています。
エンドポイント
wss://<api-server>/api/v1/alertapi/socket.io/
APIキーと秘密鍵
当APIの利用にはAPIキーと秘密鍵が必要です。
WebSocket送信時にはHTTPヘッダ部に それぞれ下記のヘッダ名で送信する必要があります。
- APIキー：APIKey
- 秘密鍵：Secret
この2つのキーはWebSocketの送信時には実際は送信しにくいため、アラート通知APIクライアントで送信できる機能を提供しています。
テーマ
取得したいリスク（アラート）の集合を便宜上テーマと呼びますが、アラート通知APIでは下記のいずれかを入力（setAlert, alterAlert) 内で指定します。
詳しいテーマの内容についてはマニュアルをご覧ください。
| テーマ名 |
|---|
| rm_accident |
| rm_congestion |
| rm_dalat_domingo |
| rm_dalat_hazardous |
| rm_dalat_polution |
| rm_dalat_wind |
| rm_dalat_xrain |
| rm_domingo |
| rm_hiyarihatto |
| rm_hiyarihatto_normalized |
| rm_panda |
| rm_ssm2019_domingo |
| rm_ssm2019_domingo_xrain |
| rm_ssm2019_rt_nowcast |
| rm_ssm2019_xrain |
| rm_ssm2019_xrain_1min |
| rm_xrain |
| rm_xrain_for_hiyarihatto |
メソッド
この項目でのメソッドとは、JSON-RPCのリクエストボディ内の method キーに記述するメソッドを指します。
下記の個別ページに各メソッドの詳細を記しています。