注意
xData EdgeではこのAPIは使えません
アラート通知API - 概要
監視したいリスクテーマを登録・購読（送信：setAlert）すると，サーバ側で監視し，リスク発生時にプッシュ通知（着信：notifyAlert）します。
登録した登録した監視対象はいつでも変更（送信：alterAlert）可能です。
アラート通知APIのメッセージのやりとりはWebSocketを利用しますが、入出力内容はJSON-RPCの形式で行います。
一般的なウェブブラウザからの通信を想定して、より簡単に使用できるアラート通知APIクライアントを提供しています。
エンドポイント
wss://<api-server-endpoint>/api/v1/alertapi/socket.io/
APIキーと秘密鍵
WebSocket送信時にはHTTPヘッダ部に それぞれ下記のヘッダ名で送信する必要があります。
- APIキー：APIKey
- 秘密鍵：Secret
この2つのキーはWebSocketの送信時には実際は送信しにくいため、アラート通知APIクライアントで送信できる機能を提供しています。
アラート通知の受信(Pub/Sub)
アラート、アラート条件、アラート通知API
指定した空間範囲やテーマで雨量・渋滞・交通事故などのリスクがしきい値を超えたときに通知する仕組みをアラートと呼びます。
また、警戒したい空間範囲や対象とするテーマ、しきい値など、アラートを通知するかどうかのチェックを行う条件をアラート条件と呼びます。
アラート条件に従ってアラートをリスクマップデータより検索し、JSON-RPCのレスポンス形式で配信するAPIをアラート通知APIと呼びます。
使い方
アラート通知APIは下記の手順で使用します。
- 取得するテーマと空間範囲、時間を検討
- APIキーとアラート通知APIクライアントの取得
- 実装
以下，それぞれの手順について説明します．
取得するテーマと空間範囲、時間を検討
まず最初に、使用したいリスクが保存されたテーマを調べ、その空間範囲と時間を決めます。 下記のテーマの中から使用したいテーマを決めます。
| テーマ名 | リスクマップデータの概要 | 空間の概要 | 時間 | |
|---|---|---|---|---|
| rm_accident | アクシデント | 神戸市、芦屋市、西宮市、伊丹市、尼崎市を中心とした兵庫県・大阪府近辺 | 2016/09/04 16:00より1分刻み | |
| rm_congestion | PANDA x JARTIC | 姫路市、加古川市、明石市、淡路市、神戸市を中心とした兵庫県近辺 | 2014/05/1 6:46:30より30秒刻み | |
| rm_dalat_domingo | Dalat用DOMINGO | Dalat周辺のモックアップデモ用ダミーデータ | 2018/09/03 08:00:00より5分刻み | |
| rm_dalat_hazardous | Dalat用hazard | Dalat周辺のモックアップデモ用ダミーデータ | 2020/03/31 00:00:00より1分刻み | |
| rm_dalat_polution | Dalat用Polution | Dalat周辺のモックアップデモ用ダミーデータ | 2020/02/21 08:00:00より1分刻み | |
| rm_dalat_wind | Dalat用Wind | Dalat周辺のモックアップデモ用ダミーデータ | 2020/03/21 08:00:00より1分刻み | |
| rm_dalat_xrain | Dalat用XRAIN | Dalat周辺のモックアップデモ用ダミーデータ | 2018/08/01 00:00:00より5分刻み | |
| rm_domingo | DOMINGO交通障害 | 中野区を中心とした約1km×1kmのメッシュ（東西約8km，南北約11km） | 2018/01/22 12:00より5分刻み | |
| rm_hiyarihatto | ヒヤリ・ハット | 東京区部の道路・交差点付近 17,718 地点のポイント（ただし偏りあり） | 全時間帯 | 時間によって変化するリスクマップではないため、どの時間が指定されても結果は同じ |
| rm_hiyarihatto_normalized | ヒヤリ・ハット | 文京区内の道路及び交差点付近 2,703 地点のポイント | 2018-09-18 17:30:00+09 - 2018-09-18 20:29:00+09 で1分刻み | ヒヤリ・ハットのリスクに加えてXRAINの降水量で補正したデータ |
| rm_panda | PANDA | 大阪府、兵庫県、京都府を中心とした関西近辺 | 2016/09/01 16:00より30秒刻み | |
| rm_ssm2019_domingo | DOMINGO | 厚木、平塚、藤沢、鎌倉を中心とした神奈川南部近辺 | 2018/09/03 08:00 より5分刻み | |
| rm_ssm2019_domingo_xrain | DOMINGO x XRAIN | 厚木、平塚、藤沢、鎌倉を中心とした神奈川南部近辺 | 2018/09/03 08:00 より5分刻み | |
| rm_ssm2019_rt_nowcast | ナウキャスト | 厚木、平塚、藤沢、鎌倉を中心とした神奈川南部近辺 | 2020/02/20 12:40 より5分刻み | |
| rm_ssm2019_xrain | XRAIN | 厚木、平塚、藤沢、鎌倉を中心とした神奈川南部近辺 | 2018/08/01 00:40 より5分刻み | |
| rm_ssm2019_xrain_1min | XRAIN | 厚木、平塚、藤沢、鎌倉を中心とした神奈川南部近辺 | 2018/09/01 00:00 より1分刻み | |
| rm_xrain | XRAIN | 大阪府、京都府、兵庫県、奈良県、三重県、和歌山県、愛知県、滋賀県、徳島県、香川県近辺 | 2016/09/01 00:00より1分刻み | |
| rm_xrain_for_hiyarihatto | XRAIN x ヒヤリ・ハット | 関東、中部、近畿、四国近辺 | 2018/09/18 17:30より1分刻み |
また、空間範囲の詳細については下記の表にGeoJSONの形で表示しました。http://geojson.io 等を使って範囲を確認してください。
rm_accident
{"type":"Polygon","coordinates":[[[135.125,34.666666666667],[135.125,34.833333333333],[135.5,34.833333333333],[135.5,34.666666666667],[135.125,34.666666666667]]]}
rm_congestion
{"type":"Polygon","coordinates":[[[134.521554851191,34.2830256567723],[134.521554851191,34.9461410098947],[135.431570148809,34.9461410098947],[135.431570148809,34.2830256567723],[134.521554851191,34.2830256567723]]]}
rm_dalat_domingo
{"type":"Polygon","coordinates":[[[108.194097222222,11.8506944444448],[108.194097222222,12.1048611111108],[108.575347222222,12.1048611111108],[108.575347222222,11.8506944444448],[108.194097222222,11.8506944444448]]]}
rm_dalat_hazardous
{"type":"Polygon","coordinates":[[[108.436640507387,11.9393545672872],[108.436640507387,11.9411614326446],[108.438475493353,11.9411614326446],[108.438475493353,11.9393545672872],[108.436640507387,11.9393545672872]]]}
rm_dalat_polution
{"type":"Polygon","coordinates":[[[108.375,11.916666666667],[108.375,12],[108.5,12],[108.5,11.916666666667],[108.375,11.916666666667]]]}
rm_dalat_wind
{"type":"Polygon","coordinates":[[[108.197222222222,11.8527777777778],[108.197222222222,12.1027777777778],[108.572222222222,12.1027777777778],[108.572222222222,11.8527777777778],[108.197222222222,11.8527777777778]]]}
rm_dalat_xrain
{"type":"Polygon","coordinates":[[[108.197222222222,11.8527777777778],[108.197222222222,12.1027777777778],[108.572222222222,12.1027777777778],[108.572222222222,11.8527777777778],[108.197222222222,11.8527777777778]]]}
rm_domingo
{"type":"Polygon","coordinates":[[[139.625244,35.648369],[139.625244,35.746512],[139.713135,35.746512],[139.713135,35.648369],[139.625244,35.648369]]]}
rm_hiyarihatto
{"type":"Polygon","coordinates":[[[139.631834417037,35.5914144456976],[139.631834417037,35.7790291589697],[139.872114671177,35.7790291589697],[139.872114671177,35.5914144456976],[139.631834417037,35.5914144456976]]]}
rm_hiyarihatto_normalized
{"type":"Polygon","coordinates":[[[139.717636353308,35.699204530787],[139.717636353308,35.7355328554088],[139.772832896927,35.7355328554088],[139.772832896927,35.699204530787],[139.717636353308,35.699204530787]]]}
rm_panda
{"type":"Polygon","coordinates":[[[134.295,34.169781],[134.295,35.364],[136.179357,35.364],[136.179357,34.169781],[134.295,34.169781]]]}
rm_ssm2019_domingo
{"type":"Polygon","coordinates":[[[139.246875,35.247916666667],[139.246875,35.502083333333],[139.628125,35.502083333333],[139.628125,35.247916666667],[139.246875,35.247916666667]]]}
rm_ssm2019_domingo_xrain
{"type":"Polygon","coordinates":[[[139.25,35.25],[139.25,35.5],[139.625,35.5],[139.625,35.25],[139.25,35.25]]]}
rm_ssm2019_rt_nowcast
{"type":"Polygon","coordinates":[[[139.25,35.25],[139.25,35.5],[139.625,35.5],[139.625,35.25],[139.25,35.25]]]}
rm_ssm2019_xrain
{"type":"Polygon","coordinates":[[[139.25,35.25],[139.25,35.5],[139.625,35.5],[139.625,35.25],[139.25,35.25]]]}
rm_ssm2019_xrain_1min
{"type":"Polygon","coordinates":[[[139.25,35.25],[139.25,35.5],[139.625,35.5],[139.625,35.25],[139.25,35.25]]]}
rm_xrain
{"type":"Polygon","coordinates":[[[134,33.5833333333333],[134,36],[137.375,36],[137.375,33.5833333333333],[134,33.5833333333333]]]}
rm_xrain_for_hiyarihatto
{"type":"Polygon","coordinates":[[[134,33.6166666666667],[134,37.5],[141.125,37.5],[141.125,33.6166666666667],[134,33.6166666666667]]]}
リスクマップデータはそれぞれデータが登録されている期間や範囲が異なっていますので、目的によって選択します。
APIキーとアラート通知APIクライアントの取得
アラート通知APIを使用するには、APIキー・秘密鍵の発行が必要になります。EvWH管理者に申請してください。
アラート通知APIでは、ブラウザから使用することを前提としてクライアントとして利用できるJavaScriptモジュールを提供しています。 /bidal/alert-api-client/blob/develop/build/AlertApiClientModule.js よりJavaScriptモジュールを取得して使用してください。
実装
アラート通知APIクライアントを使ってアラート通知APIからデータを取得します。 具体的な使い方はリファレンスをご覧ください。