Получение токена и регистрация пользователя
Все запросы в API Юрент делятся на общие и клиентские. Вот чем они отличаются:
| Общие запросы | Клиентские запросы | |
|---|---|---|
| Для чего применяются | - Отрисовка карты города - Получение самокатов - Работа клиентской поддержки |
- Получение информации о самокате - Старт/пауза/завершение аренды |
| Авторизация | Нужен только токен | Нужен токен и ID клиента |
Обратите внимание, что для всех запросов, независимо от их вида, нужен токен. Его необходимо использовать в заголовках (headers) всех запросов.
Получаем токен
Для получения токена необходимо отправит запрос: {шлюз}/api/v1/token
В теле запроса указываем:
"login": "string",
"password": "string",
Данные для полей “login” и “password” можно получить у вашего менеджера.
В ответ получаем bearer JWT-токен:
"access_token": "string",
"token_type": "string",
"expires_in": 0
Время жизни токена обычно — 1 час, но токен может действовать и довольно долгое время. Когда токен станет неактивен, у пользователя закроется доступ, тогда следует взять ещё раз токен используя тот же логин и пароль.
Регистрируем нового пользователя
Для регистрации нового пользователя необходимо отправить следующий запрос: {шлюз}/api/v1/signup
В теле запроса указываем:
"accountId": "string", //обязательное поле
"countryCode": "string", //обязательное поле
"phoneNumber": "string"
"accountId" — это произвольный ID пользователя, который генерируется на стороне агента (на вашей).
"countryCode" — страна регистрации, указываем полученный код из {шлюз}/api/v1/places (который будет описан ниже). Страна, указанная при регистрации не меняется.
"phoneNumber" — номер телефона пользователя в формате “79999999999”.
В ответ сервер сообщает об успешной регистрации
"result": "SmsCodeGranted",
"errors": [],
"succeeded": true
В дальнейшем для клиентских запросов в заголовках (headers) в поле “partnerCustomerId” используется именно "accountId" из тела запроса на регистрацию пользователя.
Авторизация пользователя
API Юрент реализует только идентификацию пользователя. Для работы всех клиентских запросов достаточно использовать “partnerCustomerId” зарегистрированного ранее пользователя.
Предполагается, что аутентификация пользователя будет реализована на стороне агента.