Skip to content

Navigation Menu

Sign in
Sign up

Repository files navigation

UkraineAlarm - Javascript library for the Ukraine Alert API

  • API version: 3.0
  • Package version: 3.0

Getting Started

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);

Documentation for API Endpoints

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")

Documentation for Models

Documentation for Authorization

Token

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

About

No description, website, or topics provided.

Resources

Stars

1 star

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages

AltStyle によって変換されたページ (->オリジナル) /