Авторизация в сервисе единого АПИ Золотого Яблока
Взаимодействие с сервисом, например, отправка изменения даты доставки или работа по синхронизации справочника ПВЗ, требует авторизации. Авторизация осуществляется по логину и паролю, которые выдаются техническими специалистами Золотого Яблока. На основе пары логин-пароль формируется access_token и возвращается в качестве полезной нагрузки. Аутентификация для работы с сервисом, в дальнейшем, производится по нему. Срок жизни токена - 5 минут.
к сведению
Внимание! Более 10 попыток аутентификации с неправильной парой-логин пароль - приведут к блокировке логина и IP-адреса. Метод "белого списка" - не применяется, доступ открыт через сеть.
Основная информация
| Тип метода запроса | POST |
|---|---|
| Путь/URL | /api/v1/auth/login |
| Описание | Метод для аутентификации Внешней Курьерской службы в сервисе Единого АПИ |
| Направление | Запрос выполняется курьерской службой. Ответ предоставляется ИС Золотого Яблока. |
Запрос
Обязательные заголовки
| Параметр | Тип данных | Обязательность | Описание | Комментарий |
|---|---|---|---|---|
| Host | string | 1 | Хост курьерской службы | Заполняется "subdomain.domain zone". |
| Content-Type | string | 1 | Тип содержимого запроса | Заполняется "application/json" |
Полезная нагрузка
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| username | string | 1 | Имя пользователя (логин), выданный Золотым Яблоком |
| password | string | 1 | Пароль для аутентификации, выданный Золотым Яблоком |
Пример запроса
{
"username": "ECS_LOGIN",
"password": "*************"
}
Ответ
Коды ответов и сообщений
| Код | Статус | Сообщение | Причина |
|---|---|---|---|
| 200 | OK | Success response | Всё прошло успешно |
| 400 | Bad Request | Missing or inappropriate required parameters | Не переданы обязательные поля |
| 500 | Internal Server Error | Server unavailable | Сервер недоступен |
Параметры успешного ответа
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| access_token | string | 1 | Access-token, выдаваемый на время по паре логин и пароль. |
| expires_in | string | 1 | Время жизни токена, указанное в секундах. |
Пример успешного ответа
{
"access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.
eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.
SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
"expires_in": "2592000"
}
Параметры неуспешного ответа
| Параметр | Тип данных | Обязательность | Описание |
|---|---|---|---|
| error | string | 1 | Человекочитаемое сообщение об ошибке |
Неуспешный ответ
{
"error": "Missing or inappropriate required parameters"
}