Метод: Получение токена для авторизации пользователя
Метод служит для получения токена авторизации пользователя на платформе promotivation.
URL
POST {домен}/api/v2/user/auth.
Описание
Авторизация пользователя на платформе производится в два шага:
- получение токена для авторизации (действителен 2 минуты);
- авторизация пользователя на платформе.
Структура запроса
Пример запроса
Формат запроса:
POST {домен}/api/v2/user/auth
"Authorization: Bearer 1jijdsaohdiadibbcsanco……"
"Content-Type: application/json"
{
"idExternal": "dkfsa124ksad"
}
Параметры запроса
| Параметр |
Тип |
Описание |
Обязательный |
Шифрование |
Authorization |
string |
Уникальный токен аутентификации |
Да |
Нет |
idExternal |
string |
Внешний идентификатор пользователя |
Да |
Да |
Структура ответа
Пример успешного ответа
{
"status": "OK",
"userToken": "skjbsvb8fb3fiw"
}
Параметры успешного ответа
| Параметр |
Тип |
Описание |
status |
string |
Статус |
userToken |
string |
Токен авторизации пользователя |
| --- |
|
|
Пример ответа с ошибкой
{
"status": "USER_NOT_FOUND",
"message: "User not found in the system"
Параметры ответа с ошибками
| Параметр |
Тип |
Описание |
status |
string |
Статус ошибки |
message |
string |
Информационное сообщение |
Возможные ошибки
| Статус |
Описание |
USER_NOT_FOUND |
Пользователь не найден |
TOKEN_ERROR |
Токен не найден |