Применение токена при работе с API, использующими авторизацию по токену

Описание применение

Токен, который вы получили в ответ на запрос к Authentication API, вы можете использовать для авторизации при работе с Payments API, а также с Softline Checkout API (Products API, Dynamic Product Checkout API, Subscriptions API).

Чтобы пройти авторизацию при работе с этими API, передайте токен в заголовке запроса:

Параметры заголовка

AuthorizationJWT

required

Авторизационный токен.

Формат значения: Bearer [token]
Вместо [token] подставьте значение token, полученное в ответ на запрос к Authentication API.

Пример применения

Предположим, в ответ на запрос к Authentication API вы получили ответ:

{
  "token": "fj45u923j59ju42395iu9423i59243u0",
  "refresh_token": "4e283bb7620068c42d6"
}

При выполнении запроса к другому API передайте в заголовке запроса:

AuthorizationJWT: Bearer fj45u923j59ju42395iu9423i59243u0

При использовании Postman вы можете добавить переменную Token в настройки окружения (Environment) и подставлять токен автоматически в запросы к другим API.

Пример добавления переменной в окружение в Postman

Пример передачи токена в Postman

Ошибки авторизации

В случае, если авторизация с помощью токена была не выполнена, то в ответ возвращается код ответа HTTP/1.1 401 Unauthorized и описание ошибки в теле ответа в формате JSON.

Справочник кодов ошибок для HTTP 401

Error	Message	Описание
1007	Your token is invalid.	Авторизация не пройдена, значение токена неверное.
1008	Missing token.	Авторизация не пройдена, токен не передан.
1009	Your token is expired.	Авторизация не пройдена, у токена истек срок действия.

Пример ошибки

{
  "errors": [
    {
      "error": 1007,
      "message": "Your token is invalid."
    }
  ]
}