UkraineAlarm - Javascript library for the Ukraine Alert API
- API version: 3.0
- Package version: 3.0
Please follow the installation instruction and execute the following JS code:
var UkraineAlertApi = require('ukraine_alert_api'); var defaultClient = UkraineAlertApi.ApiClient.instance; // Configure API key authorization: Token var Token = defaultClient.authentications['Token']; Token.apiKey = "YOUR API KEY" // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) //Token.apiKeyPrefix['Authorization'] = "Token" var api = new UkraineAlertApi.AlertsApi() var callback = function(error, data, response) { if (error) { console.error(error); } else { console.log('API called successfully. Returned data: ' + data); } }; api.apiV3AlertsGet(callback);
All URIs are relative to /
| Class | Method | HTTP request | Description |
|---|---|---|---|
| UkraineAlertApi.AlertsApi | apiV3AlertsGet | GET /api/v3/alerts | Області, регіони та громади з тривогами |
| UkraineAlertApi.AlertsApi | apiV3AlertsRegionHistoryGet | GET /api/v3/alerts/regionHistory | Отримати останніх 25 тривог регіону |
| UkraineAlertApi.AlertsApi | apiV3AlertsRegionIdGet | GET /api/v3/alerts/{regionId} | Статус області/регіону/громади |
| UkraineAlertApi.AlertsApi | apiV3AlertsStatusGet | GET /api/v3/alerts/status | Перевірка номеру останньої дії. Використовувати для перевірки необхідності оновлювати дані |
| UkraineAlertApi.RegionsApi | apiV3RegionsGet | GET /api/v3/regions | Повертає список усіх областей, регіонів та міст |
| UkraineAlertApi.WebHookApi | apiV3WebhookDelete | DELETE /api/v3/webhook | Відписка на WebHook про нові сирени та їх відбій |
| UkraineAlertApi.WebHookApi | apiV3WebhookPatch | PATCH /api/v3/webhook | Оновлення WebHook посилання про нові сирени та їх відбій |
| UkraineAlertApi.WebHookApi | apiV3WebhookPost | POST /api/v3/webhook | Підписка на WebHook про нові сирени та їх відбій. У вебхукі відпрявляється подія тривоги/відбою (приклад в відповіді "200") |
- UkraineAlertApi.Alert
- UkraineAlertApi.AlertModification
- UkraineAlertApi.AlertRegionModel
- UkraineAlertApi.AlertType
- UkraineAlertApi.RegionAlarmModel
- UkraineAlertApi.RegionAlarmsHistory
- UkraineAlertApi.RegionViewModel
- UkraineAlertApi.RegionsViewModel
- UkraineAlertApi.TimeSpan
- UkraineAlertApi.V2RegionType
- UkraineAlertApi.WebHookModel
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header