[POST] Получение токена

Softline CheckoutИнтеграцияAuthentication API

Описание запроса

POST /v1/login_check

Запрос предназначен для получения токена, который далее используется для авторизации при работе с другими API.

Данные для отправки запроса

Endpoints URL:
- Боевая среда: https://api.ecommerce.softline.com/v1/login_check
- Тестовая среда: https://api.ecommerce.softline.com.demoslweb.com/v1/login_check
Метод: POST
Формат: JSON

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

content-type

string

required

MIME-тип данных в теле запроса.
Должен быть равен "application/json".

Параметры в теле запроса

username

string

required

Ваш логин для работы с API. Предоставляется при подключении.

password

string

required

Ваш пароль для работы с API. Предоставляется при подключении.

Пример запроса

{
  "username": "user",
  "password": "1234"
}

Ответ на запрос

В ответ на запрос вы получите код ответа сервера, соответствующий результату обработки.
В зависимости от кода в теле ответа могут присутствовать дополнительные параметры.

Положительный ответ

При успешной обработке запроса вы получите код ответа сервера HTTP/1.1 200 OK. В теле ответа будут передан token, который необходим для авторизации при работе с другими API.

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

date

string

required

Дата и время создания токена.

Параметры в теле ответа

token

string

required

Токен для авторизации. Используйте его в запросах к другим API.

Обратите внимание. Полученный токен действует 24 часа с момента получения. Если до истечения срока был получен новый токен, то ранее полученный токен продолжает действовать.

refresh_token

string

required

Технический параметр. Не используется.

Пример положительного ответа

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

Ответ об ошибке

В случае ошибки при обработке запроса вы получите код ответа сервера, соответствующий результату обработки.
В зависимости от кода в теле ответа могут присутствовать дополнительные параметры.

Справочник HTTP-кодов ответа сервера при ошибке

Код ответа сервера	Описание
HTTP/1.1 400 Bad Request	Запрос не валиден (ошибка в параметрах; не переданы необходимые данные и т.п.). В теле ответа будет передан дополнительный код ошибки (один или несколько).
HTTP/1.1 401 Unauthorized	Неуспешная аутентификация. В теле ответа будет передан дополнительный код ошибки (один или несколько).
HTTP/1.1 404 Not found	Неверный URL запроса. Проверьте адрес запроса.
HTTP/1.1 500 Request Error	Ошибка на стороне сервера. Повторите запрос позднее или обратитесь в службу поддержки.

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

Error	Message	Описание
Если хотя бы одна ошибка из списка ниже найдена, то она возвращается в ответе на запрос, остальные ошибки не проверяются.
110	JSON is not valid.	Структура полей запроса не валидна. Проверьте поля в теле запроса на соответствие формату JSON.
111	Invalid data format (Content-type).	Неправильный заголовок запроса. Content-type должен быть равен application/json.
1005	Invalid authorization data.	Запрос не валиден (ошибка в параметрах; не переданы необходимые данные и т.п.).

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

Error	Message	Описание
Если хотя бы одна ошибка из списка ниже найдена, то она возвращается в ответе на запрос, остальные ошибки не проверяются.
1006	Bad credentials.	Неуспешная аутентификация.

Параметры в теле ответа

errors

array [objects]

required

Список ошибок.

errors / [error object]

error

number

required

Код ошибки.

errors / [error object]

message

string

required

Описание ошибки.

Пример ответа об ошибке

{
  "errors": [
    {
      "error": 1005,
      "message": "Invalid authorization data."
    }
  ]
}