База знаний

Работа с API

API повторяет возможности интерфейса. Ключ создаётся в кабинете и передаётся в заголовке X-API-Key.

Создание ключа

Настройки → API и вебхуки → Создать ключ. Ключ показывается один раз: сохраните его в менеджере секретов. Каждый ключ подписан, поэтому отозвать его можно удалением записи.

Аутентификация

Поддерживаются два заголовка: X-API-Key и Authorization: Bearer. Без ключа доступны только вход, колбэки платежей, приём метрик агента и публичные статус-страницы.

Лимиты

120 запросов в минуту на ключ. При превышении — ответ 429 с заголовком Retry-After. Для массовых операций делайте паузы или используйте пакетные методы.

Примеры

Создание объекта, запуск проверки и выгрузка инцидентов — в разделе документации по API. Все ответы в JSON, ошибки содержат error и hint с человеческим пояснением.

Частые вопросы

Есть ли песочница?

Все ключи работают с реальными данными; для экспериментов создайте объект с интервалом в сутки.

Поддерживается ли GraphQL?

Нет, только REST.