...
Тип запроса | HTTP-метод | Url |
Авторизация | POST | /api/account |
Смена пароля | PUT | /api/account/changepassword |
Восстановление пароля | POST | /account/restore/sendConfirmCode/ |
POST | /account/restore/checkConfirmCode/ | |
POST | /account/restore | |
Получение кода подтверждения для регистрации | POST | /api/account/register/sendConfirmCode/ /api/account/register/confirmcode - устаревшее |
Регистрация | POST | /api/account/register |
Верификация телефона | GET | /api/approvedPhones?phone=380501234567 |
POST | /approvedPhones/sendConfirmCode/ | |
POST | /approvedPhones/ | |
Запрос версии | GET | /api/version |
Расчет стоимости заказа | POST | /api/weborders/cost |
Создание заказа на поиск машины | POST | /api/weborders |
Получение списка тарифов | GET | /api/tariffs |
Информация заказа (поиск машины) | GET | /api/weborders/<uid> |
| Добавочная стоимость | GET | /api/weborders/<uid>/cost.additional |
Определить Geo положение машины на заказе | GET | /api/weborders/drivercarposition/<uid> |
Отмена заказа | PUT | /api/weborders/cancel/<uid> |
| Оценка поездки | POST | /api/weborders/rate/<uid> |
Профиль клиента | GET | /api/clients/profile |
Обновление профиля | PUT | /api/clients/profile |
| Обновление информации для отправки push | PUT | /api/clients/credential |
Смена телефона клиента | POST | /clients/changePhone/sendConfirmCode/ |
PUT | /clients/changePhone | |
Отчет по заказам клиента | GET | /api/clients/ordersreport?dateFrom=2013.08.13%2000:00:00&dateTo=2013.08.15%2000:00:00 |
Отчет по бонусам клиента | GET | /api/clients/bonusreport?limit=10&offset=0 |
История заказов клиента | GET | /api/clients/ordershistory?limit=10&offset=0 |
Geo данные (улицы) | GET | /api/geodata/streets?versionDateGratherThan=2013.07.11%2015:14:13.893 |
GET | /api/geodata/streets/search?q=search&fields=* | |
Geo данные (объекты) | GET | /api/geodata/objects?versionDateGratherThan=2013.07.11%2015:14:13.893 |
GET | /api/geodata/objects/search?q=search&fields=* | |
Geo данные (улицы и объекты) | GET | /api/geodata/search?q=search&fields=* /api/geodata/search?lat=50.449361&lng=30.518495&r=500&fields=* |
Запрос серверного времени | GET | /api/time |
Запрос настроек | GET | /api/settings |
POST | /api/clients/balance/transactions/ | |
GET | /api/clients/balance/transactions/<transaction_id> | |
| История изменения баланса | GET | /api/clients/balance/transactions/ |
Получение координат автомобилей в радиусе | GET | /api/drivers/position?lat=50.451063&lng=30.523891&radius=5 |
...
Параметры ответа | Тип данных | Возможные значения | Описание |
dispatching_order_uid | String | QW12as3467fd38 | UID заказа, присвоенный в БД ТН |
order_cost | Decimal | 94.09 | Стоимость заказа (отображается в формате, в зависимости от настроек ТН). |
| add_cost | Decimal | 4 | Добавочная стоимость |
currency | String | грн. | Аббревиатура валюты (из настроек ТН) |
order_car_info | String | АА64-72ЕН, белый (мал шашка), Lada 2010 | Информация о машине, если машина найдена, иначе – пусто. |
driver_phone | String | 050-123-45-67 | Телефон водителя, если машина найдена, иначе – пусто. |
required_time | "2015-08-24T19:15:00" | Дата и время подачи машины. | |
close_reason | Int32 | Статус закрытия заказа (см. Приложение 1) | |
cancel_reason_comment | String | У Вас недостаточно денег на балансе. | Комментарий к причине отмены заказа. (Для close_reason = 6) |
order_is_archive | True, False | Признак «архивного» заказа | |
drivercar_position | Object | Object или null | Текущее GPS положение машины, выполняющей заказ. Возвращается если есть актуальная информация о положении данной машины (status="gpsOk"). (См. ) |
route_address_from/name | String | ОЗЕРНАЯ УЛ. (ОБОЛОНЬ) | Адрес 1ой точки заказа (улица или объект). |
oute_address_from/number | String | 1 | |
route_address_to/name | String | ЯНГЕЛЯ АКАДЕМИКА УЛ. | Адрес последней точки заказа (улица или объект). |
oute_address_to/number | String | 7 | |
driver_execution_status | Int32 | Статус выполнения (см. Приложение 6) | |
| execution_status | String | SearchesForCar | Статус выполнения заказа (см. Приложение 2) |
| crew_average_rating | Float | 4.99 | Средняя оценка экипажа с округлением до сотых. |
| rating | Int16 | 4 | Оценка поездки |
| rating_comment | String | Ok | Комментарий к оценке поездки |
{
"dispatching_order_uid":"44ebd09e5f224651bf3c8e2dd12ed890"
...
,"status":"gpsOk"
}
,"crew_average_rating": 4.99
,"rating":4
,"rating_comment":"Ok"
,"route_address_from":{
"name":"ОЗЕРНАЯ УЛ. (ОБОЛОНЬ)"
...
Значение | Описание |
0 | Заказ не удалось отменить. |
1 | Заказ отменен. |
2 | Требует подтвержение клиентом отмены в диспетчерскую. |
Оценка поездки
http://<ipaddress>:<port>/api/weborders/rate/44ebd09e5f224651bf3c8e2dd12ed890
Основные параметры Http-запроса:
Http-метод | POST |
Url | /api/weborders/rate/<uid> |
Headers | Content-Type: application/json Authorization: Basic YWNod...YQ== Authorization: Bearer {JWT} |
Request (запрос):
Параметры запроса | Обязательный параметр | Возможные значения | Описание |
<uid> | Да | UID заказа в БД ТН (полученный в ответе на запрос создания заказа). | Идентификатор заказа |
| rating | Да | 1, 2, 3, 4, 5 | Оценка поездки |
| rating_comment | Нет | Комментарий к оценке. Максимальная длина 120 символов. |
Пример тела запроса в формате json:
{
"rating": 4
"rating_comment": "Ok"
}
Response (ответ):
Статус ответа | Id ошибки | Описание |
| 200 (OK) | Поездка успешно оценена. | |
| 404 (Not Found) | Заказ не найден. | |
| 403 (Forbidden) | Действие запрещено, клиент не соответствует заказу. | |
| 400 (Bad Request) | -10 | Неверные параметры запроса. |
| 400 (Bad Request) | -80 | Невалидное значение оценки. |
| 400 (Bad Request) | -81 | Комментарий длиннее 120 символов. |
| 400 (Bad Request) | -82 | Поездка уже оценена. |
| 409 (Conflict) | -83 | Невозможно оценить поездку. Конфликт при обновлении записи. |
| 500 (Internal Server Error) | Ошибка сервера. |
Клиенты
Запрос отчета по заказам клиентом (Запрос типа GET):
...
Параметры ответа | Возможные значения | Описание |
dispatching_order_uid | b8f3d3fa-0df0-4e0f-9def-725c7f1a2a40 | GUID заказа |
required_time | 2013-08-13T12:02:10.689 | Дата и время выполнения заказа |
order_cost | Массив пар «key-name». | Стоимость заказа |
user_full_name | Иванов Иван | Полное имя клиента |
user_phone | Телефон клиента | |
route | Маршрут заказа | |
route/name | г. Акварель (пер. Столешников 3) | Улица или объект точки маршрута заказа |
route/number | 11а | Номер дома улицы точки маршрута заказа |
close_reason | 0 | Статус закрытия заказа (см. Приложение 1) |
execution_status | Executed | Статус выполнения заказа (см. Приложение 2) |
| rating | 2 | Оценка поездки |
| rating_comment | Not ok | Комментарий к оценке поездки |
[
{
"required_time":"2013-08-13T12:02:10.689"
...
"payment_system_permitted": 0,
"add_cost_increment_value": 1
...