alerts.in.ua API

Загальні відомості Edit

Cервіс alerts.in.ua відображає інформацію про повітряні тривоги та інші загрози на мапі України. Усі дані про загрози беруться з офіційних джерел, такі як канал “Повітряна тривога”, ОВА, Суспільне, ДСНС, тощо.

Для сторонніх розробників доступний API, який дозволяє використовувати дані сервісу в інших застосунках чи фізичних пристроях.

Аутентифікація Edit

Для доступу до API необхідно використовувати персональний API токен. Заповніть форму і ми надішлемо Вам токен.

Токен - це секрет, будь ласка, не розповсюджуйте його в мережі. Будь-яка діяльність з токеном асоціюється з Вашим проєктом.

Кожен запит має містити токен в параметрах запиту або в HTTP Header.

В параметрах запиту:

https://api.alerts.in.ua/v1/alerts/active.json?token=<YOUR_APP_TOKEN>

В HTTP Header:

  https://api.alerts.in.ua/v1/alerts/active.json

  Authorization: Bearer <YOUR_APP_TOKEN>

Помилки Edit

Усі методи API можуть повертати помилки. Помилки повертаються в форматі JSON.

Приклад відповіді з помилкою:

{
  "message": "Error occured"
}

Обмеження Edit

На всі API запити діють обмеження по кількості запитів в секунду.

При перевищенні ліміту сервер буде повертати код 429 Too many requests. При систематичному порушені IP та token будуть заблоковані.

Також при аномальній кількості запитів на день, Ваш токен може бути заблокований.

Використання у публічних сервісах

Для публічних сервісів використовуйте свій сервер для проксування запитів. Тобто кінцевий користувач повинен отримувати дані через Ваш проксі, а не напряму з alerts.in.ua API. Не харкодьте токен в коді, що отримує користувач (мобільний застосунок, веб-сторінка). Вийняток становлять фізичні пристрої, які не можуть використовувати проксі.

Кешування

Для кешування запитів можете використовувати хедер If-Modified-Since з Last-Modified для усіх API. В цьому випадку Ви зможете завантажувати дані тільки коли були здійснені зміни.

Відмова від відповідальності Edit

Не використовуйте API для критичної інфраструктури.

Доступ до API, а також використання його вмісту здійснюються виключно на Ваш розсуд і на Ваш ризик. Ні за яких обставин Адміністрація Сервісу не несе відповідальності ні перед якою стороною за будь-якої прямої, непрямої, особливий або інший непрямий збиток в результаті будь-якого використання інформації цього Сервісу.

В роботі сервісу можливі затримки з оновленням інформації пов’язані як з технічними моментами, так і з людським фактором, що можете від нас не залежати.

Ми докладаємо всіх зусиль, щоб сервіс працював безперебійно. Однак, не несемо відповідальності за те, що сервіс став тимчасово недоступний через технічні проблеми. У випадку відомих нам технічних проблем ми повідомляємо про це в наш телеграм канал.

Якщо Ви використовуєте API, Ви автоматично погоджуєтесь з встановленими Правилами і приймаєте всю відповідальність, яка може бути на Вас покладена.

/v1/alerts/active Edit

Список активних тривог

Повертає список регіонів в яких активна повітряна тривога чи будь-яка інша загроза.

# Sync mode
from alerts_in_ua import Client as AlertsClient

alerts_client = AlertsClient(token="YOUR_APP_KEY")
active_alerts = alerts_client.get_active_alerts()
print(active_alerts)

# Async mode
import asyncio
from alerts_in_ua import AsyncClient as AsyncAlertsClient

async def main():
  alerts_client = AsyncAlertsClient(token="YOUR_APP_KEY")
  active_alerts = await alerts_client.get_active_alerts()
  print(active_alerts)

asyncio.run(main())

const request = require('request');

const token = "<YOUR_APP_KEY>";
const options = {
  url: 'https://api.alerts.in.ua/v1/alerts/active.json',
    headers: {
    'Authorization': `Bearer ${token}`
  }
};

request.get(options, (error, response, body) => {
    if (error) {
      console.error(error);
      return;
    }
    console.log(JSON.parse(body));
});

