AuthorizationExternalApi. Авторизация
API для входа в приложение через внешний API.
Получение внешнего URL
См. VMSBasicStatic
, чтобы узнать, можете ли вы войти в систему с помощью внешнего API, используя is_external_auth_enabled
.
Используйте этот метод, чтобы получить прямой URL.
Если запрос прошел успешно, вы получите URL для загрузки внешнего сервиса.
@GET(EXTERNAL_AUTH_URL)
suspend fun authUrlExternal(): VMSAuthUrlExternalResponse
Внешний вход
Войдите в свое приложение.
@POST(EXTERNAL_AUTH_CALLBACK)
suspend fun callbackUrlExternal(@Body request: VMSExternalAuthCodeRequest): VMSLoginResponse
Если запрос прошел успешно, вы получите объект VMSLoginResponse
.
Если вы получаете ошибку 419, это означает, что вам нужно удалить сеанс. Для этого повторите этот запрос с параметром sessionId
, который вы можете получить из ошибки. См. сведения об ApiError
для получения этой информации.
@POST(EXTERNAL_AUTH_CALLBACK)
suspend fun callbackUrlExternalSession(@Body request: VMSExternalAuthCodeSessionRequest): VMSLoginResponse
VMSExternalAuthCodeRequest
Объект с необходимой информацией для внешнего входа. Для входа в систему вам понадобится loginKey
или code
.
code
— код, необходимый для входа в систему
VMSExternalAuthCodeSessionRequest
key
— ключ входа, необходимый для входа в систему
sessionId
— идентификатор сеанса, который вы хотите заменить в случае получения ошибки 419. Дополнительную информацию см. в ApiError
.