Перейти к содержимому

API ключи

В UI: Настройки команды → API & Integrations → Создать ключ.

При создании указываются:

  • Имя - произвольная метка для удобства.
  • Scopes - какие операции разрешены ключу (см. Scopes).
  • Срок жизни - обязателен, max 365 дней.

Сгенерированный токен показывается один раз - сохраните его сразу. Восстановить его нельзя; можно только сделать новый через Rotate Secret.

fw_live_<24 base62 chars>

Например: fw_live_AbCdEfGhIjKlMnOpQrStUvWx.

Первые 12 символов (fw_live_AbCd) - это публично видимый prefix, который сохраняется в lastUsedIp, audit и UI. Полный секрет (24 случайных байта) хранится в БД только в виде SHA-256 хеша с per-key salt.

В каждом HTTP-запросе передавайте токен в заголовке Authorization:

GET /api/public/v1/me
Authorization: Bearer fw_live_AbCdEfGhIjKlMnOpQrStUvWx

Все ключи имеют срок жизни. По истечении - ключ начинает возвращать 401 с кодом token_expired. Создайте новый и обновите интеграцию.

В UI статус ключа показывается как Active, Expiring soon (< 7 дней) или Expired.

Rotate Secret генерирует новый секрет, оставляя scopes и expiration прежними. Старый секрет немедленно перестаёт работать - обновите все клиенты, использующие этот ключ, до ротации либо сразу после.

Revoke мгновенно делает ключ невалидным. Запросы возвращают 401 с кодом token_revoked. Это нельзя отменить - используйте если ключ скомпрометирован.

Delete убирает ключ из UI. В БД запись остаётся (soft-delete) - для аудита last_used/last_ip.

Каждый запрос API-ключом логируется в таблицу usage events. История последних обращений доступна в UI и через management API: GET /api/v1/accounts/{accountId}/api-keys/{id}/usage.