AuthorizationApi. Авторизация

API для входа в приложение.

Авторизация

Войдите в свое приложение. См. VMSCaptcha, чтобы узнать, нужна ли вам информация о капче для этого запроса.

Если вы получаете ошибку 429, это означает, что вам нужно удалить сеанс. Для этого повторите этот запрос с параметром sessionId, который вы можете получить из ошибки.

См. подробности ApiError для получения этой информации.

Если запрос прошел успешно, вы получите объект VMSLoginResponse.

CODE

@POST(TOKEN)
suspend fun login(@Body loginRequest: VMSLoginRequest): VMSLoginResponse

VMSLoginRequest

Объект с необходимой информацией для запроса входа в систему.

login — логин пользователя

password — пароль пользователя

session_id — сессия, которую вы хотите заменить на новую

captcha — капча, введенная пользователем с изображения

key — ключ капчи, полученный с сервера

Получение капчи

Если вам нужна капча для входа в систему, сначала сделайте этот запрос, чтобы получить ее.

Если запрос прошел успешно, вы получите объект VMSCaptcha.

Имеется 20 попыток отправить запрос getCaptcha() с одного IP-адреса в течение 10 минут.

CODE

@GET(CAPTCHA)
suspend fun getCaptcha(): VMSCaptcha

VMSCaptcha

Объект, который вы получаете с сервера с необходимой информацией для входа в систему.

key — ключ капчи, необходимый для входа в систему с капчей

img — представление base64 на изображении с капчей, вы можете конвертировать полученные данные img в изображение

ttl — допустимое время жизни запрошенной капчи