Документація Тривога
Отримання токена доступу: Пригода починається! Щоб отримати свій токен доступу, вам доведеться пройти захопливий процес авторизації. Перш ніж вирушити в цю пригоду, просто зайдіть на сайт і перемістіть курсор до особистого кабінету.
На вкладці "Ключі доступу" натискайте на кнопку «Створити новий ключ». Зверніть увагу: поки що він неактивний, як ваші плани на вечір, коли настає час зустрічі з друзями! Щоб активувати ключ, натисніть «Активувати» (так, це справжня магія!) і заповніть форму, детально описуючи, для чого ж вам цей токен. Напишіть так, щоб ваша заявка виглядала як захопливі плани на поїздку в Париж, а не нудний похід у магазин. Після цього надішліть заявку і чекайте з нетерпінням! Пам’ятайте: хороші речі завжди приходять до тих, хто терпить!
Доступ до API: Ваш пропуск у світ можливостей Для того, щоб зануритися у світ API, вам знадобиться ваш особистий API токен — без нього, як без ключа від власного авто: ніяк не заїдеш у гараж! Щоб отримати список актуальної тривоги, просто виконайте GET запит на https://i-horizon.site/api/v1/alarm/active/, а в заголовку (Header) в рядку Token передайте ваш токен (пам’ятайте: без "TOKEN" ніякої магії не відбудеться).
Усі методи API можуть повертати помилки, які вразять ваші надії: 200 - Запит виконано успішно (так, час святкувати! ) 401 - Невірний токен або він не активний (на жаль, не всі герої носять плащі). 429 - Перевищений ліміт запитів (так, ви розчаровані, але зате у вас новий рекорд). 400 - Інші можливі помилки (такі собі «фейли» на фоні грандіозного шоу).
Не забувайте: на всі API запити діють обмеження — максимум 1 запит кожні 15-20 секунд. Так, ми не влаштовуємо перегони, але для вас це може бути на краще. Якщо ж ви все ж систематично будете порушувати ліміти, ваш токен буде заблоковано, і доведеться шукати нового друга для спілкування. Тож готуйтесь, отримуйте свій токен, і вперед — до нових звершень!
Зразок відповіді: Ваше бажання дізнатися про тривогу тепер стало легшим, ніж спроба вгадати, що готують на обід. Отже, що ви знайдете у нашій відповіді: id: Унікальний ідентифікатор запису (так, це не просто цифри, а ваше таємне слово для входу у світ тривог). location_title: Назва локації, де все відбувається (так, ми знаємо, що ви могли б її вгадати, але навіщо ризикувати?). location_type: Тип локації — чи то область, район, місто, громада, чи, може, «невідомо» (так, такі загадки теж бувають!). started_at: Час початку тривоги (бо хто не любить точність, як у швейцарських годинниках?). alert_type: Тип тривоги — обирайте з повного спектра: повітряна тривога, артилерійські обстріли, міські бої, хімічна або ядерна загроза (так, у нас тут цілий зоопарк тривог, обирайте свою!). Тепер ви зможете отримати всю цю важливу інформацію без жодних зусиль, адже знання — це сила, а в нашому випадку ще й тривога!
Отримання Новин
Щоб дізнатися, які категорії новин доступні, ви можете використовувати ендпоінт https://i-horizon.site/api/v1/news/region/. Цей запит відкриє перед вами двері у світ новин, де ви зможете знайти інформацію про різноманітні теми, від регіональних новин до автомобільних технологій. Успішний запит поверне список категорій, кожна з яких буде містити id, name, та description. Не соромтеся досліджувати новини Волині чи автомобільні інновації — можливості безмежні! У випадку помилок, API не залишить вас на самоті: 200 - Запит виконано успішно (підготуйтеся до читання!) 404 - Неправильний запит (на жаль, ви потрапили в глухий кут).
Отримання новин за категорією Після того, як ви ознайомилися з категоріями новин, ви можете отримати список новин за конкретною категорією, використовуючи ендпоінт https://i-horizon.site/api/v1/news/region/id/. Замість id ви повинні вставити ідентифікатор категорії, який вас цікавить. За замовчуванням ви отримаєте 10 новин, але якщо ви хочете більше (але не більше 50), просто передайте параметр count. Наприклад: https://i-horizon.site/api/v1/news/region/1/?count=20 поверне 20 новин з категорії з id 1. Успішний запит поверне не тільки новини, а й дату створення, заголовок, та картинку для кожної новини. А якщо вам цікаво, звідки взялися ці новини, не біда — ми вам про це розкажемо!
Отримання джерел новини Коли ви натрапите на захоплюючу новину, не забудьте дізнатися, з яких джерел вона була опублікована. Для цього використовуйте ендпоінт https://i-horizon.site/api/v1/news/source/news_id/, де news_id — це ідентифікатор новини, який ви отримали раніше. Цей запит поверне вам перелік всіх джерел, де новина була опублікована, з назвами сайтів та прямими посиланнями.
GET https://i-horizon.site/api/v1/news/region/ - відповідь: {"site": "https://i-horizon.site", "result": [{"id": 13, "name": "Волинь", "description": "Новини Луцька та області"}, ...]}. GET https://i-horizon.site/api/v1/news/region/{id}/ - відповідь: {"site": "https://i-horizon.site", "region/topic": "Головні новини", "result": [{"id": 52181, "title": "«Укрпошта» веде перемовини...", "new": "АТ \"Укрпошта\" веде переговори...", "created_date": "2024-10-09T15:09:34.099Z", "picture": "https://i-horizon.site/media/news/picture/..."}, ...]}. GET https://i-horizon.site/api/v1/news/source/{news_id}/ - відповідь: {"site": "https://i-horizon.site", "result": [{"id": 1, "name": "BBC News", "url": "https://www.bbc.com"}, ...]}.
Webhook
Якщо хочеш, щоб дані самі тебе знаходили, а не ти їх — вебхук тобі в поміч! Це такий крутий хлопець, який, щойно щось відбувається, одразу стукає до тебе в дім (точніше, на твій URL) і приносить всі новини, тривоги й контент на тарілочці. Все це добро можна налаштувати в твоєму персональному кабінеті в розділі "WEBHOOK".
СТАН ПОВІТРЯНОЇ ТРИВОГИ Якщо хочеш знати, коли почалась або закінчилась повітряна тривога, то обери потрібний регіон (чи кілька) і вкажи свій URL-адресу у форматі "https://". Як тільки щось станеться — БАМ! Сповіщення прилетить.
СПОВІЩЕННЯ НОВИН Хочеш новини на автоматі? Легко! Обирай регіон чи категорію (а можна і все відразу) і вказуй свій URL. Далі тільки сиди й приймай найсвіжіші апдейти без зайвих зусиль.
ПЕРСОНАЛЬНА СТРІЧКА TELEGRAM Якщо вже налаштував собі персональну стрічку новин, як справжній профі (дивись трохи нижче, як це зробити), то тепер можеш отримувати всі новини з обраних Telegram-каналів прямо на свій URL. Знову ж таки, обирай стрічку, введи URL і натискай "створити вебхук".
І вітаю! Тепер ти як "людина-радар" — завжди в курсі всього важливого і не пропустиш нічого, бо все прилетить автоматично!
Активна повітряна тривога — як сигнал до бігу: { "activated_alert": { "location_title": "Назва локації", "alert_type": "Тип тривоги", } } Відміна тривоги — фух, усе спокійно: { "deactivated_alert": { "location_title": "Назва локації", } } Новина — свіжа порція інфи прямо в чат: { "topic": "Регіон або категорія", "title": "Заголовок новини", "new": "Текст самої новини", "created_date": "Дата створення", "source": "Джерело новини", "picture_url": "Посилання на зображення", "video_url": "Посилання на відео", } Персональна стрічка новин Telegram — контент для обраних: { "content": "Назва стрічки", "new": "Текст новини з Telegram", "created_date": "Дата створення", "picture_url": "Посилання на зображення", "video_url": "Посилання на відео", "data_origin_telegram": "Оригінальний масив даних з Telegram", }