API сервера такси: различия между версиями
Материал из Таксомёт
Krolist (обсуждение | вклад) Новая страница: «Сервер такси имеет HTTP/HTTPS API с с помощью которого Вы можете произвести интеграцию сервера…» |
Krolist (обсуждение | вклад) |
||
Строка 18: | Строка 18: | ||
'''Описание папаметров''' | '''Описание папаметров''' | ||
'''Ответ | '''Ответ''' | ||
Ответ в формате JSON: | |||
{"result":"1", "error":"", "order_id":"2342"} | |||
Параметры result, error, order_id всегда присутствуют в ответе. В случае успешного выполнения запроса и заказ создан параметр result имеет значение 1. В случае если произошла ошибка, то параметр result НЕ равен 1, а в параметр error содержит текстовое описание ошибки. Параметр order_id содержит ID созданного заказа на сервере такси, в случае если заказ не создан и произошла ошибка order_id будет равен 0. | |||
'''Пример запроса''' | '''Пример запроса''' | ||
<nowiki>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</nowiki> | <nowiki>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</nowiki> |
Версия от 17:13, 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_заказа_в_Вашей_сситеме>
Описание папаметров
Ответ
Ответ в формате 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