require 'rest_client'
require 'json'

token = "<YOUR_APP_KEY>"
url = 'https://api.alerts.in.ua/v1/alerts/active.json'
headers = { 'Authorization': "Bearer #{token}" }

begin
  response = RestClient.get(url, headers)
  if response.code == 200
    result = JSON.parse(response.body)
    puts result
  else
    puts "Error: #{response.code} - #{response.body}"
  end
rescue RestClient::ExceptionWithResponse => e
  puts "Error: #{e.response.code} - #{e.response.body}"
end

curl https://api.alerts.in.ua/v1/alerts/active.json?token=YOUR_APP_KEY

/v1/iot/active_air_raid_alerts_by_oblast.json Edit

Статус повітряних тривог в областях

Повертає стан повітряних тривог в областях. Компактне API для використання в IoT пристроях.

Результат повертається у вигляді JSON, що містить рядок:

"ANNNNNNNNNNNANNNNNNNNNNNNNN"

де:

Для кожної букви рядка є своя область в наступному порядку:

["Автономна Республіка Крим", "Волинська область", "Вінницька область", "Дніпропетровська область", "Донецька область", "Житомирська область", "Закарпатська область", "Запорізька область", "Івано-Франківська область", "м. Київ", "Київська область", "Кіровоградська область", "Луганська область", "Львівська область", "Миколаївська область", "Одеська область", "Полтавська область", "Рівненська область", "м. Севастополь", "Сумська область", "Тернопільська область", "Харківська область", "Херсонська область", "Хмельницька область", "Черкаська область", "Чернівецька область", "Чернігівська область"]

Тобто перша буква в рядку - статус повітряної тривоги в Автономній Республіці Крим, друга - в Волинській області, третя - в Вінницькій області і т.д.

  # Sync mode
  from alerts_in_ua import Client as AlertsClient
  
  alerts_client = AlertsClient(token="YOUR_APP_KEY")
  active_alerts = alerts_client.get_air_raid_alert_statuses_by_oblast()
  print(active_alerts)

# Async mode
import asyncio
from alerts_in_ua import AsyncClient as AsyncAlertsClient

async def main():
   alerts_client = AsyncAlertsClient(token="YOUR_APP_KEY")
   active_alerts = await alerts_client.get_air_raid_alert_statuses_by_oblast()
   print(active_alerts)

asyncio.run(main())

  require 'rest-client'
  require 'json'
  
  # API endpoint
  url = 'https://api.alerts.in.ua/v1/iot/active_air_raid_alerts_by_oblast.json'
  token = "<YOUR_APP_KEY>"

  # Fetch the data from the API
  headers = { 'Authorization': "Bearer #{token}" }
  
  # Parse the JSON response
  begin
      response = RestClient.get(url, headers)
      if response.code == 200
        data = JSON.parse(response.body)
        
        # Create a hash mapping oblast names to their corresponding statuses
        oblast_status_map = {}
        oblasts = ["Автономна Республіка Крим", "Волинська область", "Вінницька область", ...]
        data.each_char.with_index do |status, i|
            oblast_status_map[oblasts[i]] = case status
            when 'A'
            'Active'
            when 'P'
            'Partly'
            when 'N'
            'No alerts'
            end
        end    
        # Output the oblast status map
        puts oblast_status_map
      else
        puts "Error: #{response.code} - #{response.body}"
      end
  rescue RestClient::ExceptionWithResponse => e
         puts "Error: #{e.response.code} - #{e.response.body}"
  end

curl https://api.alerts.in.ua/v1/iot/active_air_raid_alerts_by_oblast.json?token=YOUR_APP_KEY

/v1/iot/active_air_raid_alerts/:uid.json Edit

Повертає статус тривоги в вказаній області

Parameters

uid

Унікальний ідентифікатор області

Повертає стан тривоги в вказаній області. Компактне API для використання в IoT пристроях.

Результат повертається у вигляді JSON, що містить рядок:

"A"

