ym88659208ym87991671
Ротация постоянного apiKey (обновление токена) | Документация для разработчиков

Ротация постоянного apiKey (обновление токена)

Обновлено 18 августа 2026

Описание: обновление постоянного apiKey и refreshToken до истечения их срока действия. Позволяет бесшовно продлить доступ к API.

Последовательность шагов

  1. Подготовить запрос — использовать действующий постоянный apiKey (в заголовке Authorization) и текущий refreshToken (в теле запроса).
  2. Отправить запрос на ротацию через POST /api/v1/api-keys/refresh с параметром refreshToken в теле запроса.
  3. Сохранить параметры нового ответа:
    • apiKey — новый постоянный apiKey партнера
    • apiKeyExpiresAt — новая дата истечения постоянного apiKey
    • refreshToken — новый токен для последующей ротации
    • refreshTokenExpiresAt — новая дата истечения refreshToken
  4. Использовать новый apiKey для всех рабочих запросов.

Важные особенности

  • После успешной ротации старый refreshToken помечается как использованный и больше недействителен.
  • Старый apiKey продолжает действовать 10 минут (grace period) для сглаживания переключения — это позволяет избежать ошибок во время переключения на новый ключ.
  • Рекомендуется инициировать ротацию за несколько дней до истечения текущего apiKey.

Альтернативные сценарии ошибок

Код ошибкиОписание
apiKey.invalid.errorПостоянный apiKey не найден или недействителен
header.invalid.errorЗаголовок Authorization не передан
Заметили ошибку?
Выделите текст и нажмите
Ctrl
+
Enter
, чтобы сообщить нам об ошибке