Моніторинг API

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

Як і з іншими моніторами, якщо монітор API виявляє проблему, ви можете разом із командою вирішити інцидент і за бажанням оновити свою сторінку статусу.

Ключові можливості

• Перевірка ендпоїнтів із різних локацій по світу кожні 30 секунд.
• Перевірка кодів статусу HTTP, тіла JSON, заголовків і часу відгуку.
• Власні заголовки, параметри запиту або корисне навантаження JSON.
• Миттєві сповіщення, якщо ендпоїнт недоступний, повільний або повертає неочікуваний результат.
• Інтеграція зі Slack, email, SMS, телефонними дзвінками, вебхуками та іншим.

Додавання першого монітора API

Щоб створити монітор, перейдіть до свого проєкту → Монітори → Додати монітор.

Тип монітора

Виберіть API як тип монітора.

Введіть URL ендпоїнта, за яким потрібно стежити, — наприклад,
https://api.yourservice.com/v1/users.

Налаштування запиту

Запит до API можна повністю налаштувати під себе:

• Метод HTTP: GET, POST, PUT, PATCH, DELETE, OPTIONS або HEAD
• Тіло: надсилайте разом із запитом JSON, дані форми, GraphQL або звичайний текст
• Автентифікація: базова автентифікація, ключ API або авторизація за Bearer-токеном
• Параметри запиту: додавайте пари ключ/значення до URL запиту
• Заголовки: додавайте власні заголовки, потрібні для вашого запиту до API

Монітор успішний, якщо

Монітор API вважається успішним, коли виконано всі задані умови.
Ви можете задати одну або кілька таких перевірок:

• Код статусу: наприклад, відповідь 200 OK
• Час відгуку: наприклад, менше ніж 1 second
• Тіло містить: наприклад, "success": true
• Шлях JSON: наприклад, data.status дорівнює "active"
• Заголовок містить: наприклад, Content-Type: application/json

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

Розширені налаштування

• Зрозуміла назва: дайте монітору описову назву, щоб його було легше впізнати.
• Виконувати перевірки кожні: визначте, як часто перевіряти ендпоїнт.
• Виконувати з: виберіть локації для перевірок (США, Канада, Європа, Азія).
• Додати на сторінку статусу: публічно показуйте доступність API та статистику відгуку.
• Коли монітор падає: створіть інцидент, сповістіть підписників або опублікуйте оновлення на сторінці статусу.
• Коли монітор відновлюється: вирішуйте інциденти й автоматично оновлюйте сторінку статусу.