Действия

API сервера такси: различия между версиями

Материал из Таксомёт

Строка 18: Строка 18:
'''Описание параметров'''
'''Описание параметров'''


     ''operator_login'' - логин оператора. Предварительно необходимо создать учетную запись оператора в интерфейсе программы.
     [[operator_login]] - логин оператора. Предварительно необходимо создать учетную запись оператора в интерфейсе программы.
     ''operator_password'' - пароль оператора.
     [[operator_password]] - пароль оператора.
     ''unit_id'' - ID службы такси на сервере такси. ID службы можно узнать в разделе программы \"Службы такси и тарифы\" (Настройки -> службы такси и тарифы).
     [[unit_id]] - ID службы такси на сервере такси. ID службы можно узнать в разделе программы \"Службы такси и тарифы\" (Настройки -> службы такси и тарифы).


'''Ответ'''
'''Ответ'''

Версия от 17:21, 22 декабря 2021

Сервер такси имеет HTTP/HTTPS API с с помощью которого Вы можете произвести интеграцию сервера такси с Вашим сервисом или программой. С помощью HTTP API можно, например, создать заказ на сервер такси программно, который далее будет распределяться водителям и пройдет обычный цикл жизни заказ, так же через HTTP API можно управлять заказами, делать финансовые записи, работать с бонусами клиентов и выполнять практически все функции программно, которые есть в программе Такомёт.

Общее описание

HTTP API работает с GET запросами.

Для работы с API Вам предварительно необходимо создать учетную запись оператора и использовать логин и пароль этого оператора в запросах API.

URL адрес для API запросов располагается на том же домене, что и рабочее место оператора.

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

Данный метод позволяет создать заказ со всеми необходимыми параметрами в системе.

URL для запроса:

   https://***.taxomet.ru/api/v1/add_order?operator_login=<логин_оператора>&operator_password=<пароль_оператора>&unit_id=<ID_службы>&tarif_id=<ID_тарифа>&phone=<телефон_пассажира>&to[]=<адрес_1>&to[]=<адрес_2>&car_option[]=<ID_дополнительной_опции_авто>&fix_price=<фикс_цена>&id=<ID_заказа_в_Вашей_сситеме>

Описание параметров

   operator_login - логин оператора. Предварительно необходимо создать учетную запись оператора в интерфейсе программы.
   operator_password - пароль оператора.
   unit_id - ID службы такси на сервере такси. ID службы можно узнать в разделе программы \"Службы такси и тарифы\" (Настройки -> службы такси и тарифы).

Ответ

Ответ в формате JSON:

   {"result":"1", "error":"", "order_id":"2342"}

Параметры result, error, order_id всегда присутствуют в ответе. В случае успешного выполнения запроса и заказ создан параметр result имеет значение 1. В случае если произошла ошибка, то параметр result НЕ равен 1, а в параметр error содержит текстовое описание ошибки. Параметр order_id содержит ID созданного заказа на сервере такси, в случае если заказ не создан и произошла ошибка order_id будет равен 0.


Пример запроса

https://test.taxomet.ru/api/v1/add_order?operator_login=my-api&operator_password=******&unit_id=1&tarif_id=1&phone=+70001112233&to[]=Сочи, Тимирязева ул., 4&to[]=Сочи, Парковая ул., 42&car_option[]=1&fix_price=200&id=1234