База знаний
Дерево страниц

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

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

changes.mady.by.user Ольга Чеснокова

Сохранено

по сравнению с

Новая версия 12

changes.mady.by.user Ольга Чеснокова

Сохранено

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.

...

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:

...

Параметры запроса

Тип данных

Обязательный параметр

Возможные значения

Описание

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_costBooleanНетTrue, FalseРассчитать стоимость с рекомендуемой дополнительной стоимостью

taxiColumnId

Int32

Да

0, 1 или 2

Номер колоны, в которую будут приходить заказы.

payment_type

Int32

Нет

Null, 0 или 1

Тип оплаты заказа (нал, безнал) (см. Приложение 4).

extra_charge_codesArray<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) должны быть взаимоисключающими. Если одновременно  указать несколько из вышеперечисленных параметров, учитываться будет только один в порядке приоритета:

...

Параметры запроса

Тип данных

Обязательный параметр

Возможные значения

Описание

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_costBooleanНетTrue, FalseРассчитать стоимость с рекомендуемой дополнительной стоимостью

taxiColumnId

Int32

Да

0, 1 или 2

Номер колоны, в которую будут приходить заказы.

payment_type

Int32

Нет

Null, 0 или 1

Тип оплаты заказа (нал, безнал) (см. Приложение 4).

calculated_tariff_namesString[]Да

[
"Базовый",
"Универсал",
"Бизнес-класс"
]

Список тарифов по которым нужно просчитать стоимость заказа
extra_charge_codesArrray<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) в отличии от "Рассчет стоимости заказа" на просчет стоимости не влияют.

...

Параметры запроса

Тип данных

Обязательный параметр

Возможные значения

Описание

user_full_name

String

Да


Полное имя пользователя

user_phone

String

Да


Телефон пользователя

client_sub_card

String

Да, если у постоянного клиента есть доп. карточка


Номер доп карточки

pay_bonuses

Decimal

Нет

94

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

app_registration_token

String

Нет


Уникальный идентификатор получателя уведомления.

extra_charge_codesArray<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

Оплата по безналичному расчету невозможна для заказа «по городу».

...

    ,"crew_average_rating": 4.99

    ,"rating":4

    ,"rating_comment":"Ok"

    ,"route_address_from":{

...

Статус ответа

Сообщение

401 (Unauthorized )

Клиент не авторизирован.

404 (Not Found)

Заказ не найден.

403 (Forbidden)

Данное действие отклонено. Пожалуйста, свяжитесь с нами. (при попытке изменить стоимость ОНЛАЙН заказа)

400 (Bad Request)

Неверная сумма. (При отрицательной сумме.)

400 (Bad Request)

Недопустимое значение в Добавочной стоимости. (Сумма больше 100000)

400 (Bad Request)

Данный заказ недоступен. (На заказе найдена машина.)

409 (Conflict)

Невозможно изменить стоимость заказа. (Заказ заблокирован другой транзакцией.)

...

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


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

True, false

Разрешена ли оплата заказа через платежный (экварийнговый) терминал для клиента.

payment_system_permitted0, 1Возможность оплаты через платежную систему
add_cost_increment_value1, 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_systemtrue, 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

}


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

...

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

...