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

Получение и использование API-ключей для работы с Premiss Cloud API

Обзор

Все запросы к Premiss Cloud API требуют аутентификации через API-ключ. Ключ передаётся в заголовке Authorization каждого запроса.

Authorization: Bearer sk-xxxx...xxxx

Получение API-ключа

  1. Зарегистрируйтесь в Premiss Cloud
  2. Перейдите в Управление API-ключами
  3. Нажмите Создать ключ
  4. Скопируйте ключ — он показывается только один раз

Ключ начинается с sk- и показывается только при создании. Сохраните его в безопасном месте. Если ключ утерян, создайте новый.

Использование ключа

Передавайте ключ в заголовке Authorization с префиксом Bearer:

curl https://premiss.ru/api/v1/steps \
  -H "Authorization: Bearer sk-xxxxxxxxxxxxxxxxxxxx"

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

  • Не храните ключи в коде или git-репозиториях
  • Используйте переменные окружения: PREMISS_API_KEY
  • Каждый ключ привязан к вашему аккаунту и тарифу
  • Неактивные ключи можно отозвать в личном кабинете
  • Ключи имеют настраиваемый срок действия

Ошибки аутентификации

HTTPКодОписание
401MISSING_API_KEYОтсутствует заголовок Authorization
401INVALID_AUTH_FORMATНеверный формат (нет префикса Bearer)
401INVALID_API_KEYAPI-ключ невалиден
401API_KEY_EXPIREDСрок действия ключа истёк
429RATE_LIMIT_EXCEEDEDПревышен лимит запросов
Пример ошибки 401
{
  "success": false,
  "error": {
    "code": "MISSING_API_KEY",
    "message": "Authorization header is required"
  }
}

На этой странице