Alert notification API
When the risk theme you wish to monitor is registered and subscribed (transmission: setAlert), monitoring occurs on the server side, and when a risk occurs, a push notification (reception: notifyAlert) is issued.
The registered monitoring target can be changed (transmission: alterAlert) at any time.
While WebSocket is used for exchanging Alert notification API messages, I/O information is exchanged using the JSON-RPC format.
Alert notification API Client, which can be used more easily, is provided for communications from regular web browsers.
Endpoints
wss://<api-server>/api/v1/alertapi/socket.io/
API key and secret key
An API key and secret key are required to use this API.
During WebSocket transmission, each of the following key names need to be transmitted in the HTTP header field. - API key: APIKey - Secret key: Secret
As it is difficult to actually transmit these two keys during WebSocket transmission, a function allowing them to be transmitted with an Alert notification API client is provided.
Theme
For convenience, a group of the risks (alerts) you wish to acquire is referred to as a theme, but in the Alert notification API, either of the following are input within (setAlert, alterAlert).
See the manual for detailed information on themes.
| Theme Name |
|---|
| 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 |
Method
In this item, method refers to a method describing the method key inside the JSON-RPC request body.
Details of each method are described in the following individual pages.