Операции аутентификации#

Операции для получения доступа к API.

Операции#

Получение токена#

Аутентификация клиента и получение токена доступа для использования в последующих запросах.

  • Эндпоинт: POST /auth/token
  • Требуется аутентификация: Нет (сам запрос выполняет аутентификацию)

Общие принципы#

Формат запросов#

Операция принимает JSON с учетными данными клиента:

  • clientId — идентификатор клиента
  • clientSecret — секретный ключ клиента

Формат ответов#

Успешный ответ содержит:

  • token — токен доступа
  • expiresAt — время истечения токена (ISO 8601)

Использование токена#

Полученный токен необходимо передавать в заголовке Authorization для всех запросов к API:

1Authorization: Bearer {token}

Обработка ошибок#

При возникновении ошибки ответ содержит объект error:

1{
2  "error": {
3    "code": "AUTHENTICATION_FAILED",
4    "message": "Authentication failed",
5    "errorId": "018c5f2e-9b3a-7f4d-8e2c-1a2b3c4d5e6f"
6  }
7}

Жизненный цикл токена#

  1. Получите токен через /auth/token
  2. Используйте токен для всех запросов к API
  3. Следите за временем истечения (expiresAt)
  4. Обновите токен до истечения срока действия
Backward Операции Получение токена Forward