де:

  # Sync mode
  from alerts_in_ua import Client as AlertsClient

  alerts_client = AlertsClient(token="YOUR_APP_KEY")
  alert_status = alerts_client.get_air_raid_alert_status()
  # or alert_status = alerts_client.get_air_raid_alert_status('Луганська область')
  print(alert_status)

# Async mode
import asyncio
from alerts_in_ua import AsyncClient as AsyncAlertsClient

async def main():
   alerts_client = AsyncAlertsClient(token="YOUR_APP_KEY")
   alert_status = await alerts_client.get_air_raid_alert_status(16)
   # or alert_status = await alerts_client.get_air_raid_alert_status('Луганська область')
   print(alert_status)

asyncio.run(main())

  require 'rest-client'
  require 'json'

  # API endpoint
  url = 'https://api.alerts.in.ua/v1/iot/active_air_raid_alerts/16.json'
  token = "<YOUR_APP_KEY>"

  # Fetch the data from the API
  headers = { 'Authorization': "Bearer #{token}" }

  # Parse the JSON response
  begin
      response = RestClient.get(url, headers)
      if response.code == 200
        data = JSON.parse(response.body)
        status = case data[0]
        when 'A'
           'Active'
        when 'P'
           'Partly'
        when 'N'
           'No alerts'
        end
        # Output the oblast status map
        puts status
      else
        puts "Error: #{response.code} - #{response.body}"
      end
  rescue RestClient::ExceptionWithResponse => e
         puts "Error: #{e.response.code} - #{e.response.body}"
  end

curl https://api.alerts.in.ua/v1/iot/active_air_raid_alerts/16.json?token=YOUR_APP_KEY

/v1/regions/:uid/alerts/:period.json Edit

Повертає історію тривог за певний період

Parameters

uid

Унікальний ідентифікатор області

period

Період для якого повертається історія тривог.

Через навантаження на сервери ця функція має окремий ліміт 2 рази на хвилину. І з 20 листопада 2023 цей ліміт буде переглянуто. Не рекомендується використовувати цю функцію в реальному часі.

Повертає список тривог за вказаний період.

# Sync mode
from alerts_in_ua import Client as AlertsClient

alerts_client = AlertsClient(token="YOUR_APP_KEY")
active_alerts = alerts_client.get_alerts_history(16,period="month_ago")
# or active_alerts = alerts_client.get_alerts_history("Луганська область",period="month_ago")
print(active_alerts)

# Async mode
import asyncio
from alerts_in_ua import AsyncClient as AsyncAlertsClient

async def main():
  alerts_client = AsyncAlertsClient(token="YOUR_APP_KEY")
  active_alerts = await alerts_client.get_alerts_history(16,period="month_ago")
  # or active_alerts = await alerts_client.get_alerts_history("Луганська область",period="month_ago")
  print(active_alerts)

asyncio.run(main())

const request = require('request');

const token = "<YOUR_APP_KEY>";
const oblast_uid = "16";
const options = {
  url: 'https://api.alerts.in.ua/v1/regions/${oblast_uid}/alerts/month_ago.json',
    headers: {
    'Authorization': `Bearer ${token}`
  }
};

request.get(options, (error, response, body) => {
    if (error) {
      console.error(error);
      return;
    }
    console.log(JSON.parse(body));
});

require 'rest_client'
require 'json'

token = "<YOUR_APP_KEY>"
oblast_uid = "16"
url = "https://api.alerts.in.ua/v1/regions/#{oblast_uid}/alerts/month_ago.json"
headers = { 'Authorization': "Bearer #{token}" }

begin
  response = RestClient.get(url, headers)
  if response.code == 200
    result = JSON.parse(response.body)
    puts result
  else
    puts "Error: #{response.code} - #{response.body}"
  end
rescue RestClient::ExceptionWithResponse => e
  puts "Error: #{e.response.code} - #{e.response.body}"
end

curl https://api.alerts.in.ua/v1/regions/16/alerts/month_ago.json?token=YOUR_APP_KEY

Alert Edit

Сутність, що представляє собою інформацію про тривогу.

Location UID Edit

Унікальний ідентифікатор локації

Кожна локація має свій унікальний ідентифікатор. Тут представлені ідентифікатори областей та міст зі спеціальними статусами.