...

Тип запроса	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 POST PUT DELETE	/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
Geo данные (улицы)	GET	/api/geodata/streets/search?q=search&fields=*
Geo данные (объекты)	GET	/api/geodata/objects?versionDateGratherThan=2013.07.11%2015:14:13.893
Geo данные (объекты)	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

...

Http-метод

POST

Url

/api/account/register/sendConfirmCode

Headers

Accept: application/json

Content-Type: application/json; charset=utf-8

Content-Length:

X-WO-API-APP-ID: your_app_id

["ENGLISH", "ANIMAL"]

Request (запрос):

Параметры запроса	Обязательный параметр	Описание
phone	Да	Номер мобильного телефона, на который будет отправлен код подтверждения.
taxiColumnId	Нет	Номер колоны, из которой отправляется SMS (0, 1 или 2, по умолчанию 0).
appHash	Нет	Хэш Android приложения для автоматической подстановки смс кода. 11 символов.

Пример тела запроса в формате json:

...

{"Id":-35,"Message":"Invalid confirmation code."}

Запрос версии

http://<ipaddress>:<port>/api/version

Основные параметры Http-запроса:

...

Работа с заказами

Рассчет стоимости заказа

http://<ipaddress>:<port>/api/weborders/cost

Основные параметры Http-запроса:

Http-метод

POST

Url

/api/weborders/cost

Headers

Accept: application/json

Content-Type: application/json; charset=utf-8

Content-Length:

Authorization:Basic YWNod...YQ==

X-WO-API-APP-ID: your_app_id

X-API-VERSION: web_orders_api_version

Request (запрос):

Параметры запроса	Тип данных	Обязательный параметр	Возможные значения	Описание
user_full_name	String	Нет		Полное имя пользователя
user_phone	String	Нет		Телефон пользователя
reservation	Boolean	Да	True, False	Признак предварительного заказа
required_time		Нет	"2015-08-24T19:15:00"	Время подачи предварительного заказа
comment	String	Нет		Комментарий к заказу
minibus *	Boolean	Нет	True, False	Микроавтобус
wagon *	Boolean	Нет	True, False	Универсал
premium *	Boolean	Нет	True, False	Машина премиум-класса
flexible_tariff_name *	String	Нет		Гибкий тариф
baggage	Boolean	Нет	True, False	Загрузка салона. Параметр доступен при X-API-VERSION < 1.41.0.
animal	Boolean	Нет	True, False	Перевозка животного. Параметр доступен при X-API-VERSION < 1.41.0.
conditioner	Boolean	Нет	True, False	Кондиционер. Параметр доступен при X-API-VERSION < 1.41.0.
courier_delivery	Boolean	Нет	True, False	Курьер. Параметр доступен при X-API-VERSION < 1.41.0.
route_undefined	Boolean	Нет	True, False	По городу
terminal	Boolean	Нет	True, False	Терминал. Параметр доступен при X-API-VERSION < 1.41.0.
receipt	Boolean	Нет	True, False	Требование чека за поездку. Параметр доступен при X-API-VERSION < 1.41.0.
route		Да		Маршрут заказа. (См. Таблицу описания маршрута)
route_address_entrance_from	String	Нет	2а	Номер подъезда
client_sub_card	String	Нет		Номер доп карточки
add_cost	Decimal	Нет	10	Дополнительная стоимость к заказу
calc_with_rec_add_cost	Boolean	Нет	True, False	Рассчитать стоимость с рекомендуемой дополнительной стоимостью
taxiColumnId	Int32	Да	0, 1 или 2	Номер колоны, в которую будут приходить заказы.
payment_type	Int32	Нет	Null, 0 или 1	Тип оплаты заказа (нал, безнал) (см. Приложение 4).
extra_charge_codes	Array<String>	Нет	["ENGLISH", "ANIMAL"]	Список кодов доп. услуг (api/settings). Параметр доступен при X-API-VERSION >= 1.41.0.
custom_extra_charges	Array<Int32>	Нет	[20, 12, 13]	Список идентификаторов пользовательских доп. услуг (api/settings). Параметр добавлен в версии 1.46.0.

