Документация› API и интеграции› API-ключи: создание и управление

API-ключи: создание и управление

API-ключ идентифицирует ваш аккаунт и определяет, что именно разрешено делать программе. Ключи выдаются только в личном кабинете после регистрации — публичной выдачи ключей через API нет.

Типы ключей

ТипНазначениеОграничение
CLIСерверные агенты мониторинга, скриптыпо IP-адресу (allowed_ip)
WidgetВиджет на сайтепо доменам (allowed_domains)

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

  1. Зарегистрируйтесь или войдите в личный кабинет: /profile/.
  2. Для CLI/агента: раздел «API» (/profile/api/) → «+ Создать проект». При желании укажите IP-адрес агента (для динамического IP оставьте пустым — тогда ограничения по IP не будет).
  3. Для виджета: раздел «Виджет» (/profile/widget/) → «Новый проект» и укажите домен сайта.
  4. Нажмите «Создать» и скопируйте ключ (64 hex-символа).
Публичный запрос ключа по e-mail недоступен. Эндпоинт /api.php?action=generate-key закрыт снаружи — ключ нельзя получить без регистрации в личном кабинете. Это защищает от массовой выдачи ключей и скачивания каталога серверов.

Управление ключами

Ключи можно переименовывать, менять привязки (IP/домены) и удалять. При удалении ключа соответствующая интеграция перестаёт работать — это основной способ отозвать доступ.

Безопасность

  • храните ключ в секрете, не публикуйте в открытом коде и логах;
  • для CLI указывайте allowed_ip, для виджета — allowed_domains;
  • при подозрении на утечку удалите ключ и создайте новый.

Ограничения

  • число ключей зависит от тарифа аккаунта; текущее значение видно в разделе «Тариф»;
  • при превышении лимита создание нового ключа отклоняется.
Техническая деталь

Ключ — случайная строка из 64 шестнадцатеричных символов, генерируемая на сервере. Ключи, созданные в кабинете, привязаны к аккаунту: их запросы учитываются в общей квоте, а лимит количества ключей берётся из эффективных лимитов аккаунта. Ключи виджета (purpose=widget) не получают ответ 429, чтобы ограничения не ломали работу сайтов клиентов.