К содержанию
SerpJet Документация Войти
Разделы
  1. Документация
  2. Публичный API доставки

X-Api-Key, Project ID, права и безопасная ротация ключа аккаунта

Внешний API работает по ключу аккаунта в заголовке X-Api-Key и Project ID в параметрах. Ключ один на все проекты аккаунта: его замена отключает прежний ключ сразу во всех интеграциях.

Проверено
Содержание
  1. Ключ аккаунта
  2. Как передавать
  3. Замена ключа
  4. Безопасность

Ключ аккаунта

  • Ключ создаётся в любом проекте: «Подключения» → карточка «Внешний API» → «Создать ключ».
  • Ключ принадлежит аккаунту, а не проекту: одним ключом можно работать со всеми проектами аккаунта. В карточке видны последние символы ключа.
  • Полный ключ показывается один раз: «Сохраните ключ сейчас. После ухода со страницы полный ключ больше не показывается».

Как передавать

X-Api-Key: <ваш ключ>

Каждый запрос к /external/ должен содержать этот заголовок. Проект указывается параметром project_id. Project ID — число в адресе проекта в панели: /panel/projects/7/…. Если проект не принадлежит владельцу ключа, API ответит 404 project_not_found.

Замена ключа

  1. Нажмите «Заменить ключ» в карточке «Внешний API».
  2. Новый ключ начинает действовать сразу, прежний перестаёт работать сразу во всех проектах и интеграциях аккаунта, включая плагин SerpJet Publisher.
  3. Обновите ключ во всех местах, где он используется.

Если ключ меняли в другой вкладке, панель попросит обновить страницу: «Ключ аккаунта уже изменён в другой вкладке или проекте».

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

  • Храните ключ на сервере CMS, а не в коде страниц и не в браузере.
  • Не передавайте ключ в переписке, в том числе в поддержку.
  • Если ключ мог утечь — сразу замените его.

Лимит — до 60 запросов в секунду на один ключ; при превышении — 429 rate_limit_exceeded — Ошибки 401 / 404 / 409 / 429, superseded и пустая очередь.

Не нашли ответ? Напишите в поддержку из панели — укажите проект и что вы видите на экране.