* Признаки «Гибкий тариф» (flexible_tariff_name), «Универсал» (wagon), «Микроавтобус» (minibus) и «Премиум» (premium) должны быть взаимоисключающими. Если одновременно указать несколько из вышеперечисленных параметров, учитываться будет только один в порядке приоритета:

...

Рассчет стоимости заказа для нескольких тарифов:

http://<ipaddress>:<port>api/weborders/tariffs/cost

Основные параметры Http-запроса:

Http-метод

POST

Url

api/weborders/tariffs/cost

Headers

Accept: application/json

Content-Type: application/json; charset=utf-8

Content-Length:

Authorization:Basic YWNod...YQ==

X-API-VERSION: web_orders_api_version

X-WO-API-APP-ID: your_app_id

...

Параметры запроса	Тип данных	Обязательный параметр	Возможные значения	Описание
user_full_name	String	Нет		Полное имя пользователя
user_phone	String	Нет		Телефон пользователя
reservation	Boolean	Да	True, False	Признак предварительного заказа
required_time		Нет	"2015-08-24T19:15:00"	Время подачи предварительного заказа
comment	String	Нет		Комментарий к заказу
minibus	Boolean	Нет	True, False	Микроавтобус
wagon	Boolean	Нет	True, False	Универсал
premium	Boolean	Нет	True, False	Машина премиум-класса
flexible_tariff_name	String	Нет		Гибкий тариф
baggage	Boolean	Нет	True, False	Загрузка салона. Параметр доступен при X-API-VERSION < 1.41.0.
animal	Boolean	Нет	True, False	Перевозка животного. Параметр доступен при X-API-VERSION < 1.41.0.
conditioner	Boolean	Нет	True, False	Кондиционер. Параметр доступен при X-API-VERSION < 1.41.0.
courier_delivery	Boolean	Нет	True, False	Курьер. Параметр доступен при X-API-VERSION < 1.41.0.
route_undefined	Boolean	Нет	True, False	По городу
terminal	Boolean	Нет	True, False	Терминал. Параметр доступен при X-API-VERSION < 1.41.0.
receipt	Boolean	Нет	True, False	Требование чека за поездку.Параметр доступен при X-API-VERSION < 1.41.0.
route		Да		Маршрут заказа. (См. Таблицу описания маршрута)
route_address_entrance_from	String	Нет	2а	Номер подъезда
client_sub_card	String	Нет		Номер доп карточки
add_cost	Decimal	Нет	10	Дополнительная стоимость к заказу
calc_with_rec_add_cost	Boolean	Нет	True, False	Рассчитать стоимость с рекомендуемой дополнительной стоимостью
taxiColumnId	Int32	Да	0, 1 или 2	Номер колоны, в которую будут приходить заказы.
payment_type	Int32	Нет	Null, 0 или 1	Тип оплаты заказа (нал, безнал) (см. Приложение 4).
calculated_tariff_names	String[]	Да	[ "Базовый", "Универсал", "Бизнес-класс" ]	Список тарифов по которым нужно просчитать стоимость заказа
extra_charge_codes	Arrray<String>	Нет	["ANIMAL", "ENGLISH"]	Список кодов доп. услуг (api/settings). Параметр доступен при X-API-VERSION >= 1.41.0.
custom_extra_charges	Array<Int32>	Нет	[20, 12, 13]	Список идентификатов пользовательских доп. услуг (api/settings). Параметр добавлен в версии 1.46.0.

Параметры «Гибкий тариф» (flexible_tariff_name), «Микроавтобус» (minibus), «Универсал» (wagon), «Премиум» (premium) в отличии от "Рассчет стоимости заказа" на просчет стоимости не влияют.

...

}

]

Создание заказа:

http://<ipaddress>:<port>/api/weborders

Основные параметры Http-запроса:

Http-метод

POST

Url

/api/weborders

Headers

Accept: application/json

Content-Type: application/json; charset=utf-8

Content-Length:

Authorization:Basic YWNod...YQ==

X-API-VERSION: web_orders_api_version

X-WO-API-APP-ID: your_app_id

...

