...
|
Получение АccessToken по коду подтверждения
Основные параметры Http-запроса:
Http-метод | POST |
Url | /api/v2.0/account/authWithSMS |
Headers | Accept: application/json Content-Type: application/json; charset=utf-8 Content-Length: X-WO-API-APP-ID: your_app_id |
Request (запрос):
Параметры запроса | Тип данных | Обязательный параметр | Описание |
phone | String | Да | Номер мобильного телефона, на который будет отправлен код подтверждения. |
confirm_code | String | Да | Код подтверждения, полученный в SMS. |
| app_registration_token | String | Нет | Токен для отправки пуша. |
Пример тела запроса в формате json:
{
"phone":"380501234567",
"confirm_code":"492164",
"app_registration_token": "App_Token"
}
Response (ответ):
Статус ответа | Id ошибки | Описание |
200 (OK) | Пользователь авторизирован. accessToken отправлен. | |
| 201 (Created) | Пользователь создан и авторизирован. accessToken отправлен. | |
| 400 (BadRequest) | -34 | Неверный номер телефона. |
400 (BadRequest) | -35 | Неверный код подтверждения. |
| 409 (Conflict) | -67 | В базе существует больше двух пользователей с одним номером телефона. |
| 409 (Conflict) | -68 | Пользователь с таким логином уже существует. (При попытке создания) |
| 409 (Conflict) | -69 | Телефон пользователя совпадает логином другого пользователя. (При попытке создания) |
| 403 (Forbidden) | -31 | Регистрация запрещена настройками «Такси Навигатор». (При попытке создания) |
| 429 (Conflict) | -7 | Слишком много неверных попыток ввода кода подтверждения. |
Пример тела ответа в формате json в случае успешной отправки AccessToken:
|
Получение хеш-подписи номера телефона
Основные параметры Http-запроса:
Http-метод | GET |
Url | /api/v2.0/account/phoneHash |
Headers | Accept: application/json Content-Type: application/json; charset=utf-8 Content-Length: Authorization: Bearer {JWT} X-WO-API-APP-ID: your_app_id |
Response (ответ):
Статус ответа | Описание |
200 (OK) | Успешное получение хеш-подписи. |
401 (Unauthorized) | Клиент не авторизован. |
| 400 (BadRequest) | Не заполнен идентификатор приложения (X-WO-API-APP-ID). |
| 400 (BadRequest) | Номер телефона клиента из профиля не подходит для отправки СМС-уведомлений. |
| 400 (BadRequest) | Хеш-подпись не сформирована (не нейдено клиентское приложение или для приложения не указана ключ-подпись для авторизации) |
Response (ответ):
Параметры ответа | Возможные значения | Описание |
phone_hash | e81db0ff651148d8a4ce2b908e7915cc | Хеш-подпись номера телефона |
Пример тела ответа в формате json:
{
"phone_hash": "eab8981c133080f6dd9e6b004afedeb7"
}
Получение AccessToken по хеш-подписи номера телефона
Основные параметры Http-запроса:
Http-метод | POST |
Url | /api/v2.0/account/authWithPhoneHash |
Headers | Accept: application/json Content-Type: application/json; charset=utf-8 Content-Length: X-WO-API-APP-ID: your_app_id |
Request (запрос):
Параметры запроса | Тип данных | Обязательный параметр | Описание |
phone | String | Да | Номер мобильного телефона клиента |
phone_hash | String | Да | Хеш-подпись номера телефона клиента |
| app_registration_token | String | Нет | Токен для отправки пуша |
| user_first_name | String | Нет | Имя клиента |
Пример тела запроса в формате json:
{
"phone": "380501234567",
"phone_hash": "eab8981c133080f6dd9e6b004afedeb7",
"app_registration_token": "app_token",
"user_first_name": "name"
}
Response (ответ):
Статус ответа | Id ошибки | Описание |
200 (OK) | Пользователь авторизирован. AccessToken отправлен. | |
| 201 (Created) | Пользователь создан и авторизирован. AccessToken отправлен. | |
| 400 (BadRequest) | Не заполнен идентификатор приложения (X-WO-API-APP-ID). | |
| 400 (BadRequest) | -34 | Номер телефона не заполнен или не подходит для отправки СМС. |
400 (BadRequest) | -78 | Невалидная хеш-подпись номера телефона. |
| 409 (Conflict) | -67 | В базе существует больше двух пользователей с одним номером телефона. |
| 409 (Conflict) | -68 | Пользователь с таким логином уже существует. (При попытке создания) |
| 409 (Conflict) | -69 | Телефон пользователя совпадает логином другого пользователя. (При попытке создания) |
| 403 (Forbidden) | -31 | Регистрация запрещена настройками «Такси Навигатор». (При попытке создания) |
Пример тела ответа в формате json в случае успешной отправки AccessToken:
|
Запрос на API c отправкой AccessToken
После получения AccessToken пользователь получает возможность отправлять запросы на защищенные ресурсы с помощю Bearer авторизации (вместо Basic).
Для этого в заголовок запроса нужно добавить:
|
Клиенты
Клиенты
Смена телефона клиента
Смена телефона
...