...
Тип запроса | 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 |
...
,"crew_average_rating": 4.99
,"rating":4
,"rating_comment":"Ok"
,"route_address_from":{
...
Запрос на скрытие заказа (удалить поездку):
http://<ipaddress>:<port>/api/weborders/hide/44ebd09e5f224651bf3c8e2dd12ed890
Основные параметры Http-запроса:
...
Request (запрос):
...
Response (ответ):
...
Получение избранных адресов
http://<ipaddress>:<port>/api/client/addresses
Основные параметры Http-запроса:
...
Response (ответ):
...
[
{
"favorite_address_uid":"da2ed520-488e-4824-b4bc-13bfb2b566e9",
"alias":"Мой дом",
"comment":"Домофон не работает",
"type":1,
"address":{
"name":"КРЕЩАТИК УЛ.",
"number":"7a",
"lat":50.451063,
"lng":50.451063
},
"entrance":1
},
{
"favorite_address_uid":"7c0cae96-4510-41e6-997b-d564f62ba81f",
"alias":"alias1",
"comment":"Домофон не работает",
"type":2,
"address":{
"name":"КРЕЩАТИК УЛ.",
"number":"7a",
"lat":50.451063,
"lng":50.451063
},
"entrance":1
}
]
Сохранение избранного адреса
http://<ipaddress>:<port>/api/client/addresses
Основные параметры Http-запроса:
...
Request (запрос):
...
{
"alias":"Мой дом",
"comment":"Домофон не работает",
"type":1,
"address":{
"name":"КРЕЩАТИК УЛ.",
"number":"7a",
"lat":50.451063,
"lng":150.451063
},
"entrance":1
}
Response (ответ):
Идентификатор избранного адреса : "7c0cae96-4510-41e6-997b-d564f62ba81f"
...
Изменение избранного адреса
http://<ipaddress>:<port>/api/client/addresses
Основные параметры Http-запроса:
...
Request (запрос):
...
{
"favorite_address_uid":"7c0cae96-4510-41e6-997b-d564f62ba81f",
"alias":"дом",
"comment":"Домофон не работает",
"type":2,
"address":{
"name":"КРЕЩАТИК УЛ.",
"number":"7a",
"lat":50.451063,
"lng":50.451063
},
"entrance":1
}
Удаление избранного адреса
http://<ipaddress>:<port>/api/client/addresses/<favoriteAddressGuid>
Основные параметры Http-запроса:
...
Response (ответ):
...
{
"currency":"грн",
"payment_terminal_permitted":false,
...
"ANIMAL",
"CONDIT"
],
"custom_extra_charges": [
{
"Id": 20,
"Name": "Cusotm charge name"
},
{
"Id": 27,
"Name": "Cusotm charge other name"
}
],
"show_custom_extra_charges_before_system": true
}
...
Установка версии API.
Header X-API-VERSION необходимо указывать для использования различных версий API, особенности в описании полей. Используемую версию WebOrders WebAPI можно запросить.
Если указывать версию в X-API-VERSION больше чем используемая версия бекенда, то будут задействованы контракты запроса/ответа используемой версии бекенда.
Если не указывать версию X-API-VERSION, то будет использованы контракты запроса/ответа которые были до введения заголовка версионности.
Response (ответ):
...