Параметры запроса	Тип данных	Обязательный параметр	Возможные значения	Описание
user_full_name	String	Да		Полное имя пользователя
user_phone	String	Да		Телефон пользователя
client_sub_card	String	Да, если у постоянного клиента есть доп. карточка		Номер доп карточки
pay_bonuses	Decimal	Нет	94	Сумма, которую клиент хочет оплатить бонусами (на данный момент эта сумма должна полностью покрывать стоимость заказа). Только для постоянных клиентов.
app_registration_token	String	Нет		Уникальный идентификатор получателя уведомления.
extra_charge_codes	Array<String>	Нет	["ENGLISH", "ANIMAL"]	Список кодов доп. услуг (api/settings). Параметр доступен при X-API-VERSION >= 1.41.0.
custom_extra_charges	Array<Int32>	Нет	[20, 12, 13]	Список идентификатов пользовательских доп. услуг (api/settings). Параметр добавлен в версии 1.46.0.

Response (ответ):

Параметры ответа	Тип данных	Возможные значения	Описание
dispatching_order_uid	String	44ebd09e5f224651bf3c8e2dd12ed890	Идентификатор заказа, присвоенный в БД ТН
find_car_timeout	Int32	120	Таймаут на поиск машины, в сек. По истечению таймаута, если машина не была найдена, заказ закрывается со статусом “Нет машины” (CloseReason = 4)
find_car_delay	Int32	0	Задержка на поиск машины, в сек (в случае предварительного заказа). Время по истечении которого начнется выполняться поиск машины. Для не предварительного заказа равняется 0.

...

Статус ответа	Id ошибки	Описание
200 (Ok)		Заказ успешно принят.
400 (BadRequest)		Неверные параметры запроса.
400 (BadRequest)	-13	Ошибка создания заказа, т.к. указанного адреса (улицы) нет в базе данных.
400 (BadRequest)	-14	Ошибка создания заказа, т.к. указанного адреса (объекта) нет в базе данных.
400 (BadRequest)	-15	Неверный номер колоны (taxiColumnId)
403 (Forbidden)	-11	Постоянный клиент заблокирован диспетчерской.
403 (Forbidden)	-12	У постоянного безнального клиента недостаточно денег на балансе для выполнения заказа.
403 (Forbidden)	-23	Номер телефона в «Черном списке»
403 (Forbidden)	-40	Требуется подтверждение телефона для анонимного пользователя (см. запрос POST api/approvedPhones/).
403 (Forbidden)	-50	Использование бонусов запрещено настройками «Такси Навигатор» или пользователь не авторизирован.
403 (Forbidden)	-51	У пользователя недостаточно бонусов для оплаты заказа.
403 (Forbidden)	-52	Бонусов для оплаты меньше, чем стоимость заказа.
403 (Forbidden)	-53	Оплата бонусами невозможна для заказа «по городу».
400 (BadRequest)	-54	Некорректное время подачи. (Дата и время подачи машины должно быть позже текущей даты)
400 (BadRequest)	-55	Добавочная сумма должна быть больше -100000 или и меньше - 100000
400 (BadRequest)	-64	Несуществующая пользовательская доп. услуга
400 (BadRequest)	-65	Неверное имя тарифа 'тариф'
403 (Forbidden)	-66	Оплата по безналичному расчету невозможна для заказа «по городу».

Получение списка тарифов

http://<ipaddress>:<port>/api/tariffs

Основные параметры Http-запроса:

...

[
   {
       "name":"Базовый"
   },
   {
       "name":"Универсал"
   },
   {
       "name":"Бизнес-класс"
   },
   {
       "name":"Премиум-класс"
    },
   {
       "name":"Эконом-класс"
   },
   {
       "name":"Микроавтобус"
   }
]

Якорь

	Запрос состояния заказа
	Запрос состояния заказа

Запрос состояния заказа

http://<ipaddress>:<port>/api/weborders/44ebd09e5f224651bf3c8e2dd12ed890

...

Параметры ответа	Тип данных	Возможные значения	Описание
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	Адрес 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":"ОЗЕРНАЯ УЛ. (ОБОЛОНЬ)"

...

Запрос информации о позывном

http://<ipaddress>:<port>/api/weborders/44ebd09e5f224651bf3c8e2dd12ed890/driver

...

Основные параметры Http-запроса:

Http-метод

GET

Url

