Project

General

Profile

Сервис аутентификации

Краткое описание

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

Используется при работе со следующими сервисами:

Доступ к сервису аутентификации предоставляется при подключении к вышеперечисленным сервисам.

Запрос для получения токена

URL https://api.ecommerce.softline.com/v1/login_check
Тип запроса POST
Формат передачи данных JSON
Параметры запроса username (string)
password (string)
 
Параметры для запроса являются обязательными и предоставляются Партнеру при подключении.
Пример запроса
{
    "username": "user",
    "password": "1234" 
}

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

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

В случае успешной обработки в ответ возвращается код ответа и параметры в формате json:

Код ответа HTTP/1.1 200 OK
Формат передачи данных JSON
Параметры ответа token - токен для авторизации,
refresh_token - технический параметр (не используется для авторизации).
Пример ответа
{
 "token":"fj45u923j59ju42395iu9423i59243u0",
 "refresh_token": "4e283bb7620068c42d6" 
}

Полученный токен действует 24 часа с момента получения. Дата и время создания токена (UTC+3) возвращаются в заголовке ответа (поле Date).
Если до истечения срока был получен новый токен, то ранее полученный токен продолжает действовать.

Ошибки

В случае ошибки в ответ возвращается код ответа и, в некоторых случаях, описание ошибки в теле ответа в формате JSON

Справочник ошибок:

Код ответа Описание Параметры ответа
HTTP/1.1 400 Bad Request Запрос не валиден, отсутствуют необходимые данные и т.п. error - 1005
message - Invalid authorization data.
HTTP/1.1 401 Unauthorized Неуспешная аутентификация. error - 1006
message - Bad credentials.
HTTP/1.1 404 Not found Неверный URL запроса или формат запроса.
HTTP/1.1 500 Request Error Ошибка на стороне сервера.

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

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

Использование токена при работе с другими сервисами

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

Сервисы, которые поддерживают авторизацию по токену:

Передача токена в запросе

Токен передается в заголовке запроса:

Поле AuthorizationJWT
Значение
Bearer {{Token}}

где вместо {{Token}} подставляется значение, полученное через сервис аутентификации
Пример передачи токена:
с помощью Postman

Ошибки

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

Ошибка Сообщение об ошибке Описание
1007 Your token is invalid. Передан не верный токен.
1008 Missing token. Токен не передан.
1009 Your token is expired. У токена истек срок действия.

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

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

Примеры запроса в Postman

Скачать коллекцию запросов
  • Для работы с коллекцией необходим доступ к сервису.
    Доступ предоставляется при подключении к другому сервису, требующего прохождения авторизации.
  • Для отправки запросов из коллекции нужно настроить значения переменных:
Пример заполненных значений в Postman

Пример настроенных переменных в Postman

Просмотр значений переменных, которые будут подставлены в запрос при отправке