Appearance
Интерфейс мерчанта
Авторизация
Ниже список и описание методов которые обязаны реализовать мерчанты для взаимодействия с брокером
Описание сервиса
| Поле | Детали | Пример | Решение |
|---|---|---|---|
| Метод | POST | ||
| Описание | Авторизация брокера Airba на стороне мерчанта | ||
| URL | /authenticate | https://myshop.shop/authenticate | |
| Авторизация | Bearer Token | Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9 .eyJzeXN0ZW0iOiJtZXJjaGFudCIsImV4cCI6 MTU5NjU4NTk5Mywic3ViIjoiYnJva2VyLWdvb2RzIn0 .Jq2xffP0Z0acliHYK8ImPEtevxncKhzV0u_awPRZH7s | После авторизации полученный токен в таком виде будет передаваться в заголовке запросов |
| Формат ответа | JSON | ||
| Статус ответа | 200 В случае успешного сценария | { "token": "string" } | |
| 400 В случае ошибки в запросе | { "code": "400", "message": "Неверные входные данные", "status": "Bad Request" } | запрос имеет неправильные входные данные, проверить правильно ли заполнен запрос | |
| 401 Ошибка авторизации | { "code": "401", "message": "token: token does not have permission to perform this action", "status": "Access Denied/Forbidden" } | токен либо отсутствует в заголовке либо токен не валиден (истек срок жизни токена) | |
| 500 Неизвестная ошибка | { "code": "500", "message": "Внутренняя ошибка сервера", "status": "Internal Server Error" } | возникла внутренная ошибка вашего сервиса |
Описание полей ответа
| Параметр | Тип | Описание |
|---|---|---|
| token | string | Bearer token |
| status | string | Статус ошибки |
| code | int | Код ошибки |
| message | string | Сообщение ошибки |
json
{
"password": "string",
"username": "string"
}Описание полей запроса
| Параметр | Тип | Описание | Пример |
|---|---|---|---|
| password | string | Пароль | VzaCl6ZmFsc2Us |
| username | string | Логин | airba-broker |