/api/weborders/<uid>/driver

Headers

Accept: application/json

Authorization:Basic YWNod...YQ==

...

"signal": 100

}

Добавочная стоимость

http://<ipaddress>:<port>/api/weborders/44ebd09e5f224651bf3c8e2dd12ed890/cost/additional

...

Параметры запроса	Обязательный параметр	Описание
id	Да	Уникальный идентификатор заказа.
amount	Decimal	Добавочная стоимость.

Response (ответ):

См. Описание ответа для информации по заказу

Response в случае ошибок (ответ):

Статус ответа	Сообщение
401 (Unauthorized )	Клиент не авторизирован.
404 (Not Found)	Заказ не найден.
403 (Forbidden)	Данное действие отклонено. Пожалуйста, свяжитесь с нами. (при попытке изменить стоимость ОНЛАЙН заказа)
400 (Bad Request)	Неверная сумма. (При отрицательной сумме.)
400 (Bad Request)	Недопустимое значение в Добавочной стоимости. (Сумма больше 100000)
400 (Bad Request)	Данный заказ недоступен. (На заказе найдена машина.)
409 (Conflict)	Невозможно изменить стоимость заказа. (Заказ заблокирован другой транзакцией.)

...

Запрос GPS положения машины, выполняющей заказ:

http://<ipaddress>:<port>/api/weborders/drivercarposition/44ebd09e5f224651bf3c8e2dd12ed890

...

Запрос отмены заказа клиентом:

http://<ipaddress>:<port>/api/weborders/cancel/44ebd09e5f224651bf3c8e2dd12ed890

...

Значение	Описание
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)		Ошибка сервера.

Запрос на скрытие заказа (удалить поездку):

http://<ipaddress>:<port>/api/weborders/hide/44ebd09e5f224651bf3c8e2dd12ed890

Основные параметры Http-запроса:

Http-метод

PUT

Url

/api/weborders/hide/<uid>

Headers

Accept: application/json

Authorization:Basic YWNod...YQ==

Authorization: Bearer {JWT}

Request (запрос):

Параметры запроса	Обязательный параметр	Описание
<uid>	Да	UID заказа в БД ТН (полученный в ответе на запрос создания заказа).

Response (ответ):

Статус ответа	Описание
200 (OK)	Заказ успешно скрыт.
404 (Not Found)	Заказ не найден.
403 (Forbidden)	Действие запрещено, клиент не соответствует заказу.
400 (Bad Request)	Статус заказа не соответсвует статусу "Выполнен"/"Перекинут на сервер(выполнен)"
400 (Bad Request)	Не удалось скрыть заказ.
500 (Internal Server Error)	Ошибка сервера.

Клиенты

Запрос отчета по заказам клиентом (Запрос типа GET):

http://<ipaddress>:<port>/api/clients/ordersreport?dateFrom=2013.08.13%2000:00:00&dateTo=2013.08.15%2000:00:00

...

Запрос истории по заказам клиента:

http://<ipaddress>:<port>/api/clients/ordershistory?limit=10&offset=0&executionStatus=

...

Параметры запроса	Обязательный параметр	Описание
limit	Нет	Вернуть количество записей
offset	Нет	Пропустить количество записей
executionStatus	Нет	Критерий выборки заказов в зависимости от статуса выполнения заказа (см. далее execution_status). В качестве параметра можно передавать перечень статусов выполнения заказа (Примечание 2) раздеденных разделенных запятой, которые необходимо получить. Например: executionStatus=WaitingCarSearch,SearchesForCar,CarFound,Running,Canceled,Executed или executionStatus=* - возвращает все заказы отсутствующий параметр executionStatus — эквивалентен executionStatus=Executed

...

Параметры ответа	Возможные значения	Описание
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"

...

Запрос истории по изменениям бонусов клиента:

http://<ipaddress>:<port>/api/clients/bonusreport?limit=10&offset=0

...

Код	Описание
-1	«Замораживание» бонусов за выполняющиеся заказы. В случае закрытия заказа как «Выполненный» - бонусы будут окончательно списаны, иначе - возвращены клиенту.
0	Изменение диспетчером вручную
1	Закрытие выполненного заказа
2	Возврат выполненного заказа из архива
3	Отмена по вине диспетчера. Закрытие заказа, оплаченного бонусом
4	Возврат заказа, оплаченного бонусом, из архива

