Введение
Платформа Pingera для автоматизации и интеграции с внешними системами предоставляет REST API. Этот документ познакомит вас с основами работы с API, общими правилами и возможностями.
API URL
Базовый URL для использования API:
https://api.pingera.ru/v1
Если вы хостите платформу самостоятельно, то поменяйте ссылку на ваш домен.
Аутентификация
Большинство запросов к API требуют аутентификации. Создайте API ключ в разделе Настройки → API ключи и передайте его в заголовке Authorization:
curl -H "Authorization: ВАШ_API_КЛЮЧ" https://api.pingera.ru/v1/checks
Не добавляйте префикс Bearer к API ключу — такой запрос будет отклонён с ошибкой 401.
Другие способы передачи ключа, роли и управление ключами через API описаны в разделе Аутентификация.
Лимиты
Для защиты от брутфорса или ошибок в скриптах, мы лимитируем количество запросов к API. Лимиты считаются для каждого IP-адреса.
- 1000 запросов в минуту для большинства API-эндпоинтов.
- 5 запросов в минуту для логина и сброса пароля, 2 запроса в минуту для регистрации.
- 5 запросов в минуту на каждый пульсар для
/v1/heartbeats/{id}/ping.
Если вы превысили лимит, то в ответ получите ошибку 429. Тело такого ответа — не JSON, поэтому ориентируйтесь на HTTP-код. Повторите запрос через некоторое время с экспоненциальной задержкой (см. Повтор запросов).
Формат ответов
Все ответы API в формате JSON. Даты передаются в формате ISO 8601 в UTC, списки — постранично (см. Пагинация и форматы данных).
Ответы с ошибками приходят с HTTP-кодом ошибки и следующей JSON-структурой:
{
"code": "error_code",
"message": "Human-readable error message"
}
Список кодов и рекомендации по обработке — в разделе Ошибки.
Все ответы от API приходят только на английском языке.
Вебхуки
Pingera может отправлять HTTP-уведомления об оповещениях и инцидентах на ваш сервер. Формат сообщений описан в разделе Вебхуки.
Изменения API
История изменений публикуется в разделе Изменения API.
OpenAPI
Для упрощения интеграции мы предоставляем OpenAPI v3 спецификацию для API платформы.