Метод: Получения токена для аутентификации
Метод служит для получения jwt-токена.
URL
POST {домен}/api/v2/login
Описание
Для аутентификации при работе с основными методами используются jwt токены.
Вспомогательные методы необходимы для получения и управления токенами.
Структура запроса
Пример запроса
Формат запроса:
POST {домен}/api/v2/login
{
"login": "dkfsa124ksad",
"password": "knb39bfi5AD{qpd"
}
Параметры запроса
| Параметр |
Тип |
Описание |
Обязательный |
Шифрование |
login |
string |
Уникальное имя партнера, кодированное в base64 |
Да |
Нет |
password |
string |
Уникальный API пароль партнера |
Да |
Да |
Структура ответа
Пример успешного ответа
{
"access_token": "1jijdsaohdiadibbcsanco……..",
"token_type": "bearer",
"expires_in": 3600
}
Параметры успешного ответа
| Параметр |
Тип |
Описание |
access_token |
string |
Токен |
token_type |
string |
Тип токена: bearer |
expires_in |
string |
Срок жизни: 3600 секунд |
Пример ответа с ошибкой
{
"status": "ERROR AUTH",
"message": "Partner name or password is not correct"
}
Параметры ответа с ошибками
| Параметр |
Тип |
Описание |
status |
string |
Статус ошибки |
message |
string |
Информационное сообщение |
Возможные ошибки
| Статус |
Описание |
FORBIDDEN |
Партнер с таким логином и паролем не найден |
NOT_VALID_IP_PARTNER |
IP партнера некорректен |
ERROR_AUTH |
Логин или пароль неверные |
TOKEN_ERROR |
Токен не найден |