Запрос профиля клиента:

http://<ipaddress>:<port>/api/clients/profile

Основные параметры Http-запроса:

...

Список самых новых адресов сформирован из 5 уникальных адресов, которые были использованы в выполненных заказах пассажира за последние 30 дней. Список отображается начиная с самых самых новых заказов, а также приоритет отдается начальным точкам в случае если в заказе больше пяти точек.

http://<ipaddress>:<port>/api/clients/lastaddresses

Основные параметры Http-запроса:

...

Обновление профиля клиента:

http://<ipaddress>:<port>/api/clients/profile

Основные параметры Http-запроса:

...

Обновление информации для отправки push:

http://<ipaddress>:<port>/api/clients/credential

Основные параметры Http-запроса:

...

Пополнение баланса клиента (прием платежей) через платежные системы

http://<ipaddress>:<port>/api/clients/balance/transactions/

...

Название параметра	Возможные значения	Описание
id	37564	Уникальный идентификатор транзакции
amount	25.75	Сумма платежа
currency	UAH	Валюта платежа
description	Предоплата услуг.	Описание платежа
customer	10176	Уникальный идентификатор пользователя
statusCallbackURL	http://my_host.ua:6969/api/liqpay/status/	URL для получения изменеий статуса платежа

...

"customer":10176,

"statusCallbackURL":"http://my_host.ua:6969/api/liqpay/status/"

}

Response в случае ошибок (ответ):

...

Получение транзакции оплаты

http://<ipaddress>:<port>/api/clients/balance/transactions/<id>

...

История изменения баланса

http://<ipaddress>:<port>/api/clients/balance/transactions/

...

Описание полей ответа см. в Получение транзакции оплаты

Получение избранных адресов

http://<ipaddress>:<port>/api/client/addresses

Основные параметры Http-запроса:

Http-метод

GET

Url

/api/client/addresses

Headers

Content-Type: application/json

Authorization: Basic YWNod...YQ

Response (ответ):

Параметры ответа	Тип данных	Возможные значения	Описание
favorite_address_uid	String	da2ed520-488e-4824-b4bc-13bfb2b566e9	Идентификатор избранного адреса.
alias	String	Мой дом	Название. Максимальный размер 100.
comment	String	Домофон не работает.	Комментарий для создания заказа. Максимальный размер 1024.
type	enum	3	Тип адреса: 1 - home, 2 - job, 3 - other.
entrance	Int32	1	Подъезд
name	String	КРЕЩАТИК УЛ.	Улица или Объект. Если number пустое, то name это Объект, иначе Улица. Максимальный размер 200.
number	String	7a	Номер дома. Максимальный размер 10.
lat	Decimal	50.451063	Широта
lng	Decimal	50.451063	Долгота

[
{
"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-запроса:

Http-метод

POST

Url

/api/client/addresses

Headers

Content-Type: application/json

Authorization: Basic YWNod...YQ

Request (запрос):

Параметры ответа	Тип данных	Обязательный параметр	Возможные значения	Описание
alias	String	Нет	Мой дом	Название. Максимальный размер 100.
comment	String	Нет	Домофон не работает.	Комментарий для создания заказа. Максимальный размер 1024.
type	enum	Да	3	Тип адреса: 1 - home, 2 - job, 3 - other.
entrance	Int32	Нет	1	Подъезд
name	String	Да	КРЕЩАТИК УЛ.	Улица или Объект. Если number пустое, то name это Объект, иначе Улица. Максимальный размер 200.
number	String	Нет	7a	Номер дома. Максимальный размер 10.
lat	Decimal(9,6)	Да	50.451063	Широта
lng	Decimal(9,6)	Да	150.451063	Долгота

{
      "alias":"Мой дом",
      "comment":"Домофон не работает",
      "type":1,
      "address":{
          "name":"КРЕЩАТИК УЛ.",
          "number":"7a",
          "lat":50.451063,
          "lng":150.451063
      },
      "entrance":1
  }

Response (ответ):

Идентификатор избранного адреса : "7c0cae96-4510-41e6-997b-d564f62ba81f"

Статус ответа	Id ошибки	Описание
400 (BadRequest)	-84	Превышено максимальное количество избранных адресов клиента. Доступно не более 30.

Изменение избранного адреса

http://<ipaddress>:<port>/api/client/addresses

Основные параметры Http-запроса:

Http-метод

PUT

Url

/api/client/addresses

Headers

Content-Type: application/json

Authorization: Basic YWNod...YQ

Request (запрос):

Параметры ответа	Тип данных	Возможные значения	Описание
favorite_address_uid	String	da2ed520-488e-4824-b4bc-13bfb2b566e9	Идентификатор избранного адреса, который необходимо обновить.
alias	String	Мой дом	Название. Максимальный размер 100.
comment	String	Домофон не работает.	Комментарий для создания заказа. Максимальный размер 1024.
type	enum	3	Тип адреса: 1 - home, 2 - job, 3 - other.
entrance	Int32	1	Подъезд
name	String	КРЕЩАТИК УЛ.	Улица или Объект. Если number пустое, то name это Объект, иначе Улица. Максимальный размер 200.
number	String	7a	Номер дома. Максимальный размер 10.
lat	Decimal(9,6)	50.451063	Широта
lng	Decimal(9,6)	50.451063	Долгота

  {
      "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-запроса:

Http-метод

DELETE

Url

/api/client/addresses/<favoriteAddressGuid>

Headers

Content-Type: application/json

Authorization: Basic YWNod...YQ

Response (ответ):

Параметры ответа	Тип данных	Возможные значения	Описание
favoriteAddressGuid	String	da2ed520-488e-4824-b4bc-13bfb2b566e9	Идентификатор избранного адреса.

Гео данные

Запрос гео-данных (всех объектов):

http://<ipaddress>:<port>/api/geodata/objects?versionDateGratherThan=03.01.2013 10:45:45.944

Данный запрос возвращает информацию о всех объектах.

...

Поиск гео-данных (объектов) по нескольким буквам

http://<ipaddress>:<port>/api/geodata/objects/search?q=search&offset=0&limit=10&translitetion=true&qwertySwitcher=true&fields=*

...

Запрос гео-данных (всех улиц):

http://<ipaddress>:<port>/api/geodata/streets?versionDateGratherThan=03.01.2013 10:45:45.944

Данный запрос возвращает информацию о всех улицах.

...

Поиск гео-данных (улиц) по нескольким буквам

http://<ipaddress>:<port>/api/geodata/streets/search?q=search&offset=0&limit=10

...

Поиск гео-данных (улиц и объектов) по нескольким буквам

http://<ipaddress>:<port>/api/geodata/search?q=search&offset=0&limit=10

...

Поиск ближайших гео-данных (улиц и объектов) по географическим координатам (долгота-широта)

http://<ipaddress>:<port>/api/geodata/search?lat=50.447878&lng=30.522925&r=500

...

Поиск ближайшей геоточки (улицы или объекта) по географическим координатам (долгота-широта).

http://<ipaddress>:<port>/api/geodata/nearest?lat=50.447878&lng=30.522925&r=500

...

Http-метод

GET

Url

/api/geodata/nearest?lat=50/4478&lng=30.522925&r=500

Headers

Accept: application/json

Authorization:Basic YWNod...YQ==

...

{
"geo_streets":{
   "geo_street":[],
   "version_date":null,
   "geo_data_info":null
},
"geo_objects":{
   "geo_object":[],
   "version_date":null,
   "geo_data_info":null
}
}

Запрос настроек

http://<ipaddress>:<port>/api/settings

Основные параметры Http-запроса:

...

Название параметра	Возможные значения	Описание
currency	грн	Аббревиатура валюты
payment_terminal_permitted	True, false	Разрешена ли оплата заказа через платежный (экварийнговый) терминал для клиента.
payment_system_permitted	0, 1	Возможность оплаты через платежную систему
add_cost_increment_value	1, 5	Шаг изменения стоимости на widget.
extra_charge_codes	["BAGGAGE", "CONDIT"]	Список кодов доп. услуг. Параметр доступен при X-API-VERSION >= 1.41.0. Возможные значения: "BAGGAGE" - Загрузка салона, "ANIMAL" - Животное, "CONDIT" - Кондиционер, "MEET" - Встреча с табличкой, "COURIER" - Курьер. доставка, "TERMINAL" - Терминал, "CHECK" - Чек, "BABY_SEAT" - Детское кресло, "DRIVER" - Драйвер, "NO_SMOKE" - Некурящий водитель, "ENGLISH" - Англоговорящий водитель, "CABLE" - Трос, "FUEL" - Подвоз бензина, "WIRES" - Провода, "SMOKE" - Я буду курить
custom_extra_charges	[ { "Id": 20, "Name": "Cusotm charge name" }, { "Id": 27, "Name": "Cusotm charge other name" }]	Список идентификторов пользовательских доп. услуг с названиями с учетом локализации (используются только EN-US, UK-UA, RU-RU). Параметр добавлен в версии 1.46.0.
show_custom_extra_charges_before_system	true, false	Признак отображения пользовательских доп. услуг перед системными. Параметр добавлен в версии 1.46.0.

{

"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

}

Запрос настроек шага добавочной стоимости

http://<ipaddress>:<port>/api/settings/addCostIncrementValue

Основные параметры Http-запроса:

Http-метод	GET
Url	/api/settings/addCostIncrementValue

Response (ответ):

Название параметра	Возможные значения	Описание
-	Decimal	Шаг изменения стоимости на widget.

Запрос серверного времени

http://<ipaddress>:<port>/api/time

Основные параметры Http-запроса:

...

Запрос версии TaxiNavigator

http://<ipaddress>:<port>/api/tnVersion

Основные параметры Http-запроса:

...

Получение координат автомобилей в радиусе

http://<ipaddress>:<port>/api/drivers/position?lat=<latitude>&lng=<longitude>&radius=<km>

...

Http-метод

GET

Url

/api/drivers/position?lat=<latitude>&lng=<longitude>&radius=<km>

Headers

Accept: application/json

Authorization:Basic YWNod...YQ
X-API-VERSION: web_orders_api_version

Request (запрос):

Название параметра	Обязательный параметр	Описание
latitude	Да	Широта
longitude	Да	Долгота
radius	Да	Радиус поиска автомобилей (в км.)

...

Название параметра	Возможные значения	Описание
drivercar_position	Object	Текущее положение автомобиля. (См. Запрос GPS положения машины, выполняющей заказ)
car.types	["Wagon", "Minibus", "Truck", "Premium", "Elite"]	Тип автомобиля
car.options	["AirConditioning", "Terminal"]	Дополнительные опции. Параметр при X-API-VERSION < 1.41.0 в формате ["AirConditioning", "Terminal"]. Параметр при X-API-VERSION >= 1.41.0 в формате ["ENGLISH", "ANIMAL"]
state	Closed, Free, Busy	Статус водителя.

...

WaitingCarSearch	Ожадается поиск машины (для предварительного заказа)
SearchesForCar	Выполняется поиск машины
CarFound	Машина найдена
Running	Заказ выполняется (машина найдена и предположительно пассажир уже едет)
Canceled	Заказ отменен (клиентом, диспетчером, водителем)
Executed	Заказ успешно выполнен
CostCalculation	Просчет

ПРИЛОЖЕНИЕ 3. Результат в виде ошибки выполнения операции

...

Id	Описание
0	Неизвестная ошибка.
-2	Ошибка авторизации пользователя. Неверно указан логин или пароль.
-3	Не удалось найти пользователя по запрошенному логину или номеру телефона.
-4	Не удалось найти пользователя по его номеру телефона, так как таких пользователей несколько.
-5	Слишком много запросов за короткое время.
-10	Неверные параметры запроса.
-11	Ошибка выполнения заказа, т.к. пользователь заблокирован диспетчерской.
-12	Ошибка выполнения заказа, т.к. недостаточно денег на балансе для выполнения заказа.
-13	Ошибка создания заказа, т.к. указанного адреса (улицы) нет в базе данных.
-14	Ошибка создания заказа, т.к. указанного адреса (объекта) нет в базе данных.
-15	Неверный номер колоны.
-16	Использование терминала запрещено настройками в диспетчерской.
-20	Дублирование запроса. Подобный запрос уже обрабатывается.
-21	Дублирование заказа. Вы не можете создавать подобный заказ, пока не нашлась машина на предыдущий заказ.
-22	Ошибка преобразования ид локальных координат в географические (долгота, широта), или наоборот.
-23	Номер телефона в черном списке.
-24	Оплата наличными запрещена.
-25	Безналичный расчет запрещен.
-30	Неизвестная ошибка регистрации.
-31	Операция запрещена настройками «Такси Навигатор».
-32	Пользователь с таким номером телефона уже зарегистрирован.
-34	Неверный формат номера телефона.
-35	Неверный код подтверждения.
-36	Не указан пароль.
-37	Пароль подтверждения не соответствует паролю.
-38	Длина пароля не удовлетворяет условию от 7 до 30 символов.
-40	Операция запрещена. Требуется подтверждение телефона.
-42	Ошибка верификации телефона. Телефон уже подтвержден.
-50	Использование бонусов запрещено настройками «Такси Навигатор» или пользователь неавторизирован.
-51	У пользователя недостаточно бонусов для оплаты заказа.
-52	Бонусов для оплаты меньше, чем стоимость заказа.
-53	Оплата бонусами невозможна для заказа «по городу».
-54	Дата и время подачи машины должно быть позже <даты>
-55	Добавочная сумма должна быть больше -100000 или и меньше - 100000
-64	Несуществующая пользовательская доп. услуга
-84	Превышено количество избранных адресов клиента.
-100	Ошибка выполнения операции.

...

Так же, по значению этого хедера возможно начисление бонусов постоянному клиенту (пассажиру) за первую регистрацию/авторизацию.

Установка версии API.

Header X-API-VERSION необходимо указывать для использования различных версий API, особенности в описании полей. Используемую версию WebOrders WebAPI можно запросить.

Если указывать версию в X-API-VERSION больше чем используемая версия бекенда, то будут задействованы контракты запроса/ответа используемой версии бекенда.

Если не указывать версию X-API-VERSION, то будет использованы контракты запроса/ответа которые были до введения заголовка версионности.

Response (ответ):

Параметры ответа

Тип данных

Описание

repayment_status

Enum

Статус оплаты погашения долга.

Возможные значения статуса оплаты долга: Created = 1, Success = 2, Failed = 3.

Блок кода

language	js
title	JSON

{
   "repayment_status":2
}

Дерево страниц

История страницы

Сравнение версий

Старая версия 4

Новая версия Текущий

Ключ

Запрос версии

Работа с заказами

Рассчет стоимости заказа

Рассчет стоимости заказа для нескольких тарифов:

Создание заказа:

Получение списка тарифов

Запрос состояния заказа

Запрос информации о позывном

Добавочная стоимость

Запрос GPS положения машины, выполняющей заказ:

Запрос отмены заказа клиентом:

Оценка поездки

Запрос на скрытие заказа (удалить поездку):

Клиенты

Запрос отчета по заказам клиентом (Запрос типа GET):

Запрос истории по заказам клиента:

Запрос истории по изменениям бонусов клиента:

Запрос профиля клиента:

Обновление профиля клиента:

Обновление информации для отправки push:

Пополнение баланса клиента (прием платежей) через платежные системы

Получение транзакции оплаты

История изменения баланса

Получение избранных адресов

Сохранение избранного адреса

Изменение избранного адреса

Удаление избранного адреса

Гео данные

Запрос гео-данных (всех объектов):

Поиск гео-данных (объектов) по нескольким буквам

Запрос гео-данных (всех улиц):

Поиск гео-данных (улиц) по нескольким буквам

Поиск гео-данных (улиц и объектов) по нескольким буквам

Поиск ближайших гео-данных (улиц и объектов) по географическим координатам (долгота-широта)

Поиск ближайшей геоточки (улицы или объекта) по географическим координатам (долгота-широта).

Запрос настроек

Запрос настроек шага добавочной стоимости

Запрос серверного времени

Запрос версии TaxiNavigator

Получение координат автомобилей в радиусе

ПРИЛОЖЕНИЕ 3. Результат в виде ошибки выполнения операции

Установка версии API.