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

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

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

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

...

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

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

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

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

...

Параметры запроса	Тип данных	Обязательный параметр	Возможные значения	Описание
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.

...

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

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

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

...

}

]

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

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

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

...

Параметры запроса	Тип данных	Обязательный параметр	Возможные значения	Описание
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.

...

Статус ответа	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-запроса:

...

Якорь

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

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

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

...

,"crew_average_rating": 4.99

,"rating":4

,"rating_comment":"Ok"

,"route_address_from":{

...

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

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

...

Запрос 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://<ipaddress>:<port>/api/weborders/hide/44ebd09e5f224651bf3c8e2dd12ed890

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

...

Request (запрос):

...

Response (ответ):

...

Запрос отчета по заказам клиентом (Запрос типа 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

...

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

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 для получения изменений изменеий статуса платежа

{

"id":37564,

...

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

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

...

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

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

...

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

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 (ответ):

...

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

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

Работает по тому же принципу что и "Поиск ближайших гео-данных (улиц и объектов) по географическим координатам (долгота-широта)." только возвращает один ближайшей объект или дом. Также если дом или объект не найден то свойства "geo_street" или "geo_object" будут содержать пустые массивы масивы вместо null.

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

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://<ipaddress>:<port>/api/time

...

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

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

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

...

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

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

...

Название параметра	Возможные значения	Описание
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	Статус водителя.

...

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

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

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

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

Response (ответ):

...

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

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

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

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

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

Ключ

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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