Аутентификация
Для разработчиков

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

Каждый запрос к API подписывается API-ключом. Ключ привязан к проекту (workspace): все операции выполняются в его контексте, передавать workspace_id в URL не нужно. Разграничения прав у ключей нет — ключ даёт доступ ко всем эндпоинтам API этого проекта.

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

  1. Откройте Настройки → API ключи. Управлять ключами могут владелец и администраторы проекта.
  2. Нажмите «Создать ключ» и укажите название (например, «CRM bridge»).
  3. Скопируйте ключ — полностью он показывается только один раз, дальше в списке виден лишь его префикс. Формат: sk_…

2. Передача ключа

Ключ передаётся в заголовке Authorization со схемой Bearer:

Authorization: Bearer sk_xxxxxxxxxxxxxxxxxxxxxxxx

3. Проверка

curl
curl https://api.support.forestsnet.com/api/v1/tickets \
  -H "Authorization: Bearer sk_xxxxxxxxxxxx"

Ответы при ошибке ключа

  • Ключ неверный, отключён или удалён, не начинается с sk_, либо проект заблокирован — 401 с телом {"detail": "Invalid or revoked API key."}.
  • Заголовка Authorization нет совсем — тоже 401, с телом {"detail": "Missing API key: send Authorization: Bearer sk_..."}.
  • Оба ответа приходят с заголовком WWW-Authenticate: Bearer.

Отключение и удаление

В том же разделе ключ можно временно отключить или удалить. Отключённый или удалённый ключ перестаёт работать сразу.

Безопасность. Не кладите API-ключ во frontend-код, мобильные приложения и публичные репозитории: он открывает все данные проекта. Удаляйте ключи, которыми больше не пользуетесь. Лимиты запросов — на странице Лимиты и ошибки.
Была ли страница полезной?