Метод: Авторизация пользователя
Метод служит для авторизации пользователя на платформе promotivation.
URL
GET {домен}/api/v2/user/login
Описание
При успешной авторизации настроен редирект на главную страницу {домен}. Токен авторизации при этом удаляется. При неуспешной- редирект на callbackFailed, если он не задан, то на страницу, с которой пришел запрос.
Структура запроса
Пример запроса
Формат запроса:
GET {домен}/api/v2/login ?userToken=skjbsvb8fb3fiw &callbackFailed=https://example.ru
Параметры запроса
| Параметр | Тип | Описание | Обязательный | Шифрование | Цвет |
|---|---|---|---|---|---|
userToken |
string | Уникальный токен аутентификации | Да | Нет | |
callbackFailed |
string | URl для редиректа, в случае неуспешного запроса | Нет | Нет |
Структура ответа
Пример успешного ответа
{
"status": "OK"
}
Параметры успешного ответа
| Параметр | Тип | Описание |
|---|---|---|
status |
string | Статус |
Пример ответа с ошибкой
{
"status": "USER_NOT_FOUND",
"message: "User not found in the system"
Параметры ответа с ошибками
| Параметр | Тип | Описание |
|---|---|---|
status |
string | Статус ошибки |
message |
string | Информационное сообщение |
Возможные ошибки
| Статус | Описание |
|---|---|
USER_TOKEN_ERROR |
Токен пользователя не найден |
USER_NOT_FOUND |
Пользователь не найден |
TOKEN_ERROR |
Токен не найден |