Введение
Платформа Pingera для автоматизации и интеграции с внешними системами предоставляет REST API. Этот документ познакомит вас с основами работы с API, общими правилами и возможностями.
API URL
Базовый URL для использования API:
https://api.pingera.com/v1
Если вы хостите платформу самостоятельно, то поменяйте ссылку на ваш домен.
Аутентификация
Большинство запросов к API требуют аутентификации. Создайте API ключ в настройках разделе API ключи в платформе. Вы можете узнать больше в разделе API ключи.
Используйте Header "Authorization" для аутентификации с ключом:
Authorization: ВАШ_API_КЛЮЧ
Лимиты
Для защиты от брутфорса или ошибок в скриптах, мы лимитируем количество запросов к API.
- 1000 запросов в минуту для большинства API-эндпоинтов
- 5 запросов в минуту для логинов, регистраций и сброса паролей.
Если вы превысили лимит, то в ответ получите ошибку 429.
Формат ответов
Все ответы API в формате JSON.
Ответы от API с ошибками приходят с кодом ошибки и следующей JSON структурой:
{
"code": "error_code",
"message": "Human-readable error message"
}
Все ответы от API приходят только на английском языке.
OpenAPI
Для упрощения интеграции мы предоставляем OpenAPI v3 спецификацию для API платформы.