Мониторинг API

Мониторы API позволяют автоматически проверять, что ваши 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 считается успешным, когда выполнены все заданные условия.
Вы можете задать одну или несколько из следующих проверок:

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

Если хотя бы одно из условий не выполнено, монитор будет помечен как упавший, и оповещения отправятся согласно вашим настройкам оповещений.

Дополнительные настройки

• Понятное название: дайте монитору описательное название, чтобы его было проще узнавать.
• Выполнять проверки каждые: решите, как часто проверять эндпоинт.
• Проверять из: выберите локации проверок (США, Канада, Европа, Азия).
• Добавить на страницу статуса: публично показывайте доступность API и статистику отклика.
• Когда монитор падает: создать инцидент, уведомить подписчиков или опубликовать на странице статуса.
• Когда монитор восстанавливается: решить инцидент и автоматически обновить страницу статуса.