TM API — различия между версиями

Материал из TaxiMaster
Перейти к: навигация, поиск
(Регистрация клиента)
(Общее описание протокола)
 
(не показано 138 промежуточных версий этого же участника)
Строка 6: Строка 6:
 
# Сделать ваш сайт более информативным: публиковать полезную для клиентов информацию прямо из системы - список ближайших [[Справочник «Экипажи»|экипажей]], предварительный расчет стоимости поездки, мониторинг движения автомобиля такси в процессе выполнения [[заказ]]а, [[Модуль «Интеграция с картами»|карты города]] и контактную информацию.   
 
# Сделать ваш сайт более информативным: публиковать полезную для клиентов информацию прямо из системы - список ближайших [[Справочник «Экипажи»|экипажей]], предварительный расчет стоимости поездки, мониторинг движения автомобиля такси в процессе выполнения [[заказ]]а, [[Модуль «Интеграция с картами»|карты города]] и контактную информацию.   
  
{{Warning|Все перечисленные функции работают в Такси-Мастер не ниже [[История изменений в программе Такси-Мастер#Такси-Мастер. Версия 3.9.0 от 16.11.2020|3.9.0 от 16.11.2020г]]. В более ранних версиях программы часть функций может не поддерживаться.}}
+
{{Warning|Все перечисленные функции работают в Такси-Мастер не ниже [[История изменений в программе Такси-Мастер#Такси-Мастер. Версия 3.14 от 11.12.2023|3.14 от 11.12.2023г]]. В более ранних версиях программы часть функций может не поддерживаться.}}
  
 
== Параметры TM API ==
 
== Параметры TM API ==
Строка 17: Строка 17:
 
В данной ветке регулируется доступ к синхронизации Такси-Мастер со сторонним сервисом (сайтом), с помощью которого клиенты будут создавать заказы. С примером кода для работы вы можете ознакомиться в данной статье в разделе [[TM API#Общее описание протокола|Общее описание протокола]].
 
В данной ветке регулируется доступ к синхронизации Такси-Мастер со сторонним сервисом (сайтом), с помощью которого клиенты будут создавать заказы. С примером кода для работы вы можете ознакомиться в данной статье в разделе [[TM API#Общее описание протокола|Общее описание протокола]].
 
# Установите флажок {{checkbox|Использовать открытое API}} для того, чтобы запустить работу протокола TMCommonAPI.  
 
# Установите флажок {{checkbox|Использовать открытое API}} для того, чтобы запустить работу протокола TMCommonAPI.  
# В поле {{поле|Секретный ключ}} укажите произвольный номер. В дальнейшем этот номер следует использовать в API-запросах на сайте.  
+
# В поле {{поле|Секретный ключ}} укажите произвольный номер. В дальнейшем этот номер следует использовать в API-запросах на сайте.
 +
# В таблице "Пользователи CommonAPI" можно настроить доступ к CommonAPI. Для этого нужно создать пользователей, у которых будет отдельный секретный ключ, и отметить доступные запросы CommonAPI.
  
 
=== Ветка «API для телефонии» ===
 
=== Ветка «API для телефонии» ===
Строка 33: Строка 34:
 
# Установите флажок {{checkbox|Включить прием терминальных платежей}}. Данная функция позволит отображать все платежные операции по приходу средств от водителей через терминалы в базе данных программы.  
 
# Установите флажок {{checkbox|Включить прием терминальных платежей}}. Данная функция позволит отображать все платежные операции по приходу средств от водителей через терминалы в базе данных программы.  
 
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы с платежными системами и сверки платежей, который будет выслан вам в письме от менеджера. Секретный ключ - это определенный набор символов, необходимый для формирования подписи при передаче информации о платеже.
 
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы с платежными системами и сверки платежей, который будет выслан вам в письме от менеджера. Секретный ключ - это определенный набор символов, необходимый для формирования подписи при передаче информации о платеже.
# В полях {{поле|Логин}} и {{поле|Пароль}} введите данные учетной записи на сайте http://term.bitmaster.ru.
 
 
# Кнопка {{кнопка|Задать всем водителям терминальный аккаунт по их ИД}} служит для соединения TM API с сервером Такси-Мастер. В результате соединения записи о терминальных аккаунтах генерируются, заносятся (для тех водителей, у которых они отсутствуют) и обновляются (для тех водителей, у которых уже существуют терминальные аккаунты) в Такси-Мастер.
 
# Кнопка {{кнопка|Задать всем водителям терминальный аккаунт по их ИД}} служит для соединения TM API с сервером Такси-Мастер. В результате соединения записи о терминальных аккаунтах генерируются, заносятся (для тех водителей, у которых они отсутствуют) и обновляются (для тех водителей, у которых уже существуют терминальные аккаунты) в Такси-Мастер.
  
Строка 39: Строка 39:
  
 
== Общее описание протокола ==
 
== Общее описание протокола ==
 
 
=== Формат запроса ===
 
=== Формат запроса ===
  
[[TMAPI]] принимает входящие запросы по протоколу HTTPS. В URI запроса после ip адреса и порта, который будет слушать TM API, должно идти название API (common_api) и версия
+
[[TMAPI]] принимает входящие запросы по протоколу HTTPS. В URI запроса после ip адреса и порта, который будет слушать TM API, должно идти название API (common_api) и версия API. Пример:
API. Пример:
 
  
 
<pre>
 
<pre>
GET https://ip:port/common_api/1.0/get_crew_groups_list  
+
GET https://ip:port/common_api/1.0/get_crew_groups_list HTTP/1.1
 
</pre>
 
</pre>
  
Строка 55: Строка 53:
 
</pre>
 
</pre>
  
В запросе типа POST параметры передаются в теле запроса в формате application/x-www-form-urlencoded. Пример:
+
В запросе типа POST параметры передаются в теле запроса в формате application/x-www-form-urlencoded или application/json в зависимости от запроса. Пример:
  
 
<pre>
 
<pre>
POST https://ip:port/common_api/1.0/create_order  
+
POST https://ip:port/common_api/1.0/create_order HTTP/1.1
 
Signature: <...>
 
Signature: <...>
 
Content-Type: application/x-www-form-urlencoded
 
Content-Type: application/x-www-form-urlencoded
Строка 67: Строка 65:
 
</pre>
 
</pre>
  
В любом запросе обязательно должен быть заголовок Signature. В нем передается MD5 хэш, рассчитанный для строки, которая получается сцеплением строки параметров запроса с секретным ключом. Секретный ключ задается в настройках модуля TMWeb в ТМ2. Пример:
+
В любом запросе обязательно должен быть заголовок Signature. В нем передается MD5 хэш, рассчитанный для строки, которая получается сцеплением строки параметров запроса с секретным ключом. Секретный ключ задается в {{путь|Файл - Настройки - TM API - Открытое API}}. Пример:
  
 
<pre>
 
<pre>
 
Запрос:
 
Запрос:
GET https://ip:port/common_api/1.0/calc_order_cost?tariff_id=1&distance_city=10  
+
GET https://ip:port/common_api/1.0/calc_order_cost?tariff_id=1&distance_city=10 HTTP/1.1
  
 
Секретный ключ:
 
Секретный ключ:
Строка 78: Строка 76:
 
Signature = MD5("tariff_id=1&distance_city=10" + "1234567890") = d7b8fb11b5499b64d750b8efe53e2877
 
Signature = MD5("tariff_id=1&distance_city=10" + "1234567890") = d7b8fb11b5499b64d750b8efe53e2877
 
</pre>
 
</pre>
 +
 +
Также в запросе может содержаться заголовок "X-User-Id" c ИД пользователя CommonAPI, если запрос делается от какого-то конкретного пользователя CommonAPI. Если будет передан этот заголовок, то секретный ключ будет проверяться именно для указанного пользователя CommonAPI, а также будут проверяться права доступа пользователя CommonAPI к данному запросу. Если заголовок "X-User-Id" не будет передан, то тогда будет проверяться общий секретный ключ CommonAPI, и будет разрешен доступ ко всем запросам CommonAPI. Пример запроса с указанием ИД пользователя:
 +
 +
<pre>
 +
POST https://ip:port/common_api/1.0/create_order HTTP/1.1
 +
Signature: <...>
 +
X-User-Id: 123
 +
Content-Type: application/x-www-form-urlencoded
 +
Content-Length: 118
 +
 +
phone=89123456789&source=SOURCE&source_time=20120501100000&dest=DEST&customer=CUSTOMER&comment=COMMENT&crew_group_id=1
 +
</pre>
 +
  
 
=== Формат ответа ===
 
=== Формат ответа ===
Строка 106: Строка 117:
 
|-
 
|-
 
|3
 
|3
|API отключено в настройках модуля TM API в ТМ2
+
|API отключено в настройках модуля TM API в ТМ
 
|-
 
|-
 
|4
 
|4
Строка 128: Строка 139:
 
|10
 
|10
 
|Внутренняя ошибка обработки запроса
 
|Внутренняя ошибка обработки запроса
 +
|-
 +
|13
 +
|Не найден пользователь CommonAPI с ИД, указанным в заголовке X-User-Id
 +
|-
 +
|14
 +
|Запрос недоступен для пользователя CommonAPI с ИД, указанным в заголовке X-User-Id
 
|}
 
|}
  
Строка 699: Строка 716:
 
|111
 
|111
 
|Не найден клиент, который может использовать собственный счет для оплаты заказов
 
|Не найден клиент, который может использовать собственный счет для оплаты заказов
 +
|-
 +
|114
 +
|Недостаточно средств на безналичном счете клиента в ТМ
 +
|-
 +
|115
 +
|Отрицательный баланс на безналичном счете клиента в ТМ
 +
|-
 +
|116
 +
|Для клиента запрещена оплата заказа наличными. Клиент должен максимально использовать в заказе безналичную оплату (оплату с основного счета)
 
|}
 
|}
  
Строка 782: Строка 808:
 
|Целое
 
|Целое
 
|ИД стоянки
 
|ИД стоянки
|-
 
|server_time_offset
 
|Целое
 
|Смещения относительно серверного времени
 
 
|-
 
|-
 
|source_time
 
|source_time
Строка 792: Строка 814:
 
|-
 
|-
 
!colspan="3"|Необязательные параметры
 
!colspan="3"|Необязательные параметры
 +
|-
 +
|server_time_offset
 +
|Целое
 +
|Смещения относительно серверного времени
 
|-
 
|-
 
|passenger
 
|passenger
Строка 911: Строка 937:
 
* «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
 
* «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
 
* «Перечисляемый» (значение выбранного элемента перечисления)
 
* «Перечисляемый» (значение выбранного элемента перечисления)
 +
* «Дата» и «Дата/время» (Unix-время, всегда целое число)
 
|-
 
|-
 
|&bull; str_value
 
|&bull; str_value
 
|Строка
 
|Строка
 
|Значение, если тип атрибута «Строка»
 
|Значение, если тип атрибута «Строка»
 +
|-
 +
|payment_pay_system
 +
|Строка
 +
|Тип платежной системы ("qr", либо пусто, если не используется)
 
|}
 
|}
  
Строка 966: Строка 997:
 
     "message":"Текст ошибки для пользователя."
 
     "message":"Текст ошибки для пользователя."
 
   }
 
   }
 +
|-
 +
|114
 +
|Недостаточно средств на безналичном счете клиента в ТМ
 +
|-
 +
|115
 +
|Отрицательный баланс на безналичном счете клиента в ТМ
 +
|-
 +
|116
 +
|Для клиента запрещена оплата заказа наличными. Клиент должен максимально использовать в заказе безналичную оплату (оплату с основного счета)
 
|}
 
|}
  
Строка 1056: Строка 1096:
 
             "str_value": "строка"
 
             "str_value": "строка"
 
       }
 
       }
   ]
+
   ],
 +
  "payment_pay_system": "qr"
 
}
 
}
  
Строка 1279: Строка 1320:
 
!Тип
 
!Тип
 
!Описание
 
!Описание
 +
|-
 +
!colspan="3"|Необязательные параметры
 +
|-
 +
|order_id
 +
|Целое
 +
|ИД заказа
 
|-
 
|-
 
|tariff_id
 
|tariff_id
Строка 1426: Строка 1473:
 
* «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
 
* «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
 
* «Перечисляемый» (значение выбранного элемента перечисления)
 
* «Перечисляемый» (значение выбранного элемента перечисления)
 +
* «Дата» и «Дата/время» (Unix-время, всегда целое число)
 
|-
 
|-
 
|&bull; str_value
 
|&bull; str_value
Строка 1478: Строка 1526:
 
|113
 
|113
 
|Атрибут не может быть привязан к заказу
 
|Атрибут не может быть привязан к заказу
 +
|-
 +
|114
 +
|Заказ не найден
 
|}
 
|}
  
Строка 1589: Строка 1640:
  
 
=== Изменение состояния заказа ===
 
=== Изменение состояния заказа ===
 
 
Метод: POST
 
Метод: POST
  
Строка 1609: Строка 1659:
 
|Целое
 
|Целое
 
|Новое состояние заказа
 
|Новое состояние заказа
 +
|-
 +
!colspan="3"|Необязательные параметры
 +
|-
 +
|cancel_order_penalty_sum
 +
|Дробное
 +
|Сумма штрафа клиента за отмену заказа. Если свойство new_state имеет тип "Прекращен" (выполняется отмена заказа) и при отмене заказа должен быть назначен штраф клиенту, то если данное значение штрафа указано (даже если указано значение 0), то оно имеет приоритет. Если данное значение не указано, то сумма штрафа будет определена автоматически по группе клиентов.
 
|}
 
|}
  
Строка 1676: Строка 1732:
 
|Целое
 
|Целое
 
|ИД экипажа
 
|ИД экипажа
 +
|-
 +
!colspan="3"|Необязательные параметры
 +
|-
 +
|fields
 +
|Строка
 +
|Список возвращаемых полей через запятую
 
|}
 
|}
  
Строка 1764: Строка 1826:
 
|true или false  
 
|true или false  
 
|Запрет работы вне запланированных смен
 
|Запрет работы вне запланированных смен
 +
|-
 +
|fuel_level
 +
|Дробное
 +
|Уровень топлива в автомобиле
 
|-
 
|-
 
|order_params
 
|order_params
Строка 1791: Строка 1857:
 
* «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
 
* «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
 
* «Перечисляемый» (значение выбранного элемента перечисления)
 
* «Перечисляемый» (значение выбранного элемента перечисления)
 +
* «Дата» и «Дата/время» (Unix-время, всегда целое число)
 
|-
 
|-
 
|&bull; str_value
 
|&bull; str_value
Строка 1870: Строка 1937:
 
|true или false
 
|true или false
 
|Нужно ли возвращать экипажи не на линии. По умолчанию возвращаются только экипажи на линии
 
|Нужно ли возвращать экипажи не на линии. По умолчанию возвращаются только экипажи на линии
 +
|-
 +
|fields
 +
|Строка
 +
|Список возвращаемых полей через запятую
 
|}
 
|}
  
Строка 1879: Строка 1950:
 
!Тип
 
!Тип
 
!Описание
 
!Описание
|-
 
! colspan="3" | Обязательные параметры
 
 
|-
 
|-
 
|crews_info
 
|crews_info
Строка 1957: Строка 2026:
 
|true или false  
 
|true или false  
 
|Запрет работы вне запланированных смен
 
|Запрет работы вне запланированных смен
 +
|-
 +
|&bull; fuel_level
 +
|Дробное
 +
|Уровень топлива в автомобиле
 
|-
 
|-
 
|&bull; order_params
 
|&bull; order_params
Строка 1965: Строка 2038:
 
|Целое
 
|Целое
 
|ИД параметра заказа
 
|ИД параметра заказа
|}
+
|-
 
+
|&bull; attribute_values
Пример:
+
|Массив
 +
|Массив значений атрибутов
 +
|-
 +
|&bull; &bull; id
 +
|Целое
 +
|Идентификатор атрибута
 +
|-
 +
|&bull; &bull; bool_value
 +
|true или false
 +
|Значение, если тип атрибута «Логический»
 +
|-
 +
|&bull; &bull; num_value
 +
|Дробное
 +
|Значение, если тип атрибута:
 +
* «Число» (непосредственное значение)
 +
* «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
 +
* «Перечисляемый» (значение выбранного элемента перечисления)
 +
* «Дата» и «Дата/время» (Unix-время, всегда целое число)
 +
|-
 +
|&bull; &bull; str_value
 +
|Строка
 +
|Значение, если тип атрибута «Строка»
 +
|}
 +
 
 +
Пример:
  
 
<pre>
 
<pre>
Строка 1999: Строка 2096:
 
         "has_label":false,
 
         "has_label":false,
 
         "use_plan_shifts":false,
 
         "use_plan_shifts":false,
 +
        "fuel_level":8.15,
 
         "order_params":[
 
         "order_params":[
 
           1,
 
           1,
Строка 2023: Строка 2121:
 
         "has_label":true,
 
         "has_label":true,
 
         "use_plan_shifts":true,
 
         "use_plan_shifts":true,
 +
        "fuel_level":null,
 
         "order_params":[]
 
         "order_params":[]
 
       }
 
       }
Строка 2112: Строка 2211:
 
* «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
 
* «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
 
* «Перечисляемый» (значение выбранного элемента перечисления)
 
* «Перечисляемый» (значение выбранного элемента перечисления)
 +
* «Дата» и «Дата/время» (Unix-время, всегда целое число)
 
|-
 
|-
 
|&bull; str_value
 
|&bull; str_value
Строка 2270: Строка 2370:
 
|Целое
 
|Целое
 
|ИД параметра  
 
|ИД параметра  
 +
|-
 +
|attribute_values
 +
|Массив
 +
|Массив значений атрибутов
 +
|-
 +
|&bull; id
 +
|Целое
 +
|Идентификатор атрибута
 +
|-
 +
|&bull; bool_value
 +
|true или false
 +
|Значение, если тип атрибута «Логический»
 +
|-
 +
|&bull; num_value
 +
|Дробное
 +
|Значение, если тип атрибута:
 +
* «Число» (непосредственное значение)
 +
* «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
 +
* «Перечисляемый» (значение выбранного элемента перечисления)
 +
* «Дата» и «Дата/время» (Unix-время, всегда целое число)
 +
|-
 +
|&bull; str_value
 +
|Строка
 +
|Значение, если тип атрибута «Строка»
 
|}
 
|}
  
Строка 2352: Строка 2476:
 
|true или false
 
|true или false
 
|Нужна ли фотография водителя
 
|Нужна ли фотография водителя
 +
|-
 +
|fields
 +
|Строка
 +
|Список возвращаемых полей через запятую
 
|}
 
|}
  
Строка 2388: Строка 2516:
 
|Целое
 
|Целое
 
|ИД основного автомобиля водителя
 
|ИД основного автомобиля водителя
 +
|-
 +
|driver_license
 +
|Строка
 +
|Водительское удостоверение
 
|-
 
|-
 
|license
 
|license
 
|Строка
 
|Строка
|Удостоверение водителя
+
|Разрешение на перевозку
 
|-
 
|-
 
|home_phone
 
|home_phone
Строка 2408: Строка 2540:
 
|true или false
 
|true или false
 
|Водитель уволен
 
|Водитель уволен
 +
|-
 +
|self_employed
 +
|true или false
 +
|Водитель самозанятый
 +
|-
 +
|inn
 +
|Строка
 +
|ИНН водителя
 +
|-
 +
|insurance_number
 +
|Строка
 +
|СНИЛС водителя
 
|-
 
|-
 
|driver_photo
 
|driver_photo
 
|Base64
 
|Base64
|Фото водителя (только если need_photo = true)
+
|Фото водителя (только если need_photo = true или поле driver_photo указано в списке фильтра полей fields)
 
|-
 
|-
 
|order_params
 
|order_params
 
|Массив  
 
|Массив  
|Массив параметров водителя
+
|Массив параметров водителя. Устарело. Рекомендуется использовать параметр attribute_values.
 
|-
 
|-
 
|&bull;
 
|&bull;
Строка 2475: Строка 2619:
 
* «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
 
* «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
 
* «Перечисляемый» (значение выбранного элемента перечисления)
 
* «Перечисляемый» (значение выбранного элемента перечисления)
 +
* «Дата» и «Дата/время» (Unix-время, всегда целое число)
 
|-
 
|-
 
|&bull; str_value
 
|&bull; str_value
 
|Строка
 
|Строка
 
|Значение, если тип атрибута «Строка»
 
|Значение, если тип атрибута «Строка»
 +
|-
 +
|kpi
 +
|Дробное
 +
|Показатель эффективности (KPI) водителя
 
|}
 
|}
  
Строка 2486: Строка 2635:
 
Запрос:
 
Запрос:
  
GET https://ip:port/common_api/1.0/get_driver_info?driver_id=1&need_photo=false  
+
GET https://ip:port/common_api/1.0/get_driver_info?driver_id=1&need_photo=false HTTP/1.1
 
Signature: <...>
 
Signature: <...>
  
Строка 2548: Строка 2697:
 
               "str_value": "строка"
 
               "str_value": "строка"
 
         }
 
         }
     ]
+
     ],
 +
    "kpi":3.12
 
   }
 
   }
 
}
 
}
Строка 2573: Строка 2723:
 
|true или false
 
|true или false
 
|Включить в ответ запроса уволенных водителей (по умолчанию false)
 
|Включить в ответ запроса уволенных водителей (по умолчанию false)
 +
|-
 +
|fields
 +
|Строка
 +
|Список возвращаемых полей через запятую
 
|}
 
|}
  
Строка 2608: Строка 2762:
 
|Целое
 
|Целое
 
|ИД основного автомобиля водителя
 
|ИД основного автомобиля водителя
 +
|-
 +
|&bull; driver_license
 +
|Строка
 +
|Водительское удостоверение
 
|-
 
|-
 
|&bull; license
 
|&bull; license
 
|Строка
 
|Строка
|Номер лицензии на перевозку (разрешения на перевозку)
+
|Разрешение на перевозку
 
|-
 
|-
 
|&bull; home_phone
 
|&bull; home_phone
Строка 2628: Строка 2786:
 
|true или false
 
|true или false
 
|Водитель уволен
 
|Водитель уволен
 +
|-
 +
|&bull; self_employed
 +
|true или false
 +
|Водитель самозанятый
 +
|-
 +
|&bull; inn
 +
|Строка
 +
|ИНН водителя
 +
|-
 +
|&bull; insurance_number
 +
|Строка
 +
|СНИЛС водителя
 
|-
 
|-
 
|&bull; order_params
 
|&bull; order_params
 
|Массив
 
|Массив
|Массив параметров водителя
+
|Массив параметров водителя. Устарело. Рекомендуется использовать параметр attribute_values
 
|-
 
|-
 
|&bull; &bull;
 
|&bull; &bull;
Строка 2657: Строка 2827:
 
|Терминальный аккаунт
 
|Терминальный аккаунт
 
|-
 
|-
|attribute_values
+
|&bull; attribute_values
 
|Массив
 
|Массив
 
|Массив значений атрибутов
 
|Массив значений атрибутов
 
|-
 
|-
|&bull; id
+
|&bull; &bull; id
 
|Целое
 
|Целое
 
|Идентификатор атрибута
 
|Идентификатор атрибута
 
|-
 
|-
|&bull; bool_value
+
|&bull; &bull; bool_value
 
|true или false
 
|true или false
 
|Значение, если тип атрибута «Логический»
 
|Значение, если тип атрибута «Логический»
 
|-
 
|-
|&bull; num_value
+
|&bull; &bull; num_value
 
|Дробное
 
|Дробное
 
|Значение, если тип атрибута:
 
|Значение, если тип атрибута:
Строка 2675: Строка 2845:
 
* «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
 
* «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
 
* «Перечисляемый» (значение выбранного элемента перечисления)
 
* «Перечисляемый» (значение выбранного элемента перечисления)
 +
* «Дата» и «Дата/время» (Unix-время, всегда целое число)
 
|-
 
|-
|&bull; str_value
+
|&bull; &bull; str_value
 
|Строка
 
|Строка
 
|Значение, если тип атрибута «Строка»
 
|Значение, если тип атрибута «Строка»
 +
|-
 +
|&bull; kpi
 +
|Дробное
 +
|Показатель эффективности (KPI) водителя
 
|}
 
|}
  
Строка 2687: Строка 2862:
 
Запрос:
 
Запрос:
  
GET https://ip:port/common_api/1.0/get_drivers_info  
+
GET https://ip:port/common_api/1.0/get_drivers_info?locked_drivers=true&dismissed_drivers=true HTTP/1.1
 
Signature: <...>
 
Signature: <...>
locked_drivers=true&dismissed_drivers=true
 
  
  
Строка 2735: Строка 2909:
 
                   "str_value": "строка"
 
                   "str_value": "строка"
 
             }
 
             }
         ]
+
         ],
 +
        "kpi":3.12
 
       },
 
       },
 
       {
 
       {
Строка 2769: Строка 2944:
 
                   "str_value": "строка"
 
                   "str_value": "строка"
 
             }
 
             }
         ]
+
         ],
 +
        "kpi":3.12
 
       }
 
       }
 
     ]
 
     ]
Строка 2824: Строка 3000:
 
|Строка
 
|Строка
 
|Водительское удостоверение
 
|Водительское удостоверение
 +
|-
 +
|license
 +
|Строка
 +
|Разрешение на перевозку
 
|-
 
|-
 
|employee_type
 
|employee_type
Строка 2836: Строка 3016:
 
|Строка
 
|Строка
 
|Табельный номер
 
|Табельный номер
|-
 
|license
 
|Строка
 
|Удостоверение
 
 
|-
 
|-
 
|start_date
 
|start_date
Строка 2852: Строка 3028:
 
|Строка
 
|Строка
 
|Терминальный аккаунт (если не указан, будет сгенерирован автоматически), должен состоять из 5 цифр
 
|Терминальный аккаунт (если не указан, будет сгенерирован автоматически), должен состоять из 5 цифр
 +
|-
 +
|self_employed
 +
|true или false
 +
|Водитель самозанятый
 +
|-
 +
|inn
 +
|Строка
 +
|ИНН водителя
 +
|-
 +
|insurance_number
 +
|Строка
 +
|СНИЛС водителя
 
|-
 
|-
 
|comment
 
|comment
Строка 2859: Строка 3047:
 
|order_params
 
|order_params
 
|Массив
 
|Массив
|Массив параметров водителя. Устарело. Рекомендуется использовать параметр attribute_values.
+
|Массив параметров водителя. Устарело. Рекомендуется использовать параметр attribute_values
 
|-
 
|-
 
|&bull;
 
|&bull;
Строка 2907: Строка 3095:
 
* «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
 
* «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
 
* «Перечисляемый» (значение выбранного элемента перечисления)
 
* «Перечисляемый» (значение выбранного элемента перечисления)
 +
* «Дата» и «Дата/время» (Unix-время, всегда целое число)
 
|-
 
|-
 
|&bull; str_value
 
|&bull; str_value
Строка 2938: Строка 3127:
 
|108
 
|108
 
|Водитель должен иметь основной телефон
 
|Водитель должен иметь основной телефон
 +
|-
 +
|109
 +
|Пароль водителя не соответствует политике паролей
 
|}
 
|}
  
Строка 3004: Строка 3196:
 
   "descr":"OK",
 
   "descr":"OK",
 
   "data":{
 
   "data":{
  "driver_id":10
+
    "driver_id":10
}
+
  }
 
}
 
}
 
</pre>
 
</pre>
Строка 3039: Строка 3231:
 
|password
 
|password
 
|Строка
 
|Строка
|Пароль (обязательное поле, если используется сервер связи с водителями)
+
|Пароль  
 
|-
 
|-
 
|uds_id
 
|uds_id
Строка 3060: Строка 3252:
 
|Строка
 
|Строка
 
|Водительское удостоверение
 
|Водительское удостоверение
 +
|-
 +
|license
 +
|Строка
 +
|Разрешение на перевозку
 
|-
 
|-
 
|employee_type
 
|employee_type
Строка 3072: Строка 3268:
 
|Строка
 
|Строка
 
|Табельный номер
 
|Табельный номер
|-
 
|license
 
|Строка
 
|Удостоверение
 
 
|-
 
|-
 
|start_date
 
|start_date
Строка 3112: Строка 3304:
 
|Строка
 
|Строка
 
|Причина увольнения
 
|Причина увольнения
 +
|-
 +
|self_employed
 +
|true или false
 +
|Водитель самозанятый
 +
|-
 +
|inn
 +
|Строка
 +
|ИНН водителя
 +
|-
 +
|insurance_number
 +
|Строка
 +
|СНИЛС водителя
 
|-
 
|-
 
|order_params
 
|order_params
 
|Массив
 
|Массив
|Массив параметров водителя. Устарело. Рекомендуется использовать параметр attribute_values.
+
|Массив параметров водителя. Устарело. Рекомендуется использовать параметр attribute_values
 
|-
 
|-
 
|&bull;
 
|&bull;
Строка 3163: Строка 3367:
 
* «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
 
* «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
 
* «Перечисляемый» (значение выбранного элемента перечисления)
 
* «Перечисляемый» (значение выбранного элемента перечисления)
 +
* «Дата» и «Дата/время» (Unix-время, всегда целое число)
 
|-
 
|-
 
|&bull; str_value
 
|&bull; str_value
Строка 3193: Строка 3398:
 
|-
 
|-
 
|106
 
|106
|Экипаж на линии, запрещено редактирование полей: основной автомобиль, тип работника, служба ЕДС.
+
|Экипаж на линии, запрещено редактирование полей: основной автомобиль, тип работника, служба ЕДС
 
|-
 
|-
 
|107
 
|107
Строка 3200: Строка 3405:
 
|108
 
|108
 
|Водитель должен иметь основной телефон
 
|Водитель должен иметь основной телефон
 +
|-
 +
|109
 +
|Пароль водителя не соответствует политике паролей
 
|}
 
|}
  
Строка 3252: Строка 3460:
 
   ]
 
   ]
 
}
 
}
 +
 
Ответ:
 
Ответ:
 
{
 
{
Строка 3282: Строка 3491:
 
|true или false
 
|true или false
 
|Нужна ли фотография автомобиля
 
|Нужна ли фотография автомобиля
 +
|-
 +
|fields
 +
|Строка
 +
|Список возвращаемых полей через запятую
 
|}
 
|}
  
Строка 3338: Строка 3551:
 
|true или false
 
|true или false
 
|Автомобиль заблокирован
 
|Автомобиль заблокирован
 +
|-
 +
|fuel_level
 +
|Дробное
 +
|Уровень топлива в автомобиле
 
|-
 
|-
 
|order_params
 
|order_params
Строка 3349: Строка 3566:
 
|car_photo
 
|car_photo
 
|Base64
 
|Base64
|Фото автомобиля (только если need_photo = true)
+
|Фото автомобиля (только если need_photo = true или поле driver_photo указано в списке фильтра полей fields)
 
|-
 
|-
 
|attribute_values
 
|attribute_values
Строка 3369: Строка 3586:
 
* «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
 
* «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
 
* «Перечисляемый» (значение выбранного элемента перечисления)
 
* «Перечисляемый» (значение выбранного элемента перечисления)
 +
* «Дата» и «Дата/время» (Unix-время, всегда целое число)
 
|-
 
|-
 
|&bull; str_value
 
|&bull; str_value
Строка 3439: Строка 3657:
 
|true или false
 
|true или false
 
|Включить в ответ заблокированных автомобилей (по умолчанию false)
 
|Включить в ответ заблокированных автомобилей (по умолчанию false)
 +
|-
 +
|fields
 +
|Строка
 +
|Список возвращаемых полей через запятую
 
|}
 
|}
  
Строка 3451: Строка 3673:
 
!Описание
 
!Описание
 
|-
 
|-
|cars_info
+
|crews_info
 
|Массив
 
|Массив
 
|Массив автомобилей
 
|Массив автомобилей
Строка 3494: Строка 3716:
 
|true или false
 
|true или false
 
|Автомобиль заблокирован
 
|Автомобиль заблокирован
 +
|-
 +
|&bull; fuel_level
 +
|Дробное
 +
|Уровень топлива в автомобиле
 
|-
 
|-
 
|&bull; order_params
 
|&bull; order_params
Строка 3521: Строка 3747:
 
* «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
 
* «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
 
* «Перечисляемый» (значение выбранного элемента перечисления)
 
* «Перечисляемый» (значение выбранного элемента перечисления)
 +
* «Дата» и «Дата/время» (Unix-время, всегда целое число)
 
|-
 
|-
 
|&bull; &bull; str_value
 
|&bull; &bull; str_value
Строка 3543: Строка 3770:
 
   "descr":"OK",
 
   "descr":"OK",
 
   "data":{
 
   "data":{
     "cars_info":[
+
     "crews_info":[
 
       {
 
       {
 
         "car_id":1,
 
         "car_id":1,
Строка 3698: Строка 3925:
 
* «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
 
* «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
 
* «Перечисляемый» (значение выбранного элемента перечисления)
 
* «Перечисляемый» (значение выбранного элемента перечисления)
 +
* «Дата» и «Дата/время» (Unix-время, всегда целое число)
 
|-
 
|-
 
|&bull; str_value
 
|&bull; str_value
Строка 3779: Строка 4007:
  
 
=== Обновить информацию об автомобиле ===
 
=== Обновить информацию об автомобиле ===
 
 
Метод: POST
 
Метод: POST
  
Строка 3798: Строка 4025:
 
|-
 
|-
 
!colspan="3"|Необязательные параметры
 
!colspan="3"|Необязательные параметры
 +
|-
 +
|code
 +
|Строка
 +
|Позывной
 
|-
 
|-
 
|mark
 
|mark
Строка 3851: Строка 4082:
 
|Массив параметров автомобиля
 
|Массив параметров автомобиля
 
|-
 
|-
|
+
|&bull;
 
|Целое
 
|Целое
 
|ИД параметра  
 
|ИД параметра  
 +
|-
 +
|attribute_values
 +
|Массив
 +
|Массив значений атрибутов
 +
|-
 +
|&bull; id
 +
|Целое
 +
|Идентификатор атрибута
 +
|-
 +
|&bull; bool_value
 +
|true или false
 +
|Значение, если тип атрибута «Логический»
 +
|-
 +
|&bull; num_value
 +
|Дробное
 +
|Значение, если тип атрибута:
 +
* «Число» (непосредственное значение)
 +
* «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
 +
* «Перечисляемый» (значение выбранного элемента перечисления)
 +
* «Дата» и «Дата/время» (Unix-время, всегда целое число)
 +
|-
 +
|&bull; str_value
 +
|Строка
 +
|Значение, если тип атрибута «Строка»
 
|-
 
|-
 
|is_locked
 
|is_locked
Строка 3895: Строка 4150:
 
<pre>
 
<pre>
 
Запрос:
 
Запрос:
POST https://ip:port/common_api/1.0/update_car_info  
+
POST https://ip:port/common_api/1.0/update_car_info HTTP/1.1
 
Signature: <...>
 
Signature: <...>
 
Content-Type: application/json
 
Content-Type: application/json
Content-Length: 104
+
Content-Length: <...>
  
 
{
 
{
Строка 3976: Строка 4231:
 
|Дробное
 
|Дробное
 
|Широта
 
|Широта
 +
|-
 +
|&bull; speed
 +
|Целое
 +
|Скорость движения, км/ч
 +
|-
 +
|&bull; direction
 +
|Целое
 +
|Направление движения (0-Север, 90-Восток, 180-Юг, 270-Запад, -1-не задано)
 
|-
 
|-
 
|&bull; state_kind
 
|&bull; state_kind
Строка 4112: Строка 4375:
 
|true или false
 
|true или false
 
|Искать адреса в TMGeoService (по умолчанию = false)
 
|Искать адреса в TMGeoService (по умолчанию = false)
 +
|-
 +
|search_in_mapmd
 +
|true или false
 +
|Искать адреса в Map.md (по умолчанию = false)
 
|}
 
|}
  
Строка 4149: Строка 4416:
  
 
•"tmgeoservice" — TMGeoService
 
•"tmgeoservice" — TMGeoService
 +
 +
•"mapmd" - Map.md
 
|-
 
|-
 
|&bull; street
 
|&bull; street
Строка 4330: Строка 4599:
 
|true или false
 
|true или false
 
|Искать адреса в TMGeoService (по умолчанию = false)
 
|Искать адреса в TMGeoService (по умолчанию = false)
 +
|-
 +
|search_in_mapmd
 +
|true или false
 +
|Искать адреса в Map.md (по умолчанию = false)
 
|}
 
|}
  
Строка 4367: Строка 4640:
  
 
•"tmgeoservice" — TMGeoService
 
•"tmgeoservice" — TMGeoService
 +
 +
•"mapmd" - Map.md
 
|-
 
|-
 
|&bull; city
 
|&bull; city
Строка 4459: Строка 4734:
 
</pre>
 
</pre>
  
=== Анализ маршрута ===
+
=== Поиск ближайшего адреса ===
 
Метод: GET
 
Метод: GET
  
Название запроса: analyze_route
+
Название запроса: find_nearest_address
 +
 
 +
Версия ТМ: 3.12
  
 
Параметры:
 
Параметры:
 
 
{|
 
{|
 
!Параметры
 
!Параметры
Строка 4471: Строка 4747:
 
!Описание
 
!Описание
 
|-
 
|-
!colspan="3"|Обязательные параметры
+
! colspan="3"|Обязательные параметры
 
|-
 
|-
|source
+
|lat
|Строка
+
|Дробное
|Адрес подачи
+
|Широта
 
|-
 
|-
|dest
+
|lon
|Строка
+
|Дробное
|Адрес назначения
+
|Долгота
 +
|-
 +
! colspan="3"|Необязательные параметры
 +
|-
 +
|radius
 +
|Целое
 +
|Радиус в метрах
 
|-
 
|-
!colspan="3"|Необязательные параметры
+
|search_in_tm
 +
|true или false
 +
|Искать адреса в ТМ (по умолчанию = true)
 
|-
 
|-
|source_lon
+
|search_in_google
|Дробное
+
|true или false
|Долгота адреса подачи
+
|Искать адреса в Google (по умолчанию = false)
 
|-
 
|-
|source_lat
+
|search_in_tmgeoservice
|Дробное
+
|true или false
|Широта адреса подачи
+
|Искать адреса в TMGeoService (по умолчанию = false)
 
|-
 
|-
|dest_lon
+
|search_in_mapmd
|Дробное
+
|true или false
|Долгота адреса назначения
+
|Искать адреса в Map.md (по умолчанию = false)
 
|-
 
|-
|dest_lat
+
|search_in_2gis
|Дробное
+
|true или false
|Широта адреса назначения
+
|Искать адреса в 2ГИС (по умолчанию = false)
 
|}
 
|}
 
 
Параметр source не является обязательным к заполнению, если заданы source_lon и source_lat.
 
 
Параметр dest не является обязательным к заполнению, если заданы dest_lon и dest_lat.
 
 
  
 
Специальные возвращаемые коды:
 
Специальные возвращаемые коды:
Строка 4512: Строка 4790:
 
|-
 
|-
 
|100
 
|100
|Адрес подачи не распознан
+
|Подходящие адреса не найдены
 
|-
 
|-
 
|101
 
|101
|Адрес назначения не распознан
+
|Не указано место для поиска адресов
|-
 
|102
 
|Маршрут не распознан
 
 
|}
 
|}
  
Строка 4527: Строка 4802:
 
!Описание
 
!Описание
 
|-
 
|-
|source_lat 
+
|address_source
|Дробное
+
|Строка
|Широта адреса подачи
+
|Источник адреса. Может принимать значения:
 +
 
 +
* "tm" — Такси Мастер (адрес из базы данных или из карты)
 +
* "google" — Google
 +
* "tmgeoservice" — TMGeoService
 +
* "2gis" — 2ГИС
 +
* "mapmd" — Map.md
 
|-
 
|-
|source_lon 
+
|city
|Дробное
+
|Строка
|Долгота адреса подачи
+
|Название города
 
|-
 
|-
|source_zone_id 
+
|point
|Целое
+
|Строка
|ИД района подачи
+
|Название пункта
 
|-
 
|-
|dest_lat
+
|street
|Дробное
+
|Строка
|Широта адреса назначения
+
|Название улицы
 
|-
 
|-
|dest_lon 
+
|house
|Дробное
+
|Строка
|Долгота адреса назначения
+
|Номер дома
 +
|-
 +
|kind
 +
|Строка
 +
|
 +
Тип адреса. Может принимать значения:
 +
 
 +
* "street" — улица
 +
* "house" — дом
 +
* "point" — пункт
 
|-
 
|-
|dest_zone_id 
+
|comment
|Целое
+
|Строка
|ИД района назначения
+
|Комментарий
 
|-
 
|-
|city_dist 
+
|coords
|Дробное
+
|Массив
|Километраж по городу
+
|Координаты дома или пункта
 
|-
 
|-
|country_dist 
+
|&bull; lat
 
|Дробное
 
|Дробное
|Километраж за городом
+
|Широта
 
|-
 
|-
|source_country_dist 
+
|&bull; lon
 
|Дробное
 
|Дробное
|Километраж до адреса подачи, если адрес подачи за городом
+
|Долгота
 
|}
 
|}
  
Строка 4567: Строка 4857:
  
 
<pre>
 
<pre>
 +
 
Запрос:
 
Запрос:
  
GET https://ip:port/common_api/1.0/analyze_route?source=STREET1,1&dest=STREET2,2&source_lon=
+
GET https://ip:port/common_api/1.0/find_nearest_address?lat=56.850926&lon=53.212706&radius=100&search_in_tm=false&search_in_google=false&search_in_tmgeoservice=true HTTP/1.1
53.153044&source_lat=56.893301&dest_lon=53.218103&dest_lat=56.869759
 
 
Signature: <...>
 
Signature: <...>
  
Строка 4578: Строка 4868:
 
   "code":0,
 
   "code":0,
 
   "descr":"OK",
 
   "descr":"OK",
   "data":{
+
   "data":
     "source_lat":11.111111,
+
  {
     "source_lon":22.222222,
+
     "address_source":"tmgeoservice",
     "source_zone_id":1,
+
     "kind":"house",
     "dest_lat":33.333333,
+
     "city":"Ижевск",
     "dest_lon":44.444444,
+
     "point":"",
     "dest_zone_id":2,
+
     "street":"Пушкинская ул.",
     "city_dist":1.1,
+
     "house":"206",
     "country_dist":2.2,
+
     "comment":"",
    "source_country_dist":3.3
+
     "coords":
 +
    {
 +
      "lat":56.850951,
 +
      "lon":53.212822
 +
    }
 
   }
 
   }
 
}
 
}
 +
 
</pre>
 
</pre>
  
=== Анализ маршрута 2 ===
+
=== Анализ маршрута ===
 +
Метод: GET
  
Метод: POST
+
Название запроса: analyze_route
  
Название запроса: analyze_route2
+
Параметры:
 
 
Параметры в формате JSON:
 
  
 
{|
 
{|
!Параметр
+
!Параметры
 
!Тип
 
!Тип
 
!Описание
 
!Описание
Строка 4607: Строка 4901:
 
!colspan="3"|Обязательные параметры
 
!colspan="3"|Обязательные параметры
 
|-
 
|-
|addresses
+
|source
|Массив
 
|Массив адресов. Первый элемент — адрес подачи, последний — адрес назначения, между ними — остановки.
 
|-
 
|&bull; address
 
 
|Строка
 
|Строка
 
|Адрес подачи
 
|Адрес подачи
 
|-
 
|-
|&bull; lat
+
|dest
 +
|Строка
 +
|Адрес назначения
 +
|-
 +
!colspan="3"|Необязательные параметры
 +
|-
 +
|source_lon
 
|Дробное
 
|Дробное
|Широта адреса
+
|Долгота адреса подачи
 
|-
 
|-
|&bull; lon
+
|source_lat
 
|Дробное
 
|Дробное
|Долгота адреса
+
|Широта адреса подачи
 
|-
 
|-
!colspan="3"|Необязательные параметры
+
|dest_lon
 +
|Дробное
 +
|Долгота адреса назначения
 
|-
 
|-
|get_full_route_coords
+
|dest_lat
|true или false
+
|Дробное
|Возвращать координаты точек полного маршрута (по умолчанию false)
+
|Широта адреса назначения
|-
 
|crew_group_id
 
|Целое
 
|ИД группы экипажей
 
 
|}
 
|}
 +
 +
 +
Параметр source не является обязательным к заполнению, если заданы source_lon и source_lat.
 +
 +
Параметр dest не является обязательным к заполнению, если заданы dest_lon и dest_lat.
 +
  
 
Специальные возвращаемые коды:
 
Специальные возвращаемые коды:
 
 
{|
 
{|
 
!Код
 
!Код
Строка 4641: Строка 4940:
 
|-
 
|-
 
|100
 
|100
 +
|Адрес подачи не распознан
 +
|-
 +
|101
 +
|Адрес назначения не распознан
 +
|-
 +
|102
 
|Маршрут не распознан
 
|Маршрут не распознан
 
|}
 
|}
  
 
Возвращаемые данные в случае успешного выполнения запроса:
 
Возвращаемые данные в случае успешного выполнения запроса:
 
 
{|
 
{|
!Параметры
+
!Параметр
 
!Тип
 
!Тип
 
!Описание
 
!Описание
 
|-
 
|-
|Addresses
+
|source_lat 
|Массив
+
|Дробное
|Массив адресов. Первый элемент — адрес подачи, последний — адрес назначения, между ними — остановки.
+
|Широта адреса подачи
 
|-
 
|-
|&bull; lat
+
|source_lon 
 
|Дробное
 
|Дробное
|Широта адреса
+
|Долгота адреса подачи
 
|-
 
|-
|&bull; lon
+
|source_zone_id 
|Дробное
+
|Целое
|Долгота адреса
+
|ИД района подачи
 
|-
 
|-
|&bull; zone_id
+
|dest_lat
|Целое
+
|Дробное
|Район адреса
+
|Широта адреса назначения
 
|-
 
|-
|&bull; parking_id
+
|dest_lon 
|Целое
+
|Дробное
|Стоянка адреса
+
|Долгота адреса назначения
 +
|-
 +
|dest_zone_id 
 +
|Целое  
 +
|ИД района назначения
 
|-
 
|-
|city_dist
+
|city_dist
 
|Дробное
 
|Дробное
 
|Километраж по городу
 
|Километраж по городу
 
|-
 
|-
|country_dist
+
|country_dist
 
|Дробное
 
|Дробное
 
|Километраж за городом
 
|Километраж за городом
 
|-
 
|-
|source_country_dist
+
|source_country_dist
 
|Дробное
 
|Дробное
|Километраж до адреса подачи, если адрес подачи за городом.
+
|Километраж до адреса подачи, если адрес подачи за городом
|-
 
|full_route_coords
 
|Массив
 
|Массив координат точек маршрута.
 
|-
 
|&bull; lat
 
|Дробное
 
|Широта точки
 
|-
 
|&bull; lon
 
|Дробное
 
|Долгота точки
 
 
|}
 
|}
  
Строка 4699: Строка 4995:
  
 
<pre>
 
<pre>
 
 
Запрос:
 
Запрос:
  
POST /common_api/1.0/analyze_route2
+
GET https://ip:port/common_api/1.0/analyze_route?source=STREET1,1&dest=STREET2,2&source_lon=
Host: ip:port
+
53.153044&source_lat=56.893301&dest_lon=53.218103&dest_lat=56.869759
Keep-Alive: 300
 
Connection: keep-alive
 
Content-Type: application/json
 
Content-Length: 243
 
 
Signature: <...>
 
Signature: <...>
  
{"get_full_route_coords":true,"addresses":[{"address":"STREET1, 1","lat":11.111111,
+
Ответ:
"lon":22.222222},{"address":"STREET2, 2","lat":33.333333,"lon":44.444444},
 
{"address":"STREET3, 3","lat":55.555555,"lon":55.555555},{"address":"STREET4,
 
4","lat":77.777777,"lon":88.888888}]}
 
 
 
 
 
  
Ответ:
 
 
{
 
{
 
   "code":0,
 
   "code":0,
 
   "descr":"OK",
 
   "descr":"OK",
 
   "data":{
 
   "data":{
    "addresses":[
+
    "source_lat":11.111111,
      {
+
    "source_lon":22.222222,
        "lat":11.111111,
+
    "source_zone_id":1,
        "lon":22.222222,
+
    "dest_lat":33.333333,
        "zone_id":1,
+
    "dest_lon":44.444444,
        "parking_id":1
+
    "dest_zone_id":2,
      },
+
    "city_dist":1.1,
      {
+
    "country_dist":2.2,
        "lat":33.333333,
+
    "source_country_dist":3.3
        "lon":44.444444,
+
   }
        "zone_id":2,
 
        "parking_id":2
 
      }
 
    ],
 
    "city_dist":0,
 
    "country_dist":2.647,
 
    "source_country_dist":3.412,
 
    "full_route_coords":[
 
      {
 
        "lat":55.833603,
 
        "lon":37.515537
 
      },
 
      {
 
        "lat":55.832855,
 
        "lon":37.516315
 
      },
 
      {
 
        "lat":55.833405,
 
        "lon":37.51799
 
      },
 
      ...
 
    ]
 
   }
 
 
}
 
}
 
</pre>
 
</pre>
  
=== Запрос информации о состоянии заказа ===
+
=== Анализ маршрута 2 ===
  
Метод: GET
+
Метод: POST
  
Название запроса: get_order_state
+
Название запроса: analyze_route2
  
Параметры:
+
Параметры в формате JSON:
  
 
{|
 
{|
!Параметры
+
!Параметр
 
!Тип
 
!Тип
 
!Описание
 
!Описание
Строка 4773: Строка 5035:
 
!colspan="3"|Обязательные параметры
 
!colspan="3"|Обязательные параметры
 
|-
 
|-
|order_id 
+
|addresses
 +
|Массив
 +
|Массив адресов. Первый элемент — адрес подачи, последний — адрес назначения, между ними — остановки.
 +
|-
 +
|&bull; address
 +
|Строка
 +
|Адрес подачи
 +
|-
 +
|&bull; lat
 +
|Дробное
 +
|Широта адреса
 +
|-
 +
|&bull; lon
 +
|Дробное
 +
|Долгота адреса
 +
|-
 +
!colspan="3"|Необязательные параметры
 +
|-
 +
|get_full_route_coords
 +
|true или false
 +
|Возвращать координаты точек полного маршрута (по умолчанию false)
 +
|-
 +
|crew_group_id
 
|Целое
 
|Целое
|ИД заказа
+
|ИД группы экипажей
 
|}
 
|}
  
 
Специальные возвращаемые коды:
 
Специальные возвращаемые коды:
 +
 
{|
 
{|
 
!Код
 
!Код
Строка 4784: Строка 5069:
 
|-
 
|-
 
|100
 
|100
|Заказ не найден
+
|Маршрут не распознан
 
|}
 
|}
  
 
Возвращаемые данные в случае успешного выполнения запроса:
 
Возвращаемые данные в случае успешного выполнения запроса:
 +
 
{|
 
{|
!Параметр
+
!Параметры
 
!Тип
 
!Тип
 
!Описание
 
!Описание
 
|-
 
|-
|order_id 
+
|Addresses
|Целое
+
|Массив
|ИД заказа
+
|Массив адресов. Первый элемент — адрес подачи, последний — адрес назначения, между ними — остановки.
 
|-
 
|-
|state_id 
+
|&bull; lat
|Целое
+
|Дробное
|ИД состояния заказа
+
|Широта адреса
 
|-
 
|-
|state_kind
+
|&bull; lon
|Строка
+
|Дробное
|Тип состояния заказа. Может принимать значения:
+
|Долгота адреса
 
 
• "new_order" — новый заказ
 
 
 
• "driver_assigned" — водитель назначен
 
 
 
• "car_at_place" — машина подъехала на место
 
 
 
• "client_inside" — клиент в машине
 
 
 
• "finished" — заказ успешно завершен
 
 
 
• "aborted" — заказ прекращен
 
 
|-
 
|-
|crew_id 
+
|&bull; zone_id
|Целое
 
|ИД экипажа
 
|-
 
|prior_crew_id
 
|Целое
 
|ИД предварительного экипажа
 
|-
 
|driver_id 
 
 
|Целое
 
|Целое
|ИД водителя
+
|Район адреса
 
|-
 
|-
|car_id 
+
|&bull; parking_id
 
|Целое
 
|Целое
|ИД автомобиля
+
|Стоянка адреса
 
|-
 
|-
|server_time_offset
+
|city_dist
|Целое
+
|Дробное
|Смещение относительно серверного времени
+
|Километраж по городу
 
|-
 
|-
|start_time
+
|country_dist
|ГГГГММДДччммсс
+
|Дробное
|Время создания заказа
+
|Километраж за городом
 
|-
 
|-
|source_time
+
|source_country_dist
|ГГГГММДДччммсс
+
|Дробное
|Время подачи
+
|Километраж до адреса подачи, если адрес подачи за городом.
 
|-
 
|-
|finish_time
+
|full_route_coords
|ГГГГММДДччммсс
+
|Массив
|Время завершения заказа
+
|Массив координат точек маршрута.
|-
 
|source 
 
|Строка
 
|Адрес подачи
 
|-
 
|source_lat
 
|Строка
 
|Широта адреса подачи
 
|-
 
|source_lon
 
|Строка
 
|Долгота адреса подачи
 
|-
 
|destination
 
|Строка
 
|Адрес назначения
 
|-
 
|destination_lat
 
|Строка
 
|Широта адреса назначения
 
|-
 
|destination_lon
 
|Строка
 
|Долгота адреса назначения
 
|-
 
|stops
 
|Массив  
 
|Информация по остановкам заказа
 
|-
 
|&bull; address
 
|Строка
 
|Адрес остановки
 
 
|-
 
|-
 
|&bull; lat
 
|&bull; lat
|Дробное  
+
|Дробное
|Широта адреса остановки
+
|Широта точки
 
|-
 
|-
 
|&bull; lon
 
|&bull; lon
|Дробное  
+
|Дробное
|Долгота адреса остановки
+
|Долгота точки
|-
+
|}
|customer
+
 
|Строка
+
Пример:
|Заказчик
+
 
|-
+
<pre>
|passenger
+
 
|Строка
+
Запрос:
|Пассажир
+
 
|-
+
POST /common_api/1.0/analyze_route2
|phone
+
Host: ip:port
|Строка
+
Keep-Alive: 300
|Номер телефона
+
Connection: keep-alive
|-
+
Content-Type: application/json
|phone_to_dial
+
Content-Length: 243
|Строка
+
Signature: <...>
|Номер телефона для отзвона
 
|-
 
|client_id
 
|Целое
 
|ИД клиента
 
|-
 
|client_name
 
|Строка
 
|Имя клиента
 
|-
 
|client_group_id
 
|Целое
 
|ИД группы клиента
 
|-
 
|client_group_name
 
|Строка
 
|Название группы клиента
 
|-
 
|client_employee_id
 
|Целое
 
|ИД сотрудника клиента
 
|-
 
|order_crew_group_id
 
|Целое
 
|ИД группы экипажей, которая указана в заказе
 
|-
 
|tariff_id
 
|Целое
 
|ИД тарифа
 
|-
 
|car_mark
 
|Строка
 
|Марка автомобиля
 
|-
 
|car_model
 
|Строка
 
|Модель автомобиля
 
|-
 
|car_color
 
|Строка
 
|Цвет автомобиля
 
|-
 
|car_number
 
|Строка
 
|Государственный номер автомобиля
 
|-
 
|confirmed
 
|Строка
 
|Состояние подтвержденности заказа водителем или оператором.
 
  
Может принимать значения:
+
{"get_full_route_coords":true,"addresses":[{"address":"STREET1, 1","lat":11.111111,
 +
"lon":22.222222},{"address":"STREET2, 2","lat":33.333333,"lon":44.444444},
 +
{"address":"STREET3, 3","lat":55.555555,"lon":55.555555},{"address":"STREET4,
 +
4","lat":77.777777,"lon":88.888888}]}
  
• "not_confirmed" — не подтверждено
 
  
• "confirmed_by_driver" — заказ принят водителем
 
  
"confirmed_by_oper" — заказ подтвержден оператором
+
Ответ:
 +
{
 +
  "code":0,
 +
  "descr":"OK",
 +
  "data":{
 +
    "addresses":[
 +
      {
 +
        "lat":11.111111,
 +
        "lon":22.222222,
 +
        "zone_id":1,
 +
        "parking_id":1
 +
      },
 +
      {
 +
        "lat":33.333333,
 +
        "lon":44.444444,
 +
        "zone_id":2,
 +
        "parking_id":2
 +
      }
 +
    ],
 +
    "city_dist":0,
 +
    "country_dist":2.647,
 +
    "source_country_dist":3.412,
 +
    "full_route_coords":[
 +
      {
 +
        "lat":55.833603,
 +
        "lon":37.515537
 +
      },
 +
      {
 +
        "lat":55.832855,
 +
        "lon":37.516315
 +
      },
 +
      {
 +
        "lat":55.833405,
 +
        "lon":37.51799
 +
      },
 +
      ...
 +
    ]
 +
  }
 +
}
 +
</pre>
 +
 
 +
=== Запрос информации о состоянии заказа ===
 +
 
 +
Метод: GET
 +
 
 +
Название запроса: get_order_state
 +
 
 +
Параметры:
 +
 
 +
{|
 +
!Параметры
 +
!Тип
 +
!Описание
 
|-
 
|-
|crew_coords
+
!colspan="3"|Обязательные параметры
|Массив
 
|Координаты экипажа
 
 
|-
 
|-
|&bull; lat
+
|order_id 
|Дробное
+
|Целое
|Широта
+
|ИД заказа
 +
|-
 +
!colspan="3"|Необязательные параметры
 
|-
 
|-
|&bull; lon
+
|fields
|Дробное
+
|Строка
|Долгота
+
|Список возвращаемых полей через запятую
 +
|}
 +
 
 +
Специальные возвращаемые коды:
 +
{|
 +
!Код
 +
!Описание
 
|-
 
|-
|order_params
+
|100
|Массив
+
|Заказ не найден
|Массив параметров заказа экипажа
+
|}
 +
 
 +
Возвращаемые данные в случае успешного выполнения запроса:
 +
{|
 +
!Параметр
 +
!Тип
 +
!Описание
 
|-
 
|-
|&bull;
+
|order_id 
 
|Целое
 
|Целое
|ИД параметра заказа
+
|ИД заказа
 +
|-
 +
|state_id 
 +
|Целое
 +
|ИД состояния заказа
 
|-
 
|-
|creation_way
+
|state_kind
|Строка
+
|Строка  
|Способ создания заказа. Может принимать значения:
+
|Тип состояния заказа. Может принимать значения:
  
• "operator" — заказ создан оператором
+
• "new_order" — новый заказ
  
• "sms" — заказ создан через смс
+
• "driver_assigned" — водитель назначен
  
• "market" — заказ из биржи
+
• "car_at_place" — машина подъехала на место
  
• "common_api" — заказ создан через api
+
• "client_inside" — клиент в машине
  
• "t_api" — заказ создан через api
+
• "finished" — заказ успешно завершен
  
• "taxophone" — заказ создан через таксофон с телефона
+
• "aborted" — заказ прекращен
 
 
• "driver" — заказ создан водителем
 
 
 
• "daily_order" — ежедневный заказ
 
 
 
• "taxophone_web" — заказ создан через таксофон с сайта
 
 
 
• "unknown" — неизвестный
 
 
|-
 
|-
|is_prior
+
|crew_id 
|true или false
+
|Целое
|Предварительный заказ
+
|ИД экипажа
 
|-
 
|-
|is_really_prior
+
|prior_crew_id
|true или false
+
|Целое
|Предварительный заказ на вкладке "Предварительные"
+
|ИД предварительного экипажа
 
|-
 
|-
|email
+
|driver_id 
|Строка
+
|Целое
|Email для уведомлений
+
|ИД водителя
 
|-
 
|-
|prior_to_current_before_minutes
+
|car_id 
 
|Целое
 
|Целое
|Время перехода из предварительного в текущие заказы, мин
+
|ИД автомобиля
 
|-
 
|-
|flight_number
+
|server_time_offset
|Строка
+
|Целое
|Номер рейса
+
|Смещение относительно серверного времени
 
|-
 
|-
|sum
+
|start_time
|Дробное
+
|ГГГГММДДччммсс
|Сумма без скидки
+
|Время создания заказа
 
|-
 
|-
|total_sum
+
|source_time
|Дробное
+
|ГГГГММДДччммсс
|Итоговая сумма заказа
+
|Время подачи
 
|-
 
|-
|attribute_values
+
|finish_time
|Массив
+
|ГГГГММДДччммсс
|Массив значений атрибутов
+
|Время завершения заказа
 
|-
 
|-
|&bull; id
+
|source 
|Целое
+
|Строка
|Идентификатор атрибута
+
|Адрес подачи
 
|-
 
|-
|&bull; bool_value
+
|source_lat
|true или false
+
|Строка
|Значение, если тип атрибута «Логический»
+
|Широта адреса подачи
 
|-
 
|-
|&bull; num_value
+
|source_lon
|Дробное
+
|Строка
|Значение, если тип атрибута:
+
|Долгота адреса подачи
* «Число» (непосредственное значение)
 
* «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
 
* «Перечисляемый» (значение выбранного элемента перечисления)
 
 
|-
 
|-
|&bull; str_value
+
|destination
 
|Строка
 
|Строка
|Значение, если тип атрибута «Строка»
+
|Адрес назначения
 
|-
 
|-
|bill
+
|destination_lat
|Массив
+
|Строка
|Чек TMDriver. Данный узел выводится только, если по заказу есть чек
+
|Широта адреса назначения
 +
|-
 +
|destination_lon
 +
|Строка
 +
|Долгота адреса назначения
 +
|-
 +
|stops
 +
|Массив  
 +
|Информация по остановкам заказа
 +
|-
 +
|&bull; address
 +
|Строка
 +
|Адрес остановки
 +
|-
 +
|&bull; lat
 +
|Дробное
 +
|Широта адреса остановки
 +
|-
 +
|&bull; lon
 +
|Дробное
 +
|Долгота адреса остановки
 +
|-
 +
|trip_distance
 +
|Дробное
 +
|Фактический километраж
 +
|-
 +
|trip_time
 +
|Целое
 +
|Фактическое время в пути
 +
|-
 +
|customer
 +
|Строка
 +
|Заказчик
 
|-
 
|-
|&bull; code
+
|passenger
 
|Строка
 
|Строка
|Код элемента расчета
+
|Пассажир
 
|-
 
|-
|&bull; text
+
|phone
 
|Строка
 
|Строка
|Наименование элемента расчета
+
|Номер телефона
 
|-
 
|-
|&bull; value
+
|phone_to_dial
 
|Строка
 
|Строка
|Значение элемента расчета (количество)
+
|Номер телефона для отзвона
 +
|-
 +
|client_id
 +
|Целое
 +
|ИД клиента
 
|-
 
|-
|&bull; sum
+
|client_name
 
|Строка
 
|Строка
|Стоимость элемента расчета
+
|Имя клиента
|}
+
|-
 
+
|client_group_id
Пример:
+
|Целое
 
+
|ИД группы клиента
<pre>
+
|-
Запрос:
+
|client_group_name
 
+
|Строка
GET https://ip:port/common_api/1.0/get_order_state?order_id=1 
+
|Название группы клиента
Signature: <...>
+
|-
 +
|client_employee_id
 +
|Целое
 +
|ИД сотрудника клиента
 +
|-
 +
|order_crew_group_id
 +
|Целое
 +
|ИД группы экипажей, которая указана в заказе
 +
|-
 +
|tariff_id
 +
|Целое
 +
|ИД тарифа
 +
|-
 +
|car_mark
 +
|Строка
 +
|Марка автомобиля
 +
|-
 +
|car_model
 +
|Строка
 +
|Модель автомобиля
 +
|-
 +
|car_color
 +
|Строка
 +
|Цвет автомобиля
 +
|-
 +
|car_number
 +
|Строка
 +
|Государственный номер автомобиля
 +
|-
 +
|confirmed
 +
|Строка
 +
|Состояние подтвержденности заказа водителем или оператором.
 +
 
 +
Может принимать значения:
 +
 
 +
• "not_confirmed" — не подтверждено
  
Ответ:
+
• "confirmed_by_driver" — заказ принят водителем
  
{
+
"confirmed_by_oper" — заказ подтвержден оператором
  "code":0,
+
|-
  "descr":"OK",
+
|crew_coords
  "data":{
+
|Массив
    "order_id":1,
+
|Координаты экипажа
    "state_id":12,
+
|-
    "state_kind":"car_at_place",
+
|&bull; lat
    "crew_id":1,
+
|Дробное
    "prior_crew_id":0,
+
|Широта
    "driver_id":2,
+
|-
    "car_id":3,
+
|&bull; lon
    "server_time_offset:0,
+
|Дробное
    "start_time":"20130117125641",
+
|Долгота
    "source_time":"20130117132617",
+
|-
    "finish_time":"20130117130343",
+
|order_params
    "source":"30 Лет Победы ул. \/Ижевск\/, 4Б",
+
|Массив
    "source_lat":56.863613,
+
|Массив параметров заказа экипажа. Устарело. Рекомендуется использовать параметр attribute_values
    "source_lon":53.186539,
+
|-
    "destination":"Кирова ул. \/Ижевск\/, 56",
+
|&bull;
    "destination_lat":56.862202,
+
|Целое
    "destination_lon":53.187485,
+
|ИД параметра заказа
    "stops":[
+
|-
      {
+
|creation_way
        "address":"30 Лет Победы ул. \/Ижевск\/, 8",
+
|Строка
        "lat":56.863388,
+
|Способ создания заказа. Может принимать значения:
        "lon":53.184269
+
 
      }
+
"operator" — заказ создан оператором
    ],
+
 
    "customer":"Слепаков",
+
"sms" — заказ создан через смс
    "passenger":"Слепаков",
+
 
    "phone":"8800",
+
"market" — заказ из биржи
    "client_id":1,
+
 
    "client_employee_id":1,
+
"common_api" — заказ создан через api
    "order_crew_group_id":1,
+
 
    "tariff_id":1,
+
"t_api" — заказ создан через api
    "car_mark":"Ауди",
+
 
    "car_model":"Q7",
+
"taxophone" — заказ создан через таксофон с телефона
    "car_color":"черный",
+
 
    "car_number":"А777АА", 
+
"driver" — заказ создан водителем
    "confirmed":"confirmed_by_oper",
+
 
    "crew_coords": {
+
"daily_order" — ежедневный заказ
        "lat": 56.833981,
+
 
        "lon": 53.220249
+
"taxophone_web" — заказ создан через таксофон с сайта
    },
+
 
    "order_params":[
+
"unknown" — неизвестный
      1,
+
|-
      2,
+
|is_prior
      5
+
|true или false
    ],
+
|Предварительный заказ
    "creation_way":"operator",
+
|-
    "is_prior":true,
+
|is_really_prior
    "is_really_prior":false,
+
|true или false
    "email":"mail@mail.ru",
+
|Предварительный заказ на вкладке "Предварительные"
    "prior_to_current_before_minutes":30,
+
|-
    "flight_number":"A-0501/123",
+
|email
    "sum":50.5,
+
|Строка
    "total_sum":80,
+
|Email для уведомлений
    "attribute_values": [
+
|-
        {
+
|prior_to_current_before_minutes
              "id": 1,
+
|Целое
              "bool_value": true
+
|Время перехода из предварительного в текущие заказы, мин
        },
+
|-
        {
+
|flight_number
              "id": 2,
+
|Строка
              "num_value": 1
+
|Номер рейса
        },
+
|-
        {
+
|sum
              "id": 3,
+
|Дробное
              "num_value": 10
+
|Сумма без скидки
        },
+
|-
        {
+
|total_sum
              "id": 4,
+
|Дробное
              "str_value": "строка"
+
|Итоговая сумма заказа
        }
+
|-
    ],
+
|cash_sum
    "bill":
+
|Дробное
    [
+
|Сумма наличными
      {
 
        "code":"BOARDING",
 
        "text":"Посадка",
 
        "value":"",
 
        "sum":"20,00"
 
      },
 
      {
 
        "code":"TRIP_TIME",
 
        "text":"Общее время",
 
        "value":"0:00:00",
 
        "sum":""
 
      },
 
      {
 
        "code":"TRIP_DIST",
 
        "text":"Общее расстояние",
 
        "value":"0,00 км",
 
        "sum":""
 
      },
 
      {
 
        "code":"BEFORE_DISC",
 
        "text":"Сумма без скидки",
 
        "value":"",
 
        "sum":"20,00"
 
      },
 
      {
 
        "code":"AFTER_DISC",
 
        "text":"Сумма со скидкой",
 
        "value":"",
 
        "sum":"20,00"
 
      },
 
      {
 
        "code":"MINIMUM",
 
        "text":"Минималка",
 
        "value":"",
 
        "sum":"60,00"
 
      }
 
    ]
 
  }
 
}
 
</pre>
 
 
 
=== Создание задачи СМС серверу ===
 
 
 
Метод: POST
 
 
 
Название запроса: send_sms
 
 
 
Параметры:
 
 
 
{|
 
!Параметры
 
!Тип
 
!Описание
 
 
|-
 
|-
!colspan="3"|Обязательные параметры
+
|cashless_sum
 +
|Дробное
 +
|Сумма безналичными
 
|-
 
|-
|phone
+
|bonus_sum
|Строка, <= 30 символов
+
|Дробное
|Номер телефона
+
|Сумма бонусами
 
|-
 
|-
|message
+
|bank_card_sum
 +
|Дробное
 +
|Сумма банковской картой
 +
|-
 +
|attribute_values
 +
|Массив
 +
|Массив значений атрибутов
 +
|-
 +
|&bull; id
 +
|Целое
 +
|Идентификатор атрибута
 +
|-
 +
|&bull; bool_value
 +
|true или false
 +
|Значение, если тип атрибута «Логический»
 +
|-
 +
|&bull; num_value
 +
|Дробное
 +
|Значение, если тип атрибута:
 +
* «Число» (непосредственное значение)
 +
* «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
 +
* «Перечисляемый» (значение выбранного элемента перечисления)
 +
* «Дата» и «Дата/время» (Unix-время, всегда целое число)
 +
|-
 +
|&bull; str_value
 +
|Строка
 +
|Значение, если тип атрибута «Строка»
 +
|-
 +
|bill
 +
|Массив
 +
|Чек TMDriver. Данный узел выводится только, если по заказу есть чек
 +
|-
 +
|&bull; code
 +
|Строка
 +
|Код элемента расчета
 +
|-
 +
|&bull; text
 +
|Строка
 +
|Наименование элемента расчета
 +
|-
 +
|&bull; value
 +
|Строка
 +
|Значение элемента расчета (количество)
 +
|-
 +
|&bull; sum
 +
|Строка
 +
|Стоимость элемента расчета
 +
|-
 +
|fact_route
 +
|Массив
 +
|Фактический маршрут по заказу, выводится только если поле fact_route передали в списке фильтра полей fields
 +
|-
 +
|&bull; lat
 +
|Дробное
 +
|Широта точки маршрута
 +
|-
 +
|&bull; lon
 +
|Дробное
 +
|Долгота точки маршрута
 +
|-
 +
|&bull; time
 +
|ГГГГММДДччммсс
 +
|Время данной точки
 +
|-
 +
|&bull; speed
 +
|Целое
 +
|Скорость в данный момент, км/ч
 +
|-
 +
|&bull; direction
 +
|Целое
 +
|Направление движения, градусы (0 - север, 90 - восток, 180 - юг, 270 - запад)
 +
|-
 +
|is_auction
 +
|true или false
 +
|Признак заказа-аукциона
 +
|-
 +
|payment_pay_system
 
|Строка
 
|Строка
|Текст СМС
+
|Тип платежной системы ("card", "gpay", "apple_pay", "qr", "sber_pay", либо пусто, если не используется).
 
|}
 
|}
  
Специальные возвращаемые коды: нет
+
Пример:
 
 
Возвращаемые данные в случае успешного выполнения запроса: нет
 
 
 
Пример:
 
  
 
<pre>
 
<pre>
Запрос:
+
Запрос:  
  
POST /common_api/1.0/send_sms
+
GET https://ip:port/common_api/1.0/get_order_state?order_id=1 
Content-Type: application/x-www-form-urlencoded
+
Signature: <...>
Content-Length: 33
 
  
Signature: <...>
+
Ответ:  
 
 
message=SMSText&phone=89050057216
 
 
 
Ответ:
 
  
 
{
 
{
 
   "code":0,
 
   "code":0,
 
   "descr":"OK",
 
   "descr":"OK",
   "data":{}
+
   "data":{
}
+
    "order_id":1,
</pre>
+
    "state_id":12,
 
+
    "state_kind":"car_at_place",
=== Проверка авторизации ===
+
    "crew_id":1,
 
+
    "prior_crew_id":0,
Метод: GET
+
    "driver_id":2,
 
+
    "car_id":3,
Название запроса: check_authorization
+
    "server_time_offset:0,
 
+
    "start_time":"20130117125641",
Параметры:
+
    "source_time":"20130117132617",
 
+
    "finish_time":"20130117130343",
{|
+
    "source":"30 Лет Победы ул. \/Ижевск\/, 4Б",
!Параметры
+
    "source_lat":56.863613,
!Тип
+
    "source_lon":53.186539,
!Описание
+
    "destination":"Кирова ул. \/Ижевск\/, 56",
|-
+
    "destination_lat":56.862202,
!colspan="3"|Обязательные параметры
+
    "destination_lon":53.187485,
|-
+
    "stops":[
|login
+
      {
|Строка, <= 60 символов
+
        "address":"30 Лет Победы ул. \/Ижевск\/, 8",
|Логин
+
        "lat":56.863388,
|-
+
        "lon":53.184269
|password
+
      }
|Строка, <= 60 символов
+
    ],
|Пароль
+
    "trip_distance":10.5,
|}
+
    "trip_time":20,
 
+
    "customer":"Слепаков",
Специальные возвращаемые коды:
+
    "passenger":"Слепаков",
{|
+
    "phone":"8800",
!Код
+
    "client_id":1,
!Описание
+
    "client_employee_id":1,
|-
+
    "order_crew_group_id":1,
|100
+
    "tariff_id":1,
|Не найден клиент с логином LOGIN и/или неверный пароль
+
    "car_mark":"Ауди",
|}
+
    "car_model":"Q7",
 
+
    "car_color":"черный",
Возвращаемые данные в случае успешного выполнения запроса:
+
    "car_number":"А777АА", 
{|
+
    "confirmed":"confirmed_by_oper",
!Параметр
+
    "crew_coords": {
!Тип
+
        "lat": 56.833981,
!Описание
+
        "lon": 53.220249
|-
+
    },
|client_id
+
    "order_params":[
|Целое
+
      1,
|ИД клиента
+
      2,
|}
+
      5
 
+
    ],
Пример:
+
    "creation_way":"operator",
 
+
    "is_prior":true,
<pre>
+
    "is_really_prior":false,
Запрос:
+
    "email":"mail@mail.ru",
 
+
    "prior_to_current_before_minutes":30,
GET https://ip:port/common_api/1.0/check_authorization?login=LOGIN&password=PASSWORD
+
    "flight_number":"A-0501/123",
 
+
    "sum":50.5,
Signature: <...>
+
    "total_sum":80,
 +
    "cash_sum":20.1,
 +
    "cashless_sum":10,
 +
    "bonus_sum":5.2,
 +
    "bank_card_sum":15,
 +
    "attribute_values": [
 +
        {
 +
              "id": 1,
 +
              "bool_value": true
 +
        },
 +
        {
 +
              "id": 2,
 +
              "num_value": 1
 +
        },
 +
        {
 +
              "id": 3,
 +
              "num_value": 10
 +
        },
 +
        {
 +
              "id": 4,
 +
              "str_value": "строка"
 +
        }
 +
    ],
 +
    "bill":
 +
    [
 +
      {
 +
        "code":"BOARDING",
 +
        "text":"Посадка",
 +
        "value":"",
 +
        "sum":"20,00"
 +
      },
 +
      {
 +
        "code":"TRIP_TIME",
 +
        "text":"Общее время",
 +
        "value":"0:00:00",
 +
        "sum":""
 +
      },
 +
      {
 +
        "code":"TRIP_DIST",
 +
        "text":"Общее расстояние",
 +
        "value":"0,00 км",
 +
        "sum":""
 +
      },
 +
      {
 +
        "code":"BEFORE_DISC",
 +
        "text":"Сумма без скидки",
 +
        "value":"",
 +
        "sum":"20,00"
 +
      },
 +
      {
 +
        "code":"AFTER_DISC",
 +
        "text":"Сумма со скидкой",
 +
        "value":"",
 +
        "sum":"20,00"
 +
      },
 +
      {
 +
        "code":"MINIMUM",
 +
        "text":"Минималка",
 +
        "value":"",
 +
        "sum":"60,00"
 +
      }
 +
    ],
 +
    "fact_route":
 +
    [
 +
      {
 +
        "lat":11.111111,
 +
        "lon":22.222222,
 +
        "time":"20130117132617",
 +
        "speed":123,
 +
        "direction":0
 +
      }
 +
    ],
 +
    "is_auction":false,
 +
    "payment_pay_system": "qr"
 +
  }
 +
}
 +
</pre>
  
Ответ:
+
=== Создание задачи СМС серверу ===
 +
 
 +
Метод: POST
 +
 
 +
Название запроса: send_sms
 +
 
 +
Параметры:
 +
 
 +
{|
 +
!Параметры
 +
!Тип
 +
!Описание
 +
|-
 +
!colspan="3"|Обязательные параметры
 +
|-
 +
|phone
 +
|Строка, <= 30 символов
 +
|Номер телефона
 +
|-
 +
|message
 +
|Строка
 +
|Текст СМС
 +
|}
 +
 
 +
Специальные возвращаемые коды: нет
 +
 
 +
Возвращаемые данные в случае успешного выполнения запроса: нет
 +
 
 +
Пример:
 +
 
 +
<pre>
 +
Запрос:
 +
 
 +
POST /common_api/1.0/send_sms
 +
Content-Type: application/x-www-form-urlencoded
 +
Content-Length: 33
 +
 
 +
Signature: <...>
 +
 
 +
message=SMSText&phone=89050057216
 +
 
 +
Ответ:
  
 
{
 
{
 
   "code":0,
 
   "code":0,
 
   "descr":"OK",
 
   "descr":"OK",
   "data":{
+
   "data":{}
    "client_id":131
 
}
 
 
}
 
}
 
</pre>
 
</pre>
  
=== Регистрация клиента ===
+
=== Проверка авторизации ===
  
Метод: POST
+
Метод: GET
  
Название запроса: register_client
+
Название запроса: check_authorization
  
 
Параметры:
 
Параметры:
Строка 5334: Строка 5779:
 
!colspan="3"|Обязательные параметры
 
!colspan="3"|Обязательные параметры
 
|-
 
|-
|name
+
|login  
|Строка, <= 60 символов
 
|ФИО
 
|-
 
|login
 
 
|Строка, <= 60 символов
 
|Строка, <= 60 символов
 
|Логин
 
|Логин
Строка 5345: Строка 5786:
 
|Строка, <= 60 символов
 
|Строка, <= 60 символов
 
|Пароль
 
|Пароль
 +
|}
 +
 +
Специальные возвращаемые коды:
 +
{|
 +
!Код
 +
!Описание
 
|-
 
|-
|phones
+
|100
 +
|Не найден клиент с логином LOGIN и/или неверный пароль
 +
|}
 +
 
 +
Возвращаемые данные в случае успешного выполнения запроса:
 +
{|
 +
!Параметр
 +
!Тип
 +
!Описание
 +
|-
 +
|client_id
 +
|Целое
 +
|ИД клиента
 +
|}
 +
 
 +
Пример:
 +
 
 +
<pre>
 +
Запрос:
 +
 
 +
GET https://ip:port/common_api/1.0/check_authorization?login=LOGIN&password=PASSWORD
 +
 
 +
Signature: <...>
 +
 
 +
Ответ:
 +
 
 +
{
 +
  "code":0,
 +
  "descr":"OK",
 +
  "data":{
 +
    "client_id":131
 +
}
 +
}
 +
</pre>
 +
 
 +
=== Регистрация клиента ===
 +
 
 +
Метод: POST
 +
 
 +
Название запроса: register_client
 +
 
 +
Параметры:
 +
 
 +
{|
 +
!Параметры
 +
!Тип
 +
!Описание
 +
|-
 +
!colspan="3"|Обязательные параметры
 +
|-
 +
|name
 +
|Строка, <= 60 символов
 +
|ФИО
 +
|-
 +
|login
 +
|Строка, <= 60 символов
 +
|Логин
 +
|-
 +
|password
 +
|Строка, <= 60 символов
 +
|Пароль
 +
|-
 +
|phones
 
|Строка
 
|Строка
 
|Номера телефонов (через запятую)
 
|Номера телефонов (через запятую)
Строка 5408: Строка 5917:
 
|103
 
|103
 
|Клиент указанный в качестве родителя с ИД=PARENT_ID не найден  
 
|Клиент указанный в качестве родителя с ИД=PARENT_ID не найден  
 +
|-
 +
|109
 +
|Пароль клиента не соответствует политике паролей
 
|}
 
|}
  
Строка 5444: Строка 5956:
 
</pre>
 
</pre>
  
=== Запрос информации по клиенту ===
+
=== Регистрация клиента 2 ===
 +
Метод: POST
  
Метод: GET
+
Название запроса: register_client2
  
Название запроса: get_client_info
+
Версия ТМ: 3.12
  
Параметры:
+
Параметры в формате JSON:
  
 
{|
 
{|
Строка 5459: Строка 5972:
 
!colspan="3"|Обязательные параметры
 
!colspan="3"|Обязательные параметры
 
|-
 
|-
|client_id
+
|name
|Целое
+
|Строка, <= 60 символов
|ИД клиента
+
|ФИО
|}
+
|-
 
+
|login
Специальные возвращаемые коды:
+
|Строка, <= 60 символов
{|
+
|Логин
!Код
+
|-
!Описание
+
|password
 +
|Строка, <= 60 символов
 +
|Пароль
 +
|-
 +
|phones
 +
|Массив
 +
|Массив телефонов клиента
 +
|-
 +
|&bull; phone
 +
|Строка
 +
|Номер телефона
 +
|-
 +
|&bull; is_default
 +
|true или false
 +
|Признак основного телефона
 
|-
 
|-
|100
+
!colspan="4"|Необязательные параметры
|Не найден клиент ИД=CLIENT_ID
 
|}
 
 
 
Возвращаемые данные в случае успешного выполнения запроса:
 
{|
 
!Параметр
 
!Тип
 
!Описание
 
 
|-
 
|-
|client_id
+
|client_group_id
 
|Целое
 
|Целое
|ИД клиента
+
|ИД группы клиента
 
|-
 
|-
 
|parent_id
 
|parent_id
Строка 5487: Строка 6006:
 
|ИД клиента-родителя
 
|ИД клиента-родителя
 
|-
 
|-
|name
+
|address
 
|Строка
 
|Строка
|ФИО
+
|Домашний адрес
 
|-
 
|-
|number
+
|birthday
|Строка
+
|ГГГГММДДччммсс
|Номер договора
+
|Дата рождения
 
|-
 
|-
|address
+
|gender
 
|Строка
 
|Строка
|Домашний адрес
+
|Пол. Может принимать значения:  
|-
+
• "male" -  мужской
|gender
 
|Строка
 
|Пол. Может принимать значения:
 
• "" - не указан
 
 
 
• "male" -  мужской
 
  
 
• "female" - женский
 
• "female" - женский
 
|-
 
|-
|birthday
+
|email
|ДД.ММ.ГГГГ
 
|Дата рождения
 
|-
 
|phones 
 
|Массив
 
|Массив телефонов клиента
 
|-
 
|&bull; phone
 
 
|Строка
 
|Строка
|Номер телефона клиента
+
|E-mail
 
|-
 
|-
|balance
+
|use_email_informing
|Дробное
+
|true или false
|Баланс
+
|Использовать E-mail для отправки уведомлений по заказу
 
|-
 
|-
|bonus_balance
+
|comment
|Дробное
 
|Бонусный баланс
 
|-
 
|login 
 
 
|Строка
 
|Строка
|Логин
+
|Комментарий
 
|-
 
|-
|password
+
|use_own_account
|Строка
+
|true или false
|Пароль
+
|Использовать собственный счет для оплаты заказов
 
|-
 
|-
|client_group_id
+
|attribute_values
|Целое
+
|Массив
|ИД группы клиента
+
|Массив значений атрибутов
 
|-
 
|-
|tariff_id
+
|&bull; id
 
|Целое
 
|Целое
|ИД тарифа клиента или группы клиентов
+
|Идентификатор атрибута
 
|-
 
|-
|prize_tariff_id
+
|&bull; bool_value
|Целое
+
|true или false
|ИД призового тарифа клиента или группы клиентов
+
|Значение, если тип атрибута «Логический»
 
|-
 
|-
|tariff_shift_id
+
|&bull; num_value
|Целое
+
|Дробное
|ИД смены тарифов клиента или группы клиентов
+
|Значение, если тип атрибута:
 +
* «Число» (непосредственное значение)
 +
* «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
 +
* «Перечисляемый» (значение выбранного элемента перечисления)
 +
* «Дата» и «Дата/время» (Unix-время, всегда целое число)
 
|-
 
|-
|discount_id
+
|&bull; str_value
|Целое
+
|Строка
|ИД скидки клиента или группы клиентов
+
|Значение, если тип атрибута «Строка»
 +
|}
 +
 
 +
Специальные возвращаемые коды:
 +
{|
 +
!Код
 +
!Описание
 
|-
 
|-
|prize_discount_id
+
|100
|Целое
+
|Дублирование номера телефона=PHONE в списке
|ИД призовой скидки клиента или группы клиентов
 
 
|-
 
|-
|min_balance
+
|101
|Дробное
+
|Клиент с логином=LOGIN уже существует
|Порог, ниже которого не может опускаться баланс
 
 
|-
 
|-
|min_balance_for_use_cashless
+
|102
|Дробное
+
|Группа клиента с ИД=CLIENT_GROUP не найдена
|Минимальный баланс для использования безналичного счета
 
 
|-
 
|-
|min_bonus_balance_for_use_bonus
+
|103
|Дробное
+
|Клиент указанный в качестве родителя с ИД=PARENT_ID не найден
|Минимальный баланс для использования бонусного счета
 
 
|-
 
|-
|is_locked
+
|105
|true или false
+
|Основной телефон может быть только один
|Клиент заблокирован
 
 
|-
 
|-
|lock_description
+
|106
|Строка
+
|Клиент должен иметь основной телефон
|Причина блокировки
 
 
|-
 
|-
|use_cashless
+
|107
|true или false
+
|Атрибут с ИД=ID не найден
|Признак использования безналичного расчета по умолчанию
 
 
|-
 
|-
|remain_prize
+
|108
|Целое
+
|Атрибут с ИД=ID не может быть привязан к клиенту
|Сколько заказов осталось до призового
 
 
|-
 
|-
|email
+
|109
|Строка
+
|Пароль клиента не соответствует политике паролей
|E-mail
+
|}
 +
 
 +
Возвращаемые данные в случае успешного выполнения запроса:
 +
{|
 +
!Параметр
 +
!Тип
 +
!Описание
 
|-
 
|-
|use_email_informing
+
|client_id
|true или false
 
|Использовать E-mail для отправки уведомлений по заказу
 
|-
 
|default_crew_group
 
 
|Целое
 
|Целое
|Группа экипажей по умолчанию
+
|ИД созданного клиента
 +
|}
 +
 
 +
Пример:
 +
 
 +
<pre>
 +
Запрос:
 +
 
 +
POST https://ip:port/common_api/1.0/register_client2 HTTP/1.1
 +
Signature: <...>
 +
Content-Type: application/json
 +
Content-Length: <...>
 +
 
 +
{
 +
  "name":"NAME",
 +
  "login":"LOGIN",
 +
  "password":"PASSWORD",
 +
  "phones":[
 +
    {
 +
      "phone":"88",
 +
      "is_default":true
 +
    },
 +
    {
 +
      "phone":"99",
 +
      "is_default":false
 +
    }
 +
  ],
 +
  "address":"ADDRESS",
 +
  "gender":"male",
 +
  "birthday":"20000101000000",
 +
  "client_group_id":1,
 +
  "parent_id":10,
 +
  "email":"mail@ya.ru",
 +
  "use_email_informing":true,
 +
  "comment":"TEXT",
 +
  "use_own_account":false,
 +
  "attribute_values":[
 +
    {
 +
      "id":5,
 +
      "bool_value":true
 +
    },
 +
    {
 +
      "id":7,
 +
      "num_value":10
 +
    },
 +
    {
 +
      "id":9,
 +
      "str_value":"TEST"
 +
    }
 +
  ]
 +
}
 +
 
 +
Ответ:
 +
 
 +
{
 +
  "code":0,
 +
  "descr":"OK",
 +
  "data":{
 +
    "client_id":140
 +
  }
 +
}
 +
 
 +
</pre>
 +
 
 +
=== Запрос информации по клиенту ===
 +
 
 +
Метод: GET
 +
 
 +
Название запроса: get_client_info
 +
 
 +
Параметры:
 +
 
 +
{|
 +
!Параметры
 +
!Тип
 +
!Описание
 
|-
 
|-
|employees
+
!colspan="3"|Обязательные параметры
|Массив
 
|Массив сотрудников клиента
 
 
|-
 
|-
|&bull; client_id
+
|client_id
 
|Целое
 
|Целое
|ИД клиента-сотрудника
+
|ИД клиента
 
|-
 
|-
|&bull; parent_id
+
!colspan="3"|Необязательные параметры
|Целое
 
|ИД родителя клиента-сотрудника
 
 
|-
 
|-
|&bull; name
+
|fields
 
|Строка
 
|Строка
|ФИО клиента-сотрудника
+
|Список возвращаемых полей через запятую. Для полей списка сотрудников, запрашиваемого клиента, названия начинаются с "employees.", например: "employees.name"
|-
+
|}
|&bull; number
+
 
 +
Специальные возвращаемые коды:
 +
{|
 +
!Код
 +
!Описание
 +
|-
 +
|100
 +
|Не найден клиент ИД=CLIENT_ID
 +
|}
 +
 
 +
Возвращаемые данные в случае успешного выполнения запроса:
 +
{|
 +
!Параметр
 +
!Тип
 +
!Описание
 +
|-
 +
|client_id
 +
|Целое
 +
|ИД клиента
 +
|-
 +
|parent_id
 +
|Целое
 +
|ИД клиента-родителя
 +
|-
 +
|name
 
|Строка
 
|Строка
|Номер договора клиента-сотрудника
+
|ФИО
 
|-
 
|-
|&bull; address
+
|number
 
|Строка
 
|Строка
|Домашний адрес клиента-сотрудника
+
|Номер договора
 
|-
 
|-
|&bull; gender
+
|address
 
|Строка
 
|Строка
|Пол клиента-сотрудника. Может принимать значения:
+
|Домашний адрес
 +
|-
 +
|gender
 +
|Строка
 +
|Пол. Может принимать значения:
 
• "" - не указан
 
• "" - не указан
  
Строка 5633: Строка 6237:
 
• "female" - женский
 
• "female" - женский
 
|-
 
|-
|&bull; birthday
+
|birthday  
|ДД.ММ.ГГГГ
+
|ДД.ММ.ГГГГ  
|Дата рождения клиента-сотрудника
+
|Дата рождения
 
|-
 
|-
|&bull; phones
+
|phones
 
|Массив
 
|Массив
|Массив телефонов клиента-сотрудника
+
|Массив телефонов клиента
 
|-
 
|-
|&bull;&bull; phone
+
|&bull; phone
 
|Строка
 
|Строка
|Номер телефона клиента-сотрудника
+
|Номер телефона клиента
 
|-
 
|-
|&bull; balance
+
|balance  
 
|Дробное
 
|Дробное
|Баланс клиента-сотрудника
+
|Баланс
 
|-
 
|-
|&bull; bonus_balance
+
|bonus_balance  
 
|Дробное
 
|Дробное
|Бонусный баланс клиента-сотрудника
+
|Бонусный баланс
 
|-
 
|-
|&bull; login
+
|login
 
|Строка
 
|Строка
|Логин клиента-сотрудника
+
|Логин
 
|-
 
|-
|&bull; password
+
|password  
 
|Строка
 
|Строка
|Пароль клиента-сотрудника
+
|Пароль
 
|-
 
|-
|&bull; client_group_id
+
|client_group_id
 
|Целое
 
|Целое
|ИД группы клиента клиента-сотрудника
+
|ИД группы клиента
 
|-
 
|-
|&bull; tariff_id
+
|tariff_id
 
|Целое
 
|Целое
|ИД тарифа клиента или группы клиентов клиента-сотрудника
+
|ИД тарифа клиента или группы клиентов
 
|-
 
|-
|&bull; prize_tariff_id
+
|prize_tariff_id
 
|Целое
 
|Целое
|ИД призового тарифа клиента-сотрудника или группы клиентов
+
|ИД призового тарифа клиента или группы клиентов
 
|-
 
|-
|&bull; tariff_shift_id
+
|tariff_shift_id
 
|Целое
 
|Целое
|ИД смены тарифов клиента-сотрудника или группы клиентов
+
|ИД смены тарифов клиента или группы клиентов
 
|-
 
|-
|&bull; discount_id
+
|discount_id
 
|Целое
 
|Целое
|ИД скидки клиента-сотрудника или группы клиентов
+
|ИД скидки клиента или группы клиентов
 
|-
 
|-
|&bull; prize_discount_id
+
|prize_discount_id
 
|Целое
 
|Целое
|ИД призовой скидки клиента-сотрудника или группы клиентов
+
|ИД призовой скидки клиента или группы клиентов
 
|-
 
|-
|&bull; min_balance
+
|min_balance
 
|Дробное
 
|Дробное
|Порог, ниже которого не может опускаться баланс клиента-сотрудника
+
|Порог, ниже которого не может опускаться баланс
 
|-
 
|-
|&bull; min_balance_for_use_cashless
+
|min_balance_for_use_cashless
 
|Дробное
 
|Дробное
|Минимальный баланс для использования безналичного счета клиента-сотрудника
+
|Минимальный баланс для использования безналичного счета
 
|-
 
|-
|&bull; min_bonus_balance_for_use_bonus
+
|min_bonus_balance_for_use_bonus
 
|Дробное
 
|Дробное
|Минимальный баланс для использования бонусного счета клиента-сотрудника
+
|Минимальный баланс для использования бонусного счета
 
|-
 
|-
|&bull; is_locked
+
|is_locked
 
|true или false
 
|true или false
|Клиент-сотрудник заблокирован
+
|Клиент заблокирован
 
|-
 
|-
|&bull; lock_description
+
|lock_description
 
|Строка
 
|Строка
|Причина блокировка клиента-сотрудника
+
|Причина блокировки
 +
|-
 +
|use_cashless_account
 +
|true или false
 +
|Признак использования безналичного счета
 +
|-
 +
|use_cashless
 +
|true или false
 +
|Признак использования безналичного расчета по умолчанию. Имеет смысл только при use_cashless_account = true
 
|-
 
|-
|&bull; use_cashless
+
|no_cash_payment
 
|true или false
 
|true или false
|Признак использования безналичного расчета по умолчанию для клиента-сотрудника
+
|Признак запрета использования наличных расчетов. Имеет смысл только при use_cashless_account = true и use_cashless = true
 
|-
 
|-
|&bull; remain_prize
+
|remain_prize
 
|Целое
 
|Целое
 
|Сколько заказов осталось до призового
 
|Сколько заказов осталось до призового
 
|-
 
|-
|&bull; email
+
|email
 
|Строка
 
|Строка
|E-mail клиента-сотрудника
+
|E-mail
 
|-
 
|-
|&bull; use_email_informing
+
|use_email_informing
 
|true или false
 
|true или false
 
|Использовать E-mail для отправки уведомлений по заказу
 
|Использовать E-mail для отправки уведомлений по заказу
 
|-
 
|-
|&bull; default_crew_group
+
|default_crew_group
 
|Целое
 
|Целое
 
|Группа экипажей по умолчанию
 
|Группа экипажей по умолчанию
 +
|-
 +
|use_own_account
 +
|true или false
 +
|Использовать собственный счет для оплаты заказа
 +
|-
 +
|comment
 +
|Строка
 +
|Комментарий
 +
|-
 +
|employees
 +
|Массив
 +
|Массив сотрудников клиента. Поля аналогичны полям основного клиента, только у сотрудников отсутствует поле employees
 +
|-
 +
|accounts
 +
|Массив
 +
|Массив счетов клиента. Для сотрудников счета возвращаются, только если их явно запросили в фильтре полей "employees.accounts"
 +
|-
 +
|&bull; account_kind
 +
|Целое
 +
|Тип счета:
 +
* 0 - Основной счет
 +
* 1- Бонусный счет
 +
* Остальные - нестандартные счета
 +
|-
 +
|&bull; balance
 +
|Дробное
 +
|Баланс счета клиента
 +
|-
 +
|&bull; balance_with_children
 +
|Дробное
 +
|Баланс счета клиента с учетом вложенных клиентов
 +
|-
 +
|attribute_values
 +
|Массив
 +
|Массив значений атрибутов. Возвращается, только если явно запросили в фильтре полей "attribute_values" или "employees.attribute_values" для сотрудников
 +
|-
 +
|&bull; id
 +
|Целое
 +
|Идентификатор атрибута
 +
|-
 +
|&bull; bool_value
 +
|true или false
 +
|Значение, если тип атрибута «Логический»
 +
|-
 +
|&bull; num_value
 +
|Дробное
 +
|Значение, если тип атрибута:
 +
* «Число» (непосредственное значение)
 +
* «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
 +
* «Перечисляемый» (значение выбранного элемента перечисления)
 +
* «Дата» и «Дата/время» (Unix-время, всегда целое число)
 +
|-
 +
|&bull; str_value
 +
|Строка
 +
|Значение, если тип атрибута «Строка»
 
|}
 
|}
  
Строка 5738: Строка 6405:
  
 
{
 
{
   "code":0,
+
   "code": 0,
   "descr":"OK",
+
   "descr": "OK",
   "data":
+
   "data": {
  {
+
     "client_id": 20,
     "client_id":20,
+
     "parent_id": 0,
     "parent_id":0,
+
     "name": "Юр. лицо1",
     "name":"Юр. лицо1",
+
     "number": "111",
     "number":"111",
+
     "address": "Адрес Юр. лицо1",
     "address":"Адрес Юр. лицо1",
+
     "gender": "",
     "gender":"",
+
     "birthday": "22.01.2016",
     "birthday":"22.01.2016",
+
     "phones": [
     "phones":
 
    [
 
 
       "105",
 
       "105",
 
       "123456789",
 
       "123456789",
 
       "100"
 
       "100"
 
     ],
 
     ],
     "balance":10,
+
     "balance": 10,
     "bonus_balance":333,
+
     "bonus_balance": 333,
     "login":"111",
+
     "login": "111",
     "password":"111",
+
     "password": "111",
     "client_group_id":1,
+
     "client_group_id": 1,
     "tariff_id":39,
+
     "tariff_id": 39,
     "prize_tariff_id":0,
+
     "prize_tariff_id": 0,
     "tariff_shift_id":0,
+
     "tariff_shift_id": 0,
     "discount_id":2,
+
     "discount_id": 2,
     "prize_discount_id":0,
+
     "prize_discount_id": 0,
     "min_balance":0,
+
     "min_balance": 0,
     "min_balance_for_use_cashless":null,
+
     "min_balance_for_use_cashless": null,
     "min_bonus_balance_for_use_bonus":null,
+
     "min_bonus_balance_for_use_bonus": null,
     "is_locked":false,
+
     "is_locked": false,
     "lock_description":"",
+
     "lock_description": "",
     "use_cashless":true,
+
    "use_cashless_account": true,
     "remain_prize":0,
+
     "use_cashless": true,
     "email":"Юр. лицо1@ss.ru",
+
     "remain_prize": 0,
     "use_email_informing":true,
+
     "email": "Юр. лицо1@ss.ru",
     "default_crew_group":6,
+
     "use_email_informing": true,
     "employees":
+
     "default_crew_group": 6,
     [
+
     "comment": "Сотрудник СВР. Использовать максимальные скидки",
 +
     "employees": [
 
       {
 
       {
         "client_id":323,
+
         "client_id": 323,
         "parent_id":20,
+
         "parent_id": 20,
         "name":"Сотрудник1",
+
         "name": "Сотрудник1",
         "number":"111",
+
         "number": "111",
         "address":"Адрес Сотрудник1",
+
         "address": "Адрес Сотрудник1",
         "gender":"",
+
         "gender": "",
         "birthday":null,
+
         "birthday": null,
         "phones":
+
         "phones": [
        [
 
 
           "11221122112211"
 
           "11221122112211"
 
         ],
 
         ],
         "balance":0,
+
         "balance": 0,
         "bonus_balance":0,
+
         "bonus_balance": 0,
         "login":"",
+
         "login": "",
         "password":"",
+
         "password": "",
         "client_group_id":1,
+
         "client_group_id": 1,
         "tariff_id":17,
+
         "tariff_id": 17,
         "prize_tariff_id":0,
+
         "prize_tariff_id": 0,
         "tariff_shift_id":0,
+
         "tariff_shift_id": 0,
         "discount_id":2,
+
         "discount_id": 2,
         "prize_discount_id":0,
+
         "prize_discount_id": 0,
         "min_balance":0,
+
         "min_balance": 0,
         "min_balance_for_use_cashless":null,
+
         "min_balance_for_use_cashless": null,
         "min_bonus_balance_for_use_bonus":null,
+
         "min_bonus_balance_for_use_bonus": null,
         "is_locked":false,
+
         "is_locked": false,
         "lock_description":"",
+
         "lock_description": "",
         "use_cashless":true,
+
         "use_cashless": true,
         "remain_prize":0,
+
         "remain_prize": 0,
         "email":"Сотрудник1@ss.ru",
+
         "email": "Сотрудник1@ss.ru",
         "use_email_informing":true,
+
         "use_email_informing": true,
         "default_crew_group":6
+
         "default_crew_group": 6,
       },
+
        "accounts": [
 +
          {
 +
            "account_kind": 0,
 +
            "balance": 400.00,
 +
            "balance_with_children": 0.00
 +
          },
 +
          {
 +
            "account_kind": 1,
 +
            "balance": 0.00,
 +
            "balance_with_children": 0.00
 +
          },
 +
          {
 +
            "account_kind": 1003,
 +
            "balance": 100.00,
 +
            "balance_with_children": 0.00
 +
          }
 +
        ],
 +
        "attribute_values": [
 +
          {
 +
            "id": 5,
 +
            "bool_value": true
 +
          },
 +
          {
 +
            "id": 4,
 +
            "bool_value": true
 +
          }
 +
        ]
 +
       }
 +
    ],
 +
    "accounts": [
 
       {
 
       {
         "client_id":322,
+
         "account_kind": 0,
        "parent_id":323,
+
         "balance": 2355.00,
        "name":"Сотрудник2",
+
         "balance_with_children": 2755.00
        "number":"111",
 
        "address":"Адрес Сотрудник1",
 
        "gender":"",
 
        "birthday":null,
 
        "phones":
 
        [],
 
         "balance":0,
 
        "bonus_balance":0,
 
        "login":"",
 
        "password":"",
 
        "client_group_id":1,
 
        "tariff_id":17,
 
        "prize_tariff_id":0,
 
        "tariff_shift_id":0,
 
        "discount_id":2,
 
        "prize_discount_id":0,
 
        "min_balance":0,
 
        "min_balance_for_use_cashless":null,
 
        "min_bonus_balance_for_use_bonus":null,
 
        "is_locked":false,
 
        "lock_description":"",
 
        "use_cashless":true,
 
         "remain_prize":1,
 
        "email":"Сотрудник2@ss.ru",
 
        "use_email_informing":true,
 
        "default_crew_group":6
 
 
       },
 
       },
 
       {
 
       {
         "client_id":321,
+
         "account_kind": 1,
        "parent_id":322,
+
         "balance": 0.00,
        "name":"Сотрудник3",
+
         "balance_with_children": 0.00
        "number":"111",
 
        "address":"Адрес Сотрудник1",
 
        "gender":"",
 
        "birthday":null,
 
        "phones":
 
        [],
 
         "balance":0,
 
         "bonus_balance":0,
 
        "login":"",
 
        "password":"",
 
        "client_group_id":1,
 
        "tariff_id":17,
 
        "prize_tariff_id":0,
 
        "tariff_shift_id":0,
 
        "discount_id":2,
 
        "prize_discount_id":0,
 
        "min_balance":0,
 
        "min_balance_for_use_cashless":null,
 
        "min_bonus_balance_for_use_bonus":null,
 
        "is_locked":false,
 
        "lock_description":"",
 
        "use_cashless":true,
 
        "remain_prize":1,
 
        "email":"Сотрудник3@ss.ru",
 
        "use_email_informing":true,
 
        "default_crew_group":4
 
 
       },
 
       },
 
       {
 
       {
         "client_id":326,
+
         "account_kind": 1003,
         "parent_id":20,
+
         "balance": -20.00,
         "name":"aaaaaaaasssssssssssssss",
+
         "balance_with_children": 80.00
        "number":"111",
+
      }
        "address":"Адрес Юр. лицо1",
+
    ],
        "gender":"",
+
    "attribute_values": [
        "birthday":null,
 
        "phones":
 
        [],
 
        "balance":0,
 
        "bonus_balance":0,
 
        "login":"",
 
        "password":"",
 
        "client_group_id":1,
 
        "tariff_id":39,
 
        "prize_tariff_id":0,
 
        "tariff_shift_id":0,
 
        "discount_id":2,
 
        "prize_discount_id":0,
 
        "min_balance":0,
 
        "min_balance_for_use_cashless":null,
 
        "min_bonus_balance_for_use_bonus":null,
 
        "is_locked":false,
 
        "lock_description":"",
 
        "use_cashless":true,
 
        "remain_prize":0,
 
        "email":"",
 
        "use_email_informing":false,
 
        "default_crew_group":6
 
      },
 
 
       {
 
       {
         "client_id":379,
+
         "id": 4,
         "parent_id":20,
+
         "bool_value": true
        "name":"Алексей",
 
        "number":"000379",
 
        "address":"Адрес Юр. лицо1",
 
        "gender":"",
 
        "birthday":"24.02.2020",
 
        "phones":
 
        [],
 
        "balance":0,
 
        "bonus_balance":0,
 
        "login":"aaaabbbbbb",
 
        "password":"111",
 
        "client_group_id":1,
 
        "tariff_id":39,
 
        "prize_tariff_id":0,
 
        "tariff_shift_id":0,
 
        "discount_id":2,
 
        "prize_discount_id":0,
 
        "min_balance":0,
 
        "min_balance_for_use_cashless":null,
 
        "min_bonus_balance_for_use_bonus":null,
 
        "is_locked":false,
 
        "lock_description":"",
 
        "use_cashless":true,
 
        "remain_prize":1,
 
        "email":"",
 
        "use_email_informing":false,
 
        "default_crew_group":6
 
 
       }
 
       }
 
     ]
 
     ]
Строка 5939: Строка 6530:
 
</pre>
 
</pre>
  
=== Изменение информации по клиенту ===
+
=== Запрос информации по клиентам ===
 +
Метод: GET
  
Метод: POST
+
Название запроса: get_clients_info
  
Название запроса: update_client_info
+
Версия ТМ: 3.5
  
 
Параметры:
 
Параметры:
 
 
{|
 
{|
 
!Параметры
 
!Параметры
Строка 5952: Строка 6543:
 
!Описание
 
!Описание
 
|-
 
|-
!colspan="3"|Обязательные параметры
+
!colspan="3"|Необязательные параметры
 +
|-
 +
|text
 +
|Строка
 +
|Текст для поиска по названию или по номеру договора клиента
 
|-
 
|-
|client_id
+
|max_clients_count
 
|Целое
 
|Целое
|ИД клиента
+
|Максимальное количество клиентов, которое надо вернуть. Если не указано, то 10.
 
|-
 
|-
!colspan="3"|Необязательные параметры
+
|client_group_id
 +
|Целое
 +
|Фильтр по группе клиентов
 
|-
 
|-
|name
+
|parent_id
|Строка, <= 60 символов
+
|Целое
|ФИО
+
|Фильтр по вышестоящему подразделению, возвращаются все подчиненные отделы и сотрудники на всю глубину иерархии
 
|-
 
|-
|login
+
|fields
|Строка, <= 60 символов
+
|Строка
|Логин
+
|Список возвращаемых полей через запятую. По умолчанию возвращаются поля "name" и "number". Поле "client_id" возвращается всегда
 +
|}
 +
 
 +
Специальные возвращаемые коды: Нет
 +
 
 +
Возвращаемые данные в случае успешного выполнения запроса:
 +
{|
 +
!Параметры
 +
!Тип
 +
!Описание
 
|-
 
|-
|password
+
|client_id
|Строка, <= 60 символов
+
|Целое
|Пароль
+
|ИД клиента
 
|-
 
|-
|phones
+
|name
 
|Строка
 
|Строка
|Номера телефонов (через запятую)
+
|Наименование
 
|-
 
|-
|address
+
|number
 
|Строка
 
|Строка
|Домашний адрес
+
|Номер договора
 
|-
 
|-
|birthday
+
|parent_id
|ГГГГММДДччммсс
+
|Целое
|Дата рождения
+
|ИД клиента-родителя
 
|-
 
|-
|gender
+
|address
 
|Строка
 
|Строка
|Пол. Может принимать значения:  
+
|Домашний адрес
 +
|-
 +
|gender
 +
|Строка
 +
|Пол. Может принимать значения:
 +
• "" - не указан
 +
 
 
• "male" -  мужской
 
• "male" -  мужской
  
 
• "female" - женский
 
• "female" - женский
 
|-
 
|-
|parent_id
+
|birthday
|Целое
+
|ДД.ММ.ГГГГ
|ИД клиента-родителя
+
|Дата рождения
 
|-
 
|-
|client_group_id
+
|phones 
|Целое
+
|Массив
|ИД группы клиента
+
|Массив телефонов клиента
 
|-
 
|-
|email
+
|&bull; phone
 
|Строка
 
|Строка
|E-mail
+
|Номер телефона клиента
 
|-
 
|-
|use_email_informing
+
|balance
|true или false
+
|Дробное
|Использовать E-mail для отправки уведомлений по заказу
+
|Баланс
 +
|-
 +
|bonus_balance
 +
|Дробное
 +
|Бонусный баланс
 +
|-
 +
|login 
 +
|Строка
 +
|Логин
 
|-
 
|-
|comment
+
|password
 
|Строка
 
|Строка
|Комментарий
+
|Пароль
|}
+
|-
 
+
|client_group_id
Специальные возвращаемые коды:
+
|Целое
{|
+
|ИД группы клиента
!Код
+
|-
!Описание
+
|tariff_id
 +
|Целое
 +
|ИД тарифа клиента или группы клиентов
 
|-
 
|-
|100
+
|prize_tariff_id
|Клиент с номером телефона=PHONE уже существует
+
|Целое
 +
|ИД призового тарифа клиента или группы клиентов
 
|-
 
|-
|101
+
|tariff_shift_id
|Клиент с ИД=ID имеет такой же номер телефона=PHONE
+
|Целое
 +
|ИД смены тарифов клиента или группы клиентов
 
|-
 
|-
|102
+
|discount_id
|Клиент с логином=LOGIN уже существует
+
|Целое
 +
|ИД скидки клиента или группы клиентов
 
|-
 
|-
|103
+
|prize_discount_id
|Группа клиента с ИД=CLIENT_GROUP_ID не найдена
+
|Целое
 +
|ИД призовой скидки клиента или группы клиентов
 
|-
 
|-
|104
+
|min_balance
|Клиент указанный в качестве родителя с ИД=PARENT_ID не найден
+
|Дробное
|}
+
|Порог, ниже которого не может опускаться баланс
 
 
Возвращаемые данные в случае успешного выполнения запроса: нет
 
 
 
Пример:
 
 
 
<pre>
 
Запрос:
 
 
 
POST https://ip:port/common_api/1.0/update_client_info
 
Signature: <...>
 
Content-Type: application/x-www-form-urlencoded
 
Content-Length: 118
 
 
 
client_id=140&name=NAME&phones=88,99&login=LOGIN&password=PASSWORD&birthday=20140901000000&gender=male&
 
address=ADDRESS&parent_id=10&client_group_id=3&email=mail%40ya.ru&use_email_informing=true
 
 
 
Ответ:
 
 
 
{
 
"code":0,
 
  "descr":"OK",
 
  "data":{}
 
}
 
</pre>
 
 
 
=== Запрос текущих заказов ===
 
 
 
Метод: GET
 
 
 
Название запроса: get_current_orders
 
 
 
Параметры:
 
 
 
{|
 
!Параметры
 
!Тип
 
!Описание
 
 
|-
 
|-
!colspan="3"|Необязательные параметры
+
|min_balance_for_use_cashless
 +
|Дробное
 +
|Минимальный баланс для использования безналичного счета
 
|-
 
|-
|client_id
+
|min_bonus_balance_for_use_bonus
|Целое
+
|Дробное
|ИД клиента
+
|Минимальный баланс для использования бонусного счета
 
|-
 
|-
|client_employee_id
+
|is_locked
|Целое
+
|true или false
|ИД сотрудника (только если указан ИД клиента)
+
|Клиент заблокирован
 
|-
 
|-
|phone
+
|lock_description
|Строка, <= 30 символов
+
|Строка
|Телефон клиента
+
|Причина блокировки
 
|-
 
|-
|crew_id
+
|use_cashless_account
|Целое
+
|true или false
|ИД экипажа
+
|Признак использования безналичного счета
 
|-
 
|-
|driver_id
+
|use_cashless
|Целое
+
|true или false
|ИД водителя
+
|Признак использования безналичного расчета по умолчанию. Имеет смысл только при use_cashless_account = true
|}
 
 
 
Специальные возвращаемые коды:
 
{|
 
!Код
 
!Описание
 
 
|-
 
|-
|100
+
|no_cash_payment
|Не найден клиент ИД=CLIENT_ID
+
|true или false
 +
|Признак запрета использования наличных расчетов. Имеет смысл только при use_cashless_account = true и use_cashless = true
 
|-
 
|-
|101
+
|remain_prize
|Не найден сотрудник клиента ИД=CLIENT_EMPLOYEE_ID
 
|}
 
 
 
Возвращаемые данные в случае успешного выполнения запроса:
 
{|
 
!Параметр
 
!Тип
 
!Описание
 
|-
 
|id
 
 
|Целое
 
|Целое
|ИД заказа
+
|Сколько заказов осталось до призового
 
|-
 
|-
|state_id
+
|email
|Целое
+
|Строка
|ИД состояния заказа
+
|E-mail
 
|-
 
|-
|state_kind
+
|use_email_informing
|Строка
+
|true или false
|Тип состояния заказа. Может принимать значения:
+
|Использовать E-mail для отправки уведомлений по заказу
 
 
• "new_order" — новый заказ
 
 
 
• "driver_assigned" — водитель назначен
 
 
 
• "car_at_place" — машина подъехала на место
 
 
 
• "client_inside" — клиент в машине
 
 
|-
 
|-
|server_time_offset
+
|default_crew_group
 
|Целое
 
|Целое
|Смещение относительно серверного времени
+
|Группа экипажей по умолчанию
 
|-
 
|-
|start_time
+
|use_own_account
|ГГГГММДДччммсс
+
|true или false
|Дата создания заказа
+
|Использовать собственный счет для оплаты заказа
 
|-
 
|-
|source_time
+
|comment
|ГГГГММДДччммсс
 
|Время подачи
 
|-
 
|source 
 
 
|Строка
 
|Строка
|Адрес подачи
+
|Комментарий
 
|-
 
|-
|source_lat
+
|accounts
|Строка
+
|Массив
|Широта адреса подачи
+
|Массив счетов клиента
 
|-
 
|-
|source_lon
+
|&bull; account_kind
|Строка
+
|Целое
|Долгота адреса подачи
+
|Тип счета:
 +
* 0 - Основной счет
 +
* 1- Бонусный счет
 +
* Остальные - нестандартные счета
 
|-
 
|-
|destination 
+
|&bull; balance
|Строка
+
|Дробное
|Адрес назначения
+
|Баланс счета клиента
 
|-
 
|-
|destination_lat
+
|&bull; balance_with_children
|Строка
+
|Дробное
|Широта адреса назначения
+
|Баланс счета клиента с учетом вложенных клиентов
 
|-
 
|-
|destination_lon
+
|attribute_values
|Строка
+
|Массив
|Долгота адреса назначения
+
|Массив значений атрибутов
 
|-
 
|-
|stops
+
|&bull; id
|Массив
 
|Информация по остановкам заказа
 
|-
 
|• address
 
|Строка
 
|Адрес остановки
 
|-
 
|• lat
 
|Дробное
 
|Широта адреса остановки
 
|-
 
|• lon
 
|Дробное
 
|Долгота адреса остановки
 
|-
 
|customer
 
|Строка
 
|Заказчик
 
|-
 
|passenger
 
|Строка
 
|Пассажир
 
|-
 
|crew_id
 
 
|Целое
 
|Целое
|ИД экипажа
+
|Идентификатор атрибута
 
|-
 
|-
|prior_crew_id
+
|&bull; bool_value
|Целое
+
|true или false
|ИД предварительного экипажа
+
|Значение, если тип атрибута «Логический»
 
|-
 
|-
|driver_id
+
|&bull; num_value
|Целое
+
|Дробное
|ИД водителя
+
|Значение, если тип атрибута:
 +
* «Число» (непосредственное значение)
 +
* «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
 +
* «Перечисляемый» (значение выбранного элемента перечисления)
 +
* «Дата» и «Дата/время» (Unix-время, всегда целое число)
 
|-
 
|-
|car_id
+
|&bull; str_value
|Целое
 
|ИД автомобиля
 
|-
 
|phone
 
 
|Строка
 
|Строка
|Номер телефона
+
|Значение, если тип атрибута «Строка»
|-
+
|}
|client_id
+
 
|Целое
+
Пример:
|ИД клиента
 
|-
 
|tariff_id
 
|Целое
 
|ИД тарифа
 
|-
 
|order_crew_group_id
 
|Целое
 
|ИД группы экипажей, которая указана в заказе
 
|-
 
|creation_way
 
|Строка
 
|Способ создания заказа. Может принимать значения:
 
  
• "operator" — заказ создан оператором
+
<pre>
 +
Запрос:
  
• "sms" — заказ создан через смс
+
GET https://ip:port/common_api/1.0/get_clients_info?text=test&max_clients_count=10&client_group_id=1&parent_id=20&fields=name,number HTTP/1.1
 +
Signature: <...>
  
• "market" — заказ из биржи
+
Ответ:
  
"common_api" — заказ создан через api
+
{
 +
  "code":0,
 +
  "descr":"OK",
 +
  "data":{
 +
    "clients_info":[
 +
      {
 +
        "client_id":390,
 +
        "name":"tester1",
 +
        "number":"001"
 +
      },
 +
      {
 +
        "client_id":394,
 +
        "name":"tester2",
 +
        "number":"002"
 +
      }
 +
    ]
 +
  }
 +
}
  
• "t_api" — заказ создан через api
+
</pre>
  
• "taxophone" —  заказ создан через таксофон с телефона
+
=== Изменение информации по клиенту ===
  
• "driver" — заказ создан водителем
+
Метод: POST
  
• "daily_order" — ежедневный заказ
+
Название запроса: update_client_info
  
• "taxophone_web" — заказ создан через таксофон с сайта
+
Параметры:
  
"unknown" — неизвестный
+
{|
 +
!Параметры
 +
!Тип
 +
!Описание
 +
|-
 +
!colspan="3"|Обязательные параметры
 
|-
 
|-
|client_employee_id
+
|client_id
 
|Целое
 
|Целое
|ИД сотрудника клиента
+
|ИД клиента
 +
|-
 +
!colspan="3"|Необязательные параметры
 
|-
 
|-
|is_prior
+
|name
|true или false
+
|Строка, <= 60 символов
|Предварительный заказ
+
|ФИО
 +
|-
 +
|login
 +
|Строка, <= 60 символов
 +
|Логин
 +
|-
 +
|password
 +
|Строка, <= 60 символов
 +
|Пароль
 +
|-
 +
|phones
 +
|Строка
 +
|Номера телефонов (через запятую)
 +
|-
 +
|address
 +
|Строка
 +
|Домашний адрес
 +
|-
 +
|birthday
 +
|ГГГГММДДччммсс
 +
|Дата рождения
 +
|-
 +
|gender
 +
|Строка
 +
|Пол. Может принимать значения:
 +
• "male" -  мужской
 +
 
 +
• "female" - женский
 +
|-
 +
|parent_id
 +
|Целое
 +
|ИД клиента-родителя
 
|-
 
|-
|is_really_prior
+
|client_group_id
|true или false
+
|Целое
|Предварительный заказ на вкладке "Предварительные"
+
|ИД группы клиента
 
|-
 
|-
 
|email
 
|email
 
|Строка
 
|Строка
|Email для уведомлений
+
|E-mail
 
|-
 
|-
|prior_to_current_before_minutes
+
|use_email_informing
|Целое
+
|true или false
|Время перехода из предварительного в текущие заказы, мин
+
|Использовать E-mail для отправки уведомлений по заказу
 
|-
 
|-
|flight_number
+
|comment
 
|Строка
 
|Строка
|Номер рейса
+
|Комментарий
 +
|-
 +
|use_own_account
 +
|true или false
 +
|Использовать собственный счет для оплаты заказов
 
|}
 
|}
  
Пример:
+
Специальные возвращаемые коды:
 
+
{|
<pre>
+
!Код
 +
!Описание
 +
|-
 +
|100
 +
|Клиент с номером телефона=PHONE уже существует
 +
|-
 +
|101
 +
|Клиент с ИД=ID имеет такой же номер телефона=PHONE
 +
|-
 +
|102
 +
|Клиент с логином=LOGIN уже существует
 +
|-
 +
|103
 +
|Группа клиента с ИД=CLIENT_GROUP_ID не найдена
 +
|-
 +
|104
 +
|Клиент указанный в качестве родителя с ИД=PARENT_ID не найден
 +
|-
 +
|109
 +
|Пароль клиента не соответствует политике паролей
 +
|}
 +
 
 +
Возвращаемые данные в случае успешного выполнения запроса: нет
 +
 
 +
Пример:
 +
 
 +
<pre>
 
Запрос:
 
Запрос:
GET https://ip:port/common_api/1.0/get_current_orders?client_id=140&phone=18
+
 
 +
POST https://ip:port/common_api/1.0/update_client_info
 
Signature: <...>
 
Signature: <...>
 +
Content-Type: application/x-www-form-urlencoded
 +
Content-Length: <...>
 +
 +
client_id=140&name=NAME&phones=88,99&login=LOGIN&password=PASSWORD&birthday=20140901000000&gender=male&address=ADDRESS&parent_id=10&client_group_id=3&email=mail%40ya.ru&use_email_informing=true
  
 
Ответ:
 
Ответ:
 +
 
{
 
{
  "code":0,
+
"code":0,
 
   "descr":"OK",
 
   "descr":"OK",
   "data":{
+
   "data":{}
    "orders":[
 
      {
 
        "id":20648,
 
        "state_id":44,
 
        "state_kind":"new_order",
 
        "server_time_offset:0,
 
        "start_time":"20130204181111",
 
        "source_time":"20130204181111",
 
        "source":"30 Лет Победы ул. \/Ижевск\/, 4Б",
 
        "source_lat":56.863613,
 
        "source_lon":53.186539,
 
        "destination":"Кирова ул. \/Ижевск\/, 56",
 
        "destination_lat":56.862202,
 
        "destination_lon":53.187485,
 
        "stops":[
 
          {
 
            "address":"30 Лет Победы ул. \/Ижевск\/, 8",
 
            "lat":56.863388,
 
            "lon":53.184269
 
          }
 
        ],
 
        "customer":"Маша",
 
        "passenger":"Маша",
 
        "crew_id":0,
 
        "prior_crew_id":0,
 
        "driver_id":0,
 
        "car_id":0,
 
        "phone":"18",
 
        "client_id":140,
 
        "tariff_id":1,
 
        "order_crew_group_id":1,
 
        "creation_way":"operator",
 
        "client_employee_id":1,
 
        "is_prior":false,
 
        "is_really_prior":false
 
        "email":"mail@mail.ru",
 
        "prior_to_current_before_minutes":30,
 
        "flight_number":"123/123123-0"
 
      },
 
      {
 
        "id":20670,
 
        "state_id":45,
 
        "state_kind":"car_at_place",
 
        "start_time":"20130207153022",
 
        "source_time":"20130207153022",
 
        "source":"11-й мкр,",
 
        "destination":"1-й пр-т \/Москва\/,",
 
        "customer":"Саша",
 
        "passenger":"Саша",
 
        "crew_id":1,
 
        "prior_crew_id":1,
 
        "driver_id":1,
 
        "car_id":1,
 
        "phone":"18",
 
        "client_id":140,
 
        "tariff_id":2,
 
        "order_crew_group_id":2,
 
        "creation_way":"operator",
 
        "client_employee_id":4,
 
        "is_prior":false,
 
        "is_really_prior":false
 
        "email":"mail@mail.ru"
 
        "prior_to_current_before_minutes":30,
 
        "flight_number":"123/123123"
 
 
 
      }
 
    ]
 
  }
 
 
}
 
}
 
</pre>
 
</pre>
  
=== Запрос выполненных заказов ===
+
=== Изменение информации по клиенту 2 ===
 +
Метод: POST
  
Метод: GET
+
Название запроса: update_client_info2
  
Название запроса: get_finished_orders
+
Версия ТМ: 3.12
  
Параметры:
+
Параметры в формате JSON:
  
 
{|
 
{|
Строка 6370: Строка 6926:
 
!colspan="3"|Обязательные параметры
 
!colspan="3"|Обязательные параметры
 
|-
 
|-
|start_time
+
|client_id
|ГГГГММДДччммсс
+
|Целое
|Начало периода
+
|ИД клиента
 +
|-
 +
!colspan="3"|Необязательные параметры
 
|-
 
|-
|finish_time
+
|name
|ГГГГММДДччммсс
+
|Строка, <= 60 символов
|Конец периода
+
|ФИО
 
|-
 
|-
!colspan="3"|Необязательные параметры
+
|login
 +
|Строка, <= 60 символов
 +
|Логин
 
|-
 
|-
!colspan="3"| '''Примечание''': должен присутствовать хотя бы один параметр из client_id, phone, crew_id, driver_id.
+
|password
 +
|Строка, <= 60 символов
 +
|Пароль
 
|-
 
|-
|client_id
+
|phones
|Целое
+
|Массив
|ИД клиента  
+
|Массив телефонов клиента
 
|-
 
|-
|client_employee_id
+
|&bull; phone
|Целое
+
|Строка
|ИД сотрудника (только если указан ИД клиента)
+
|Номер телефона
 
|-
 
|-
|phone
+
|&bull; is_default
|Строка, <= 30 символов
+
|true или false
|Телефон клиента
+
|Признак основного телефона
 
|-
 
|-
|crew_id
+
|client_group_id
 
|Целое
 
|Целое
|ИД экипажа
+
|ИД группы клиента
 
|-
 
|-
|driver_id
+
|parent_id
 
|Целое
 
|Целое
|ИД водителя
+
|ИД клиента-родителя
 +
|-
 +
|address
 +
|Строка
 +
|Домашний адрес
 +
|-
 +
|birthday
 +
|ГГГГММДДччммсс
 +
|Дата рождения
 
|-
 
|-
|state_type
+
|gender
 
|Строка
 
|Строка
|Тип состояния заказа. Может принимать значения:
+
|Пол. Может принимать значения:  
 +
• "male" -  мужской
  
• "all" — все
+
• "female" - женский
 
 
• "finished" — выполненные
 
 
 
• "aborted" — прекращенные
 
 
|-
 
|-
|state_ids
+
|email
 
|Строка
 
|Строка
|Список состояний заказа через точку с запятой, пример: «1;2;3»
+
|E-mail
|}
 
'''Примечание''': должен присутствовать хотя бы один параметр из client_id, phone, crew_id, driver_id.
 
 
 
Возвращаемые данные в случае успешного выполнения запроса:
 
{|
 
!Параметр
 
!Тип
 
!Описание
 
 
|-
 
|-
|id
+
|use_email_informing
|Целое
+
|true или false
|ИД заказа
+
|Использовать E-mail для отправки уведомлений по заказу
 
|-
 
|-
|state_id
+
|comment
|Целое
+
|Строка
|ИД состояния заказа
+
|Комментарий
 
|-
 
|-
|server_time_offset
+
|use_own_account
|Целое
+
|true или false
|Смещение относительно серверного времени
+
|Использовать собственный счет для оплаты заказов
 
|-
 
|-
|start_time
+
|attribute_values
|ГГГГММДДччммсс
+
|Массив
|Время создания заказа
+
|Массив значений атрибутов
 
|-
 
|-
|source_time
+
|&bull; id
|ГГГГММДДччммсс
+
|Целое
|Время подачи
+
|Идентификатор атрибута
 
|-
 
|-
|finish_time
+
|&bull; bool_value
|ГГГГММДДччммсс
+
|true или false
|Время завершения заказа
+
|Значение, если тип атрибута «Логический»
 
|-
 
|-
|source 
+
|&bull; num_value
|Строка
 
|Адрес подачи
 
|-
 
|source_lat
 
 
|Дробное
 
|Дробное
|Широта адреса подачи
+
|Значение, если тип атрибута:
 +
* «Число» (непосредственное значение)
 +
* «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
 +
* «Перечисляемый» (значение выбранного элемента перечисления)
 +
* «Дата» и «Дата/время» (Unix-время, всегда целое число)
 
|-
 
|-
|source_lon 
+
|&bull; str_value
|Дробное
 
|Долгота адреса подачи
 
|-
 
|destination 
 
 
|Строка
 
|Строка
|Адрес назначения
+
|Значение, если тип атрибута «Строка»
 +
|}
 +
 
 +
Специальные возвращаемые коды:
 +
{|
 +
!Код
 +
!Описание
 
|-
 
|-
|destination_lat
+
|100
|Дробное
+
|Клиент с ИД=CLIENT_ID не найден
|Широта адреса назначения
 
 
|-
 
|-
|destination_lon 
+
|101
|Дробное
+
|Дублирование номера телефона=PHONE в списке
|Долгота адреса назначения
 
 
|-
 
|-
|stops
+
|102
|Массив
+
|Клиент с логином=LOGIN уже существует
|Массив адресов остановок
 
 
|-
 
|-
|&bull; address
+
|103
|Строка
+
|Группа клиента с ИД=CLIENT_GROUP_ID не найдена
|Адрес остановки
 
 
|-
 
|-
|&bull; lat
+
|104
|Дробное
+
|Клиент указанный в качестве родителя с ИД=PARENT_ID не найден
|Широта адреса остановки
 
 
|-
 
|-
|&bull; lon
+
|105
|Дробное
+
|Основной телефон может быть только один
|Долгота адреса остановки
 
 
|-
 
|-
|trip_distance
+
|106
|Дробное
+
|Клиент должен иметь основной телефон
|Фактический километраж
 
 
|-
 
|-
|trip_time
+
|107
|Целое
+
|Атрибут с ИД=ID не найден
|Фактическое время в пути
 
 
|-
 
|-
|customer
+
|108
|Строка
+
|Атрибут с ИД=ID не может быть привязан к клиенту
|Заказчик
 
 
|-
 
|-
|passenger
+
|109
|Строка
+
|Пароль клиента не соответствует политике паролей
|Пассажир
+
|}
|-
+
 
|sum
+
Возвращаемые данные в случае успешного выполнения запроса: нет
|Дробное
+
 
|Стоимость заказа без учета скидок (наценок)
+
Пример:
|-
+
 
|total_sum
+
<pre>
|Дробное
+
Запрос:
|Итоговая стоимость заказа
+
 
 +
POST https://ip:port/common_api/1.0/update_client_info2 HTTP/1.1
 +
Signature: <...>
 +
Content-Type: application/json
 +
Content-Length: <...>
 +
 
 +
{
 +
  "client_id":140,
 +
  "name":"NAME",
 +
  "login":"LOGIN",
 +
  "password":"PASSWORD",
 +
  "phones":[
 +
    {
 +
      "phone":"88",
 +
      "is_default":true
 +
    }
 +
  ],
 +
  "address":"ADDRESS",
 +
  "gender":"male",
 +
  "birthday":"20000101000000",
 +
  "client_group_id":1,
 +
  "parent_id":10,
 +
  "email":"mail@ya.ru",
 +
  "use_email_informing":true,
 +
  "comment":"TEXT",
 +
  "use_own_account":false,
 +
  "attribute_values":[
 +
    {
 +
      "id":7,
 +
      "num_value":5
 +
    },
 +
    {
 +
      "id":9,
 +
      "str_value":null
 +
    }
 +
  ]
 +
}
 +
 
 +
Ответ:
 +
 
 +
{
 +
  "code":0,
 +
  "descr":"OK",
 +
  "data":{}
 +
}
 +
 
 +
</pre>
 +
 
 +
=== Запрос текущих заказов ===
 +
 
 +
Метод: GET
 +
 
 +
Название запроса: get_current_orders
 +
 
 +
Параметры:
 +
 
 +
{|
 +
!Параметры
 +
!Тип
 +
!Описание
 
|-
 
|-
|cash_sum
+
!colspan="3"|Необязательные параметры
|Дробное
 
|Заплачено наличными
 
 
|-
 
|-
|cashless_sum
+
|client_id
|Дробное
+
|Целое
|Заплачено с безналичного счета клиента
+
|ИД клиента
 
|-
 
|-
|bonus_sum
+
|client_employee_id
|Дробное
+
|Целое
|Заплачено с бонусного счета клиента
+
|ИД сотрудника (только если указан ИД клиента)
 
|-
 
|-
|bank_card_sum
+
|phone
|Дробное
+
|Строка, <= 30 символов
|Заплачено банковской картой
+
|Телефон клиента
 +
|-
 +
|crew_id
 +
|Целое
 +
|ИД экипажа
 +
|-
 +
|driver_id
 +
|Целое
 +
|ИД водителя
 +
|-
 +
|fields
 +
|Строка
 +
|Список возвращаемых полей через запятую
 +
|}
 +
 
 +
Специальные возвращаемые коды:
 +
{|
 +
!Код
 +
!Описание
 +
|-
 +
|100
 +
|Не найден клиент ИД=CLIENT_ID
 +
|-
 +
|101
 +
|Не найден сотрудник клиента ИД=CLIENT_EMPLOYEE_ID
 +
|}
 +
 
 +
Возвращаемые данные в случае успешного выполнения запроса:
 +
{|
 +
!Параметр
 +
!Тип
 +
!Описание
 +
|-
 +
|id
 +
|Целое
 +
|ИД заказа
 +
|-
 +
|state_id
 +
|Целое
 +
|ИД состояния заказа
 +
|-
 +
|state_kind
 +
|Строка
 +
|Тип состояния заказа. Может принимать значения:
 +
* "new_order" — новый заказ
 +
* "driver_assigned" — водитель назначен
 +
* "car_at_place" — машина подъехала на место
 +
* "client_inside" — клиент в машине
 +
* "finished" — заказ успешно завершен
 +
* "aborted" — заказ прекращен
 
|-
 
|-
 
|crew_id
 
|crew_id
Строка 6544: Строка 7202:
 
|ИД автомобиля
 
|ИД автомобиля
 
|-
 
|-
|phone
+
|server_time_offset
|Строка
 
|Номер телефона
 
|-
 
|client_id
 
 
|Целое
 
|Целое
|ИД клиента
+
|Смещение относительно серверного времени
 
|-
 
|-
|tariff_id
+
|start_time
|Целое
+
|ГГГГММДДччммсс
|ИД тарифа
+
|Дата создания заказа
 
|-
 
|-
|order_crew_group_id
+
|source_time
|Целое
+
|ГГГГММДДччммсс
|ИД группы экипажей, которая указана в заказе
+
|Время подачи
 
|-
 
|-
|creation_way
+
|source 
 
|Строка
 
|Строка
|Способ создания заказа. Может принимать значения:
+
|Адрес подачи
 
+
|-
• "operator" — заказ создан оператором
+
|source_lat
 
+
|Строка
• "sms" — заказ создан через смс
+
|Широта адреса подачи
 
+
|-
• "market" — заказ из биржи
+
|source_lon
 
+
|Строка
• "common_api" — заказ создан через api
+
|Долгота адреса подачи
 
+
|-
• "t_api" — заказ создан через api
+
|destination  
 
+
|Строка
• "taxophone" — заказ создан через таксофон с телефона
+
|Адрес назначения
 
 
• "driver" — заказ создан водителем
 
 
 
• "daily_order" — ежедневный заказ
 
 
 
• "taxophone_web" — заказ создан через таксофон с сайта
 
 
 
• "unknown" — неизвестный
 
 
|-
 
|-
|client_employee_id
+
|destination_lat
|Целое
+
|Строка
|ИД сотрудника клиента
+
|Широта адреса назначения
 
|-
 
|-
|email
+
|destination_lon
 
|Строка
 
|Строка
|Email для уведомлений
+
|Долгота адреса назначения
 +
|-
 +
|stops
 +
|Массив
 +
|Информация по остановкам заказа
 
|-
 
|-
|flight_number
+
|• address
 
|Строка
 
|Строка
|Номер рейса
+
|Адрес остановки
|}
+
|-
 
+
|• lat
Пример:
+
|Дробное
 
+
|Широта адреса остановки
<pre>
+
|-
Запрос:
+
|• lon
GET https://ip:port/common_api/1.0/get_finished_orders?driver_id=1&start_time=20170314122041&finish_time=20170314122641
+
|Дробное
Signature: <...>
+
|Долгота адреса остановки
Ответ:
+
|-
{
+
|customer
  "code":0,
+
|Строка
  "descr":"OK",
+
|Заказчик
  "data":{
+
|-
    "orders":[
+
|passenger
      {
+
|Строка
        "id":20651,
+
|Пассажир
        "state_id":34,
+
|-
        "server_time_offset:1,
+
|phone
        "start_time":"20130205110812",
+
|Строка
        "source_time":"20130205110812",
+
|Номер телефона
        "finish_time":"20130205115618",
 
        "source":"прпроп",
 
        "source_lat":42.9806060791016,
 
        "source_lon":47.4614906311035,
 
        "destination":"рррррр",
 
        "destination_lat":55.6898765563965,
 
        "destination_lon":37.6890335083008,
 
        "stops":[
 
          {
 
            "address":"ввввв",
 
            "lat":55.6792640686035,
 
            "lon":37.5807800292969
 
          },
 
          {
 
            "address":"ааааа",
 
            "lat":55.6731262207031,
 
            "lon":37.6959686279297
 
          },
 
          {
 
            "address":"ппппп",
 
            "lat":55.678165435791,
 
            "lon":37.6913642883301
 
          }
 
        ],
 
        "trip_distance":20,
 
        "trip_time":100,
 
        "customer":"Вера",
 
        "passenger":"Вера",
 
        "sum":908,
 
        "total_sum":1000,
 
        "cash_sum":700,
 
        "cashless_sum":100,
 
        "bonus_sum":150,
 
        "bank_card_sum":50,
 
        "crew_id":6,
 
        "prior_crew_id":0,
 
        "driver_id":4,
 
        "car_id":6,
 
        "phone":"111111",
 
        "client_id":140,
 
        "tariff_id":1,
 
        "order_crew_group_id":1
 
        "email":"mail@mail.ru"
 
        "flight_number":"fln-122"
 
 
 
      },
 
      {
 
        "id":20669,
 
        "state_id":34,
 
        "source_time":"20130205130500",
 
        "start_time":"20130205130500",
 
        "finish_time":"20130205134511",
 
        "source":"1",
 
        "destination":"2",
 
        "customer":"Маша",
 
        "passenger":"Маша",
 
        "sum":454,
 
        "total_sum":500,
 
        "cash_sum":0,
 
        "cashless_sum":500,
 
        "bonus_sum":0,
 
        "bank_card_sum":0,
 
        "crew_id":6,
 
        "prior_crew_id":0,
 
        "driver_id":4,
 
        "car_id":6,
 
        "phone":"222222",
 
        "client_id":140,
 
        "tariff_id":2,
 
        "order_crew_group_id":2
 
        "creation_way":"operator"
 
        "client_employee_id":7
 
        "email":"mail@mail.ru"
 
        "flight_number":"fln-123"
 
 
 
      }
 
    ]
 
  }
 
}
 
</pre>
 
 
 
=== Проведение операции по клиенту ===
 
 
 
Метод: POST
 
 
 
Название запроса: create_client_operation
 
 
 
Параметры:
 
 
 
{|
 
!Параметры
 
!Тип
 
!Описание
 
 
|-
 
|-
!colspan="3"|Обязательные параметры
+
|phone_to_dial
 +
|Строка
 +
|Номер телефона для отзвона
 
|-
 
|-
 
|client_id
 
|client_id
Строка 6715: Строка 7274:
 
|ИД клиента
 
|ИД клиента
 
|-
 
|-
|sum
+
|client_name
|Дробное
+
|Строка
|Сумма
+
|Имя клиента
 
|-
 
|-
|oper_type
+
|client_group_id
 
|Целое
 
|Целое
|Тип операции:
+
|ИД группы клиента
• "receipt" - приход
 
 
 
• "expense" - расход
 
 
|-
 
|-
!colspan="3"|Необязательные параметры
+
|client_group_name
 +
|Строка
 +
|Название группы клиента
 
|-
 
|-
|oper_time
+
|client_employee_id
|ГГГГММДДччммсс
+
|Целое
|Время создания операции (если не указано, текущее)
+
|ИД сотрудника клиента
 +
|-
 +
|order_crew_group_id
 +
|Целое
 +
|ИД группы экипажей, которая указана в заказе
 +
|-
 +
|tariff_id
 +
|Целое
 +
|ИД тарифа
 +
|-
 +
|car_mark
 +
|Строка
 +
|Марка автомобиля
 +
|-
 +
|car_model
 +
|Строка
 +
|Модель автомобиля
 
|-
 
|-
|comment
+
|car_color
 
|Строка
 
|Строка
|Комментарий
+
|Цвет автомобиля
 
|-
 
|-
|pay_type
+
|car_number
|Целое
+
|Строка
|Тип оплаты:
+
|Гос.номер автомобиля
• "cash" - наличный
 
 
 
• "nocash" - безналичный
 
 
|-
 
|-
|bonus_oper
+
|confirmed
|true или false
+
|Строка
|Операция по бонусному счёту
+
|Состояние подтвержденности заказа водителем или оператором. Может принимать значения:
|}
 
  
Специальные возвращаемые коды:
+
* "not_confirmed" — не подтверждено
{|
+
* "confirmed_by_driver" — заказ принят водителем
!Код
+
* "confirmed_by_oper" — заказ подтвержден оператором
!Описание
 
 
|-
 
|-
|100
+
|crew_coords
|Не найден клиент ИД=CLIENT_ID
+
|Массив
|}
+
|Координаты экипажа
 
 
Возвращаемые данные в случае успешного выполнения запроса:
 
{|
 
!Параметр
 
!Тип
 
!Описание
 
 
|-
 
|-
|oper_id
+
|• lat
|Целое
+
|Дробное
|ИД операции
+
|Широта
|}
+
|-
 
+
|• lon
Пример:
+
|Дробное
 
+
|Долгота
<pre>
+
|-
Запрос:
+
|order_params
 +
|Массив
 +
|Массив параметров заказа экипажа. Устарело. Рекомендуется использовать параметр attribute_values. (Возвращается только если в списке фильтра полей fields запросили поле order_params)
 +
|-
 +
|•
 +
|Целое
 +
|ИД параметра заказа
 +
|-
 +
|creation_way
 +
|Строка
 +
|Способ создания заказа. Может принимать значения:
  
POST https://ip:port/common_api/1.0/create_client_operation
+
• "operator" — заказ создан оператором
Signature: <...>
 
Content-Type: application/x-www-form-urlencoded
 
Content-Length: 99
 
  
client_id=112&oper_time=20130221100719&oper_sum=300&oper_type=receipt&pay_type=cash&comment=COMMENT&bonus_oper=true
+
• "sms" — заказ создан через смс
  
Ответ:
+
• "market" — заказ из биржи
  
{
+
"common_api" — заказ создан через api
  "code":0,
 
  "descr":"OK",
 
  "data":{
 
    "oper_id":31
 
  
  }
+
• "t_api" — заказ создан через api
}
 
</pre>
 
  
=== Запрос операций по клиенту ===
+
• "taxophone" —  заказ создан через таксофон с телефона
  
Метод: GET
+
• "driver" — заказ создан водителем
  
Название запроса: get_client_operations
+
• "daily_order" — ежедневный заказ
  
Параметры:
+
• "taxophone_web" — заказ создан через таксофон с сайта
  
{|
+
• "unknown" — неизвестный
!Параметры
+
|-
!Тип
+
|is_prior
!Описание
+
|true или false
 +
|Предварительный заказ
 +
|-
 +
|is_really_prior
 +
|true или false
 +
|Предварительный заказ на вкладке "Предварительные"
 
|-
 
|-
!colspan="3"|Обязательные параметры
+
|email
 +
|Строка
 +
|Email для уведомлений
 
|-
 
|-
|client_id
+
|prior_to_current_before_minutes
 
|Целое
 
|Целое
|ИД клиента
+
|Время перехода из предварительного в текущие заказы, мин
 
|-
 
|-
|start_time
+
|flight_number
|ГГГГММДДччммсс
+
|Строка
|Начало периода
+
|Номер рейса
 +
|-
 +
|sum
 +
|Дробное
 +
|Сумма без скидки
 
|-
 
|-
|finish_time
+
|total_sum
|ГГГГММДДччммсс
+
|Дробное
|Конец периода
+
|Итоговая сумма заказа
|}
 
 
 
Специальные возвращаемые коды:
 
{|
 
!Код
 
!Описание
 
 
|-
 
|-
|100
+
|cash_sum
|Не найден клиент ИД=CLIENT_ID
+
|Дробное
|}
+
|Сумма наличными
 
 
Возвращаемые данные в случае успешного выполнения запроса:
 
{|
 
!Параметр
 
!Тип
 
!Описание
 
 
|-
 
|-
|oper_id
+
|cashless_sum
|Целое
+
|Дробное
|ИД операции
+
|Сумма безналичными
 
|-
 
|-
|oper_time
+
|bonus_sum
|ГГГГММДДччммсс
+
|Дробное
|Время создания операции
+
|Сумма бонусами
 
|-
 
|-
|sum
+
|bank_card_sum
 
|Дробное
 
|Дробное
|Сумма
+
|Сумма банковской картой
 
|-
 
|-
|order_id
+
|attribute_values
|Целое
+
|Массив
|Заказ, связанный с операцией
+
|Массив значений атрибутов
 
|-
 
|-
|oper_type
+
|• id
 
|Целое
 
|Целое
|Тип операции:
+
|Идентификатор атрибута
• "receipt" - приход
 
 
 
• "expense" - расход
 
 
|-
 
|-
|pay_type
+
|• bool_value
|Целое
+
|true или false
|Тип оплаты:
+
|Значение, если тип атрибута «Логический»
• "cash" - наличный
 
 
 
• "nocash" - безналичный
 
 
|-
 
|-
|name
+
|• num_value
 +
|Дробное
 +
|Значение, если тип атрибута:
 +
* «Число» (непосредственное значение)
 +
* «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
 +
* «Перечисляемый» (значение выбранного элемента перечисления)
 +
* «Дата» и «Дата/время» (Unix-время, всегда целое число)
 +
|-
 +
|• str_value
 
|Строка
 
|Строка
|Наименование
+
|Значение, если тип атрибута «Строка»
 +
|-
 +
|bill
 +
|Массив
 +
|Чек TMDriver. Данный узел выводится только, если по заказу есть чек и если в списке фильтра полей fields запросили поле bill
 +
|-
 +
|• code
 +
|Строка
 +
|Код элемента расчета
 +
|-
 +
|• text
 +
|Строка
 +
|Наименование элемента расчета
 +
|-
 +
|• value
 +
|Строка
 +
|Значение элемента расчета (количество)
 
|-
 
|-
|comment
+
|• sum
 
|Строка
 
|Строка
|Комментарий
+
|Стоимость элемента расчета
 
|-
 
|-
|cancelled_by_oper_id
+
|is_auction
|Целое
+
|true или false
|ИД операции отмены (для отмененной операции)
+
|Признак заказа-аукциона
 
|-
 
|-
|cancelled_oper_id
+
|payment_pay_system
|Целое
+
|Строка
|ИД отмененной операции (для операции отмены)
+
|Тип платежной системы ("card", "gpay", "apple_pay", "qr", "sber_pay", либо пусто, если не используется)
 
|}
 
|}
  
Строка 6887: Строка 7468:
 
Запрос:
 
Запрос:
  
GET
+
GET https://ip:port/common_api/1.0/get_current_orders?client_id=140&phone=18
 
 
GET https://ip:port/common_api/1.0/get_client_operations?
 
client_id=112&start_time=20130201092112&finish_time=20130221092112
 
 
 
 
Signature: <...>
 
Signature: <...>
  
Строка 6900: Строка 7477:
 
   "descr":"OK",
 
   "descr":"OK",
 
   "data":{
 
   "data":{
     "operations":[
+
     "order_id":1,
 +
    "state_id":12,
 +
    "state_kind":"car_at_place",
 +
    "crew_id":1,
 +
    "prior_crew_id":0,
 +
    "driver_id":2,
 +
    "car_id":3,
 +
    "server_time_offset:0,
 +
    "start_time":"20130117125641",
 +
    "source_time":"20130117132617",
 +
    "source":"30 Лет Победы ул. \/Ижевск\/, 4Б",
 +
    "source_lat":56.863613,
 +
    "source_lon":53.186539,
 +
    "destination":"Кирова ул. \/Ижевск\/, 56",
 +
    "destination_lat":56.862202,
 +
    "destination_lon":53.187485,
 +
    "stops":[
 
       {
 
       {
         "oper_id":112,
+
         "address":"30 Лет Победы ул. \/Ижевск\/, 8",
         "oper_time":"20130219091328",
+
         "lat":56.863388,
         "sum":"21,8",
+
        "lon":53.184269
         "order_id":11800,
+
      }
         "oper_type":"receipt",
+
    ],
         "pay_type":"cash",
+
    "customer":"Слепаков",
         "name":"Пополнение счета",
+
    "passenger":"Слепаков",
         "comment":"Комментарий"
+
    "phone":"8800",
         "cancelled_by_oper_id":0,
+
    "client_id":1,
         "cancelled_oper_id":112
+
    "client_employee_id":1,
 +
    "order_crew_group_id":1,
 +
    "tariff_id":1,
 +
    "car_mark":"Ауди",
 +
    "car_model":"Q7",
 +
    "car_color":"черный",
 +
    "car_number":"А777АА", 
 +
    "confirmed":"confirmed_by_oper",
 +
    "crew_coords": {
 +
        "lat": 56.833981,
 +
         "lon": 53.220249
 +
    },
 +
    "order_params":[
 +
      1,
 +
      2,
 +
      5
 +
    ],
 +
    "creation_way":"operator",
 +
    "is_prior":true,
 +
    "is_really_prior":false,
 +
    "email":"mail@mail.ru",
 +
    "prior_to_current_before_minutes":30,
 +
    "flight_number":"A-0501/123",
 +
    "sum":50.5,
 +
    "total_sum":80,
 +
    "cash_sum":20.1,
 +
    "cashless_sum":10,
 +
    "bonus_sum":5.2,
 +
    "bank_card_sum":15,
 +
    "attribute_values": [
 +
        {
 +
              "id": 1,
 +
              "bool_value": true
 +
        },
 +
        {
 +
              "id": 2,
 +
              "num_value": 1
 +
        },
 +
        {
 +
              "id": 3,
 +
              "num_value": 10
 +
        },
 +
        {
 +
              "id": 4,
 +
              "str_value": "строка"
 +
        }
 +
    ],
 +
    "bill":
 +
    [
 +
      {
 +
        "code":"BOARDING",
 +
         "text":"Посадка",
 +
         "value":"",
 +
         "sum":"20,00"
 +
      },
 +
      {
 +
         "code":"TRIP_TIME",
 +
         "text":"Общее время",
 +
         "value":"0:00:00",
 +
         "sum":""
 
       },
 
       },
 
       {
 
       {
         "oper_id":112,
+
         "code":"TRIP_DIST",
         "oper_time":"20130220112245",
+
        "text":"Общее расстояние",
         "sum":"4500",
+
        "value":"0,00 км",
         "order_id":11801,
+
        "sum":""
         "oper_type":"receipt",
+
      },
         "pay_type":"cash",
+
      {
         "name":"Пополнение счета",
+
        "code":"BEFORE_DISC",
         "comment":"Комментарий"
+
        "text":"Сумма без скидки",
         "cancelled_by_oper_id":111,
+
         "value":"",
         "cancelled_oper_id":0
+
         "sum":"20,00"
 +
      },
 +
      {
 +
        "code":"AFTER_DISC",
 +
         "text":"Сумма со скидкой",
 +
         "value":"",
 +
         "sum":"20,00"
 +
      },
 +
      {
 +
         "code":"MINIMUM",
 +
         "text":"Минималка",
 +
         "value":"",
 +
         "sum":"60,00"
 
       }
 
       }
 
     ]
 
     ]
 +
        "is_auction":false,
 +
        "payment_pay_system":"qr"
 
   }
 
   }
 
}
 
}
 
</pre>
 
</pre>
  
=== Проведение операции по водителю ===
+
=== Запрос выполненных заказов ===
  
Метод: POST
+
Метод: GET
  
Название запроса: create_driver_operation
+
Название запроса: get_finished_orders
  
Параметры в формате JSON:
+
Параметры:
  
 
{|
 
{|
!Параметр
+
!Параметры
 
!Тип
 
!Тип
 
!Описание
 
!Описание
Строка 6945: Строка 7611:
 
!colspan="3"|Обязательные параметры
 
!colspan="3"|Обязательные параметры
 
|-
 
|-
|driver_id
+
|start_time
|Целое
+
|ГГГГММДДччммсс
|ИД водителя
+
|Начало периода
 
|-
 
|-
|oper_sum
+
|finish_time
|Дробное
+
|ГГГГММДДччммсс
|Сумма
+
|Конец периода
|-
 
|oper_type
 
|Строка
 
|Тип операции:
 
 
 
• receipt - приход
 
 
 
• expense - расход
 
 
|-
 
|-
 
!colspan="3"|Необязательные параметры
 
!colspan="3"|Необязательные параметры
 
|-
 
|-
|name
+
!colspan="3"| '''Примечание''': должен присутствовать хотя бы один параметр из client_id, phone, crew_id, driver_id.
|Строка
 
|Наименование операции
 
 
|-
 
|-
|oper_time
+
|client_id
|ГГГГММДДччммсс
+
|Целое
|Время создания операции (если не задано, текущее)  !! Не используется с ТМ 3.7
+
|ИД клиента
 +
|-
 +
|client_employee_id
 +
|Целое
 +
|ИД сотрудника (только если указан ИД клиента)
 +
|-
 +
|phone
 +
|Строка, <= 30 символов
 +
|Телефон клиента
 
|-
 
|-
|comment
+
|crew_id
|Строка
+
|Целое
|Комментарий
+
|ИД экипажа
 
|-
 
|-
|account_kind
+
|driver_id
 
|Целое
 
|Целое
|ИД типа счета (0 - основной счет), по умолчанию 0
+
|ИД водителя
|}
+
|-
 +
|state_type
 +
|Строка
 +
|Тип состояния заказа. Может принимать значения:
 +
 
 +
• "all" — все
  
Специальные возвращаемые коды:
+
• "finished" — выполненные
  
{|
+
• "aborted" — прекращенные
!Код
+
|-
!Описание
+
|state_ids
 +
|Строка
 +
|Список состояний заказа через точку с запятой, пример: «1;2;3»
 
|-
 
|-
|100
+
|fields
|Водитель не найден ИД=DRIVER_ID
+
|Строка
 +
|Список возвращаемых полей через запятую
 
|}
 
|}
 +
 +
'''Примечание''': должен присутствовать хотя бы один параметр из client_id, phone, crew_id, driver_id.
  
 
Возвращаемые данные в случае успешного выполнения запроса:
 
Возвращаемые данные в случае успешного выполнения запроса:
 
 
{|
 
{|
 
!Параметр
 
!Параметр
Строка 6997: Строка 7670:
 
!Описание
 
!Описание
 
|-
 
|-
|oper_id
+
|id
 +
|Целое
 +
|ИД заказа
 +
|-
 +
|state_id
 +
|Целое
 +
|ИД состояния заказа
 +
|-
 +
|crew_id
 
|Целое
 
|Целое
|ИД операции
+
|ИД экипажа
|}
+
|-
 
+
|prior_crew_id
 
+
|Целое
Пример:
+
|ИД предварительного экипажа
 
 
<pre>
 
 
 
Запрос:
 
 
 
POST https://ip:port/common_api/1.0/create_driver_operation
 
Signature: <...>
 
Content-Type: application/json
 
Content-Length: 99
 
 
 
{
 
  "driver_id": 1,
 
  "oper_sum": 10.00,
 
  "oper_type": "receipt",
 
  "name": "Пополнение счета",
 
  "oper_time": "20141210100719",
 
  "comment": "Комментарий к операции"
 
    "account_kind": 1
 
}
 
 
 
Ответ:
 
 
 
{
 
  "code":0,
 
  "descr":"OK",
 
  "data":{
 
  "oper_id":31
 
  }
 
}
 
 
 
</pre>
 
 
 
=== Запрос операций по водителю ===
 
 
 
Метод: GET
 
 
 
Название запроса: get_driver_operations
 
 
 
Параметры:
 
 
 
{|
 
!Параметр
 
!Тип
 
!Описание
 
|-
 
!colspan="3"|Обязательные параметры
 
 
|-
 
|-
 
|driver_id
 
|driver_id
 
|Целое
 
|Целое
 
|ИД водителя
 
|ИД водителя
 +
|-
 +
|car_id
 +
|Целое
 +
|ИД автомобиля
 +
|-
 +
|server_time_offset
 +
|Целое
 +
|Смещение относительно серверного времени
 
|-
 
|-
 
|start_time
 
|start_time
 
|ГГГГММДДччммсс
 
|ГГГГММДДччммсс
|Начало периода
+
|Время создания заказа
 +
|-
 +
|source_time
 +
|ГГГГММДДччммсс
 +
|Время подачи
 
|-
 
|-
 
|finish_time
 
|finish_time
 
|ГГГГММДДччммсс
 
|ГГГГММДДччммсс
|Конец периода
+
|Время завершения заказа
 
|-
 
|-
!colspan="3"|Необязательные параметры
+
|source 
 +
|Строка
 +
|Адрес подачи
 
|-
 
|-
|account_kind
+
|source_lat
|Целое
+
|Дробное
|ИД типа счета (0 - основной счет), по умолчанию 0
+
|Широта адреса подачи
|}
 
 
 
 
 
Специальные возвращаемые коды:
 
{|
 
!Код
 
!Описание
 
 
|-
 
|-
|100
+
|source_lon 
|Не найден водитель ИД=DRIVER_ID
+
|Дробное
|}
+
|Долгота адреса подачи
 
 
 
 
Возвращаемые данные в случае успешного выполнения запроса:
 
{|
 
!Параметр
 
!Тип
 
!Описание
 
 
|-
 
|-
|oper_id
+
|destination 
|Целое
+
|Строка
|ИД операции
+
|Адрес назначения
 
|-
 
|-
|oper_time
+
|destination_lat
|ГГГГММДДччммсс
+
|Дробное
|Время создания операции
+
|Широта адреса назначения
 
|-
 
|-
|sum
+
|destination_lon 
 
|Дробное
 
|Дробное
|Сумма
+
|Долгота адреса назначения
 
|-
 
|-
|order_id
+
|stops
|Целое
+
|Массив
|Заказ, связанный с операцией
+
|Массив адресов остановок
 
|-
 
|-
|oper_type
+
|&bull; address
|Целое
 
|Тип операции:
 
 
 
•"receipt" - приход
 
 
 
•"expense" - расход
 
|-
 
|name
 
 
|Строка
 
|Строка
|Наименование
+
|Адрес остановки
 
|-
 
|-
|comment
+
|&bull; lat
|Строка
+
|Дробное
|Комментарий
+
|Широта адреса остановки
 
|-
 
|-
|account_kind
+
|&bull; lon
 +
|Дробное
 +
|Долгота адреса остановки
 +
|-
 +
|trip_distance
 +
|Дробное
 +
|Фактический километраж
 +
|-
 +
|trip_time
 +
|Целое
 +
|Фактическое время в пути
 +
|-
 +
|customer
 +
|Строка
 +
|Заказчик
 +
|-
 +
|passenger
 +
|Строка
 +
|Пассажир
 +
|-
 +
|phone
 +
|Строка
 +
|Номер телефона
 +
|-
 +
|phone_to_dial
 +
|Строка
 +
|Номер телефона для отзвона
 +
|-
 +
|client_id
 +
|Целое
 +
|ИД клиента
 +
|-
 +
|client_name
 +
|Строка
 +
|Имя клиента
 +
|-
 +
|client_group_id
 
|Целое
 
|Целое
| ИД типа счета
+
|ИД группы клиента
 +
|-
 +
|client_group_name
 +
|Строка
 +
|Название группы клиента
 
|-
 
|-
|cancelled_by_oper_id
+
|client_employee_id
 
|Целое
 
|Целое
|ИД операции отмены (для отмененной операции)
+
|ИД сотрудника клиента
 
|-
 
|-
|cancelled_oper_id
+
|order_crew_group_id
 
|Целое
 
|Целое
|ИД отмененной операции (для операции отмены)
+
|ИД группы экипажей, которая указана в заказе
|}
+
|-
 
+
|tariff_id
Пример:
+
|Целое
 
+
|ИД тарифа
<pre>
 
Запрос:
 
 
 
GET https://ip:port/common_api/1.0/get_driver_operations?
 
driver_id=112&start_time=20130201092112&finish_time=20130221092112
 
Signature: <...>
 
 
 
Ответ:
 
 
 
{
 
  "code":0,
 
  "descr":"OK",
 
  "data":{
 
    "operations":[
 
      {
 
        "oper_id":111,
 
        "oper_time":"20130219091328",
 
        "sum":"21,8",
 
        "order_id":11800,
 
        "oper_type":"receipt",
 
        "name":"DRIVER_OPERATION_1",
 
        "comment":"DRIVER_OPERATION_COMMENT_1",
 
        "account_kind":0,
 
        "cancelled_by_oper_id":0,
 
        "cancelled_oper_id":112
 
      },
 
      {
 
        "oper_id":112,
 
        "oper_time":"20130220112245",
 
        "sum":"4500",
 
        "order_id":11801,
 
        "oper_type":"receipt",
 
        "name":"DRIVER_OPERATION_2",
 
        "comment":"DRIVER_OPERATION_COMMENT_2",
 
        "account_kind":0,
 
        "cancelled_by_oper_id":111,
 
        "cancelled_oper_id":0
 
      }
 
    ]
 
  }
 
}
 
</pre>
 
 
 
=== Назначение динамического приоритета водителю ===
 
Метод: POST
 
 
 
Название запроса: create_driver_dyn_priority
 
 
 
Параметры в формате JSON:
 
 
 
{|
 
!Параметр
 
!Тип
 
!Описание
 
 
|-
 
|-
!colspan="3"|Обязательные параметры
+
|car_mark
 +
|Строка
 +
|Марка автомобиля
 
|-
 
|-
|driver_id
+
|car_model
|Целое
+
|Строка
|ИД водителя (должно быть что-то одно: либо driver_id, либо crew_id)
+
|Модель автомобиля
 
|-
 
|-
|crew_id
+
|car_color
|Целое
+
|Строка
|ИД экипажа (должно быть что-то одно: либо driver_id, либо crew_id)
+
|Цвет автомобиля
 
|-
 
|-
|priority
+
|car_number
|Целое
+
|Строка
|Приоритет
+
|Гос.номер автомобиля
 
|-
 
|-
|start_time
+
|order_params
|ГГГГММДДччммсс
+
|Массив
|Время начала действия приоритета
+
|Массив параметров заказа экипажа. Устарело. Рекомендуется использовать параметр attribute_values. (Возвращается только если в списке фильтра полей fields запросили поле order_params)
 
|-
 
|-
|finish_time
+
|
|ГГГГММДДччммсс
+
|Целое
|Время окончания действия приоритета
+
|ИД параметра заказа
 
|-
 
|-
|name
+
|creation_way
 
|Строка
 
|Строка
|Наименование приоритета
+
|Способ создания заказа. Может принимать значения:
|}
+
 
 +
• "operator" — заказ создан оператором
 +
 
 +
• "sms" — заказ создан через смс
 +
 
 +
• "market" — заказ из биржи
 +
 
 +
• "common_api" — заказ создан через api
 +
 
 +
• "t_api" — заказ создан через api
 +
 
 +
• "taxophone" —  заказ создан через таксофон с телефона
 +
 
 +
• "driver" — заказ создан водителем
 +
 
 +
• "daily_order" — ежедневный заказ
 +
 
 +
• "taxophone_web" — заказ создан через таксофон с сайта
  
Специальные возвращаемые коды:
+
• "unknown" — неизвестный
{|
 
!Код
 
!Описание
 
 
|-
 
|-
|100
+
|is_prior
|Водитель не найден ИД=DRIVER_ID
+
|true или false
 +
|Предварительный заказ
 
|-
 
|-
|101
+
|email
|Экипаж не найден ИД=CREW_ID
+
|Строка
 +
|Email для уведомлений
 
|-
 
|-
|102
+
|flight_number
|Время начала действия приоритета должно быть меньше времени окончания
+
|Строка
 +
|Номер рейса
 
|-
 
|-
|103
+
|sum
|Время действия приоритета уже истекло
+
|Дробное
|}
+
|Стоимость заказа без учета скидок (наценок)
 
+
|-
Возвращаемые данные в случае успешного выполнения запроса:
+
|total_sum
{|
+
|Дробное
!Параметр
+
|Итоговая стоимость заказа
!Тип
+
|-
!Описание
+
|cash_sum
 +
|Дробное
 +
|Заплачено наличными
 +
|-
 +
|cashless_sum
 +
|Дробное
 +
|Заплачено с безналичного счета клиента
 +
|-
 +
|bonus_sum
 +
|Дробное
 +
|Заплачено с бонусного счета клиента
 +
|-
 +
|bank_card_sum
 +
|Дробное
 +
|Заплачено банковской картой
 +
|-
 +
|attribute_values
 +
|Массив
 +
|Массив значений атрибутов
 
|-
 
|-
|dyn_priority_id
+
|• id
 
|Целое
 
|Целое
|ИД созданного динамического приоритета
+
|Идентификатор атрибута
 +
|-
 +
|• bool_value
 +
|true или false
 +
|Значение, если тип атрибута «Логический»
 +
|-
 +
|• num_value
 +
|Дробное
 +
|Значение, если тип атрибута:
 +
* «Число» (непосредственное значение)
 +
* «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
 +
* «Перечисляемый» (значение выбранного элемента перечисления)
 +
* «Дата» и «Дата/время» (Unix-время, всегда целое число)
 +
|-
 +
|• str_value
 +
|Строка
 +
|Значение, если тип атрибута «Строка»
 +
|-
 +
|bill
 +
|Массив
 +
|Чек TMDriver. Данный узел выводится только, если по заказу есть чек и если в списке фильтра полей fields запросили поле bill
 +
|-
 +
|• code
 +
|Строка
 +
|Код элемента расчета
 +
|-
 +
|• text
 +
|Строка
 +
|Наименование элемента расчета
 +
|-
 +
|• value
 +
|Строка
 +
|Значение элемента расчета (количество)
 +
|-
 +
|• sum
 +
|Строка
 +
|Стоимость элемента расчета
 +
|-
 +
|is_auction
 +
|true или false
 +
|Признак заказа-аукциона
 +
|-
 +
|payment_pay_system
 +
|Строка
 +
|Тип платежной системы ("card", "gpay", "apple_pay", "qr", "sber_pay", либо пусто, если не используется)
 
|}
 
|}
  
Строка 7249: Строка 7943:
 
<pre>
 
<pre>
 
Запрос:
 
Запрос:
POST https://ip:port/common_api/1.0/create_driver_dyn_priority
+
 
Signature: <...>
+
GET https://ip:port/common_api/1.0/get_finished_orders?start_time=20220405142210&finish_time=20220405142710&fields=state_id,crew_id,prior_crew_id,driver_id,car_id,server_time_offset,start_time,source_time,finish_time,source,source_lat,source_lon,destination,destination_lat,destination_lon,stops,trip_distance,trip_time,customer,passenger,phone,phone_to_dial,client_id,client_name,client_group_id,client_group_name,client_employee_id,order_crew_group_id,tariff_id,order_params,attribute_values,creation_way,is_prior,email,flight_number,sum,total_sum,cash_sum,cashless_sum,bonus_sum,bank_card_sum,car_mark,car_model,car_color,car_number,bill
Content-Type: application/json
 
Content-Length: <...>
 
 
 
{
 
  "driver_id": 1,
 
  "priority": 10,
 
  "start_time": "20150101100000",
 
  "finish_time": "20150101200000",
 
  "name": "За выполнение заказа в отдаленный район"
 
}
 
  
 
Ответ:
 
Ответ:
 
 
{
 
{
  "code":0,
+
  "code":0,
  "descr":"OK",
+
  "descr":"OK",
  "data":{
+
  "data":
  "dyn_priority_id":123
+
  {
  }
+
    "orders":
 +
    [
 +
      {
 +
        "id":47834,
 +
        "state_id":4,
 +
        "crew_id":17,
 +
        "prior_crew_id":0,
 +
        "driver_id":17,
 +
        "car_id":16,
 +
        "server_time_offset":0,
 +
        "start_time":"20220405142418",
 +
        "source_time":"20220405142418",
 +
        "finish_time":"20220405142708",
 +
        "source":"5-Я ЯМСКОГО ПОЛЯ УЛ., 37",
 +
        "source_lat":56.853062,
 +
        "source_lon":53.20715,
 +
        "destination":"ХОДЫНСКАЯ УЛ., 10А",
 +
        "destination_lat":0,
 +
        "destination_lon":0,
 +
        "stops":
 +
        [],
 +
        "trip_distance":10,
 +
        "trip_time":3600,
 +
        "customer":"Client 89872977005",
 +
        "passenger":"",
 +
        "phone":"89872977005",
 +
        "phone_to_dial":"",
 +
        "client_id":43111,
 +
        "client_name":"Client 89872977005",
 +
        "client_group_id":2,
 +
        "client_group_name":"Физические",
 +
        "client_employee_id":0,
 +
        "order_crew_group_id":0,
 +
        "tariff_id":2,
 +
        "order_params":
 +
        [
 +
          28,
 +
          29,
 +
          30,
 +
          55,
 +
          58,
 +
          59,
 +
          62
 +
        ],
 +
        "attribute_values":
 +
        [
 +
          {
 +
            "id":28,
 +
            "num_value":0
 +
          },
 +
          {
 +
            "id":29,
 +
            "num_value":0
 +
          },
 +
          {
 +
            "id":30,
 +
            "num_value":0
 +
          },
 +
          {
 +
            "id":55,
 +
            "num_value":1
 +
          },
 +
          {
 +
            "id":58,
 +
            "num_value":0
 +
          },
 +
          {
 +
            "id":59,
 +
            "num_value":0
 +
          },
 +
          {
 +
            "id":62,
 +
            "num_value":0
 +
          }
 +
        ],
 +
        "creation_way":"operator",
 +
        "is_prior":false,
 +
        "email":"",
 +
        "flight_number":"",
 +
        "sum":100,
 +
        "total_sum":100,
 +
        "cash_sum":50,
 +
        "cashless_sum":40,
 +
        "bonus_sum":10,
 +
        "bank_card_sum":0,
 +
        "car_mark":"Баф",
 +
        "car_model":"Fenix 3346",
 +
        "car_color":"белая",
 +
        "car_number":"а111аа",
 +
        "is_auction":false,
 +
        "payment_pay_system": "qr"
 +
      }
 +
    ]
 +
  }
 
}
 
}
 
</pre>
 
</pre>
  
=== Задание координат экипажей ===
+
=== Проведение операции по клиенту ===
 +
 
 
Метод: POST
 
Метод: POST
  
Название запроса: set_crews_coords
+
Название запроса: create_client_operation
 +
 
 +
Параметры:
  
Параметры в формате JSON:
 
 
{|
 
{|
!Параметр
+
!Параметры
 
!Тип
 
!Тип
 
!Описание
 
!Описание
Строка 7286: Строка 8064:
 
!colspan="3"|Обязательные параметры
 
!colspan="3"|Обязательные параметры
 
|-
 
|-
|crew_coords
+
|client_id
|Массив
+
|Целое
|Массив координат экипажей
+
|ИД клиента
 +
|-
 +
|sum
 +
|Дробное
 +
|Сумма
 
|-
 
|-
|&bull; crew_id
+
|oper_type
 
|Целое
 
|Целое
|ИД экипажа
+
|Тип операции:
 +
• "receipt" - приход
 +
 
 +
• "expense" - расход
 +
|-
 +
!colspan="3"|Необязательные параметры
 +
|-
 +
|oper_time
 +
|ГГГГММДДччммсс
 +
|Время создания операции (если не указано, текущее)
 +
|-
 +
|comment
 +
|Строка
 +
|Комментарий
 
|-
 
|-
|&bull; gps_id
+
|pay_type
 
|Целое
 
|Целое
|GPS идентификатор (если не задан ИД экипажа)
+
|Тип оплаты:
 +
• "cash" - наличный
 +
 
 +
• "nocash" - безналичный
 
|-
 
|-
|&bull; lat
+
|bonus_oper
|Дробное
+
|true или false
|Широта
+
|Операция по бонусному счёту. Данный параметр устарел - рекомендуется использовать "account_kind"
 
|-
 
|-
|&bull; lon
+
|account_kind
|Дробное
+
|Целое
|Долгота
+
|Тип счета:
 +
* 0 - Основной счет
 +
* 1- Бонусный счет
 +
* Остальные - нестандартные счета
 +
|}
 +
 
 +
Специальные возвращаемые коды:
 +
{|
 +
!Код
 +
!Описание
 
|-
 
|-
!colspan="3"|Необязательные параметры
+
|100
 +
|Не найден клиент ИД=CLIENT_ID
 
|-
 
|-
|speed
+
|101
|Дробное
+
|Не найден тип счета ИД=ACCOUNT_KIND
|Скорость
 
 
|}
 
|}
  
 +
Возвращаемые данные в случае успешного выполнения запроса:
 +
{|
 +
!Параметр
 +
!Тип
 +
!Описание
 +
|-
 +
|oper_id
 +
|Целое
 +
|ИД операции
 +
|}
  
Специальные возвращаемые коды: нет
+
Пример:
 
 
Возвращаемые данные в случае успешного выполнения запроса: нет
 
 
 
 
 
Пример:
 
  
 
<pre>
 
<pre>
 
Запрос:
 
Запрос:
  
POST https://ip:port/common_api/1.0/set_crews_coords
+
POST https://ip:port/common_api/1.0/create_client_operation
 
Signature: <...>
 
Signature: <...>
Content-Type: application/json
+
Content-Type: application/x-www-form-urlencoded
Content-Length: 109
+
Content-Length: <...>
  
{"crews_coords":[{"crew_id":1,"lat":11.111111,"lon":22.222222},
+
client_id=112&oper_time=20130221100719&oper_sum=300&oper_type=receipt&pay_type=cash&comment=COMMENT&account_kind=0
{"gps_id":2,"lat":33.333333,"lon":44.444444}]}
 
  
 
Ответ:
 
Ответ:
Строка 7337: Строка 8148:
 
   "code":0,
 
   "code":0,
 
   "descr":"OK",
 
   "descr":"OK",
   "data":{}
+
   "data":{
 +
    "oper_id":31
 +
 
 +
  }
 
}
 
}
 
</pre>
 
</pre>
  
=== Изменение информации по заказу ===
+
=== Запрос операций по клиенту ===
Метод: POST
+
 
 +
Метод: GET
  
Название запроса: update_order
+
Название запроса: get_client_operations
  
Параметры в формате JSON:
+
Параметры:
  
 
{|
 
{|
!Параметр
+
!Параметры
 
!Тип
 
!Тип
 
!Описание
 
!Описание
Строка 7355: Строка 8170:
 
!colspan="3"|Обязательные параметры
 
!colspan="3"|Обязательные параметры
 
|-
 
|-
|order_id
+
|client_id
 
|Целое
 
|Целое
|ИД заказа
+
|ИД клиента
 
|-
 
|-
!colspan="3"|Необязательные параметры
+
|start_time
 +
|ГГГГММДДччммсс
 +
|Начало периода
 
|-
 
|-
|phone
+
|finish_time
|Строка, <= 30 символов
 
|Номер телефона
 
|-
 
|source_time
 
 
|ГГГГММДДччммсс
 
|ГГГГММДДччммсс
|Время подачи
+
|Конец периода
 
|-
 
|-
|is_prior
+
!colspan="3"|Необязательные параметры
|true или false
 
|Предварительный заказ
 
 
|-
 
|-
|customer
+
|account_kind
|Строка
+
|Целое
|Заказчик
+
|Тип счета:
 +
* 0 - Основной счет
 +
* 1- Бонусный счет
 +
* Остальные - нестандартные счета
 +
|}
 +
 
 +
Специальные возвращаемые коды:
 +
{|
 +
!Код
 +
!Описание
 
|-
 
|-
|passenger
+
|100
|Строка
+
|Не найден клиент ИД=CLIENT_ID
|Пассажир
 
 
|-
 
|-
|comment
+
|101
|Строка
+
|Не найден тип счета ИД=ACCOUNT_KIND
|Комментарий
+
|}
 +
 
 +
Возвращаемые данные в случае успешного выполнения запроса:
 +
{|
 +
!Параметр
 +
!Тип
 +
!Описание
 
|-
 
|-
|crew_group_id
+
|oper_id
 
|Целое
 
|Целое
|ИД группы экипажей
+
|ИД операции
 +
|-
 +
|oper_time
 +
|ГГГГММДДччммсс
 +
|Время создания операции
 +
|-
 +
|sum
 +
|Дробное
 +
|Сумма
 
|-
 
|-
|client_id
+
|order_id
 
|Целое
 
|Целое
|ИД клиента
+
|Заказ, связанный с операцией
 
|-
 
|-
|uds_id
+
|oper_type
 
|Целое
 
|Целое
|ИД службы ЕДС
+
|Тип операции:
 +
• "receipt" - приход
 +
 
 +
• "expense" - расход
 +
|-
 +
|pay_type
 +
|Целое
 +
|Тип оплаты:
 +
• "cash" - наличный
 +
 
 +
• "nocash" - безналичный
 
|-
 
|-
|tariff_id
+
|account_kind
 
|Целое
 
|Целое
|ИД тариф
+
|Тип счета:
 +
* 0 - Основной счет
 +
* 1- Бонусный счет
 +
* Остальные - нестандартные счета
 
|-
 
|-
|addresses
+
|name
|Массив
+
|Строка
|Массив адресов. Первый элемент — адрес
+
|Наименование
подачи(обязательно), последний — адрес назначения,
 
между ними — остановки.
 
 
|-
 
|-
|&bull; address
+
|comment
 
|Строка
 
|Строка
|Адрес подачи
+
|Комментарий
 
|-
 
|-
|&bull; lat
+
|cancelled_by_oper_id
|Дробное
+
|Целое
|Широта адреса
+
|ИД операции отмены (для отмененной операции)
 
|-
 
|-
|&bull; lon
+
|cancelled_oper_id
|Дробное
+
|Целое
|Долгота адреса
+
|ИД отмененной операции (для операции отмены)
 +
|}
 +
 
 +
Пример:
 +
 
 +
<pre>
 +
Запрос:
 +
 
 +
GET https://ip:port/common_api/1.0/get_client_operations?client_id=112&start_time=20130201092112&finish_time=20130221092112&account_kind=0 HTTP/1.1
 +
Signature: <...>
 +
 
 +
Ответ:
 +
 
 +
{
 +
  "code":0,
 +
  "descr":"OK",
 +
  "data":{
 +
    "operations":[
 +
      {
 +
        "oper_id":111,
 +
        "oper_time":"20130219091328",
 +
        "sum":"21,8",
 +
        "order_id":11800,
 +
        "oper_type":"receipt",
 +
        "pay_type":"cash",
 +
        "account_kind":0,
 +
        "name":"Пополнение счета",
 +
        "comment":"Комментарий",
 +
        "cancelled_by_oper_id":0,
 +
        "cancelled_oper_id":112
 +
      },
 +
      {
 +
        "oper_id":112,
 +
        "oper_time":"20130220112245",
 +
        "sum":"4500",
 +
        "order_id":11801,
 +
        "oper_type":"receipt",
 +
        "pay_type":"cash",
 +
        "account_kind":0,
 +
        "name":"Пополнение счета",
 +
        "comment":"Комментарий"
 +
        "cancelled_by_oper_id":111,
 +
        "cancelled_oper_id":0
 +
      }
 +
    ]
 +
  }
 +
}
 +
</pre>
 +
 
 +
=== Проведение операции по водителю ===
 +
 
 +
Метод: POST
 +
 
 +
Название запроса: create_driver_operation
 +
 
 +
Параметры  в формате JSON:
 +
 
 +
{|
 +
!Параметр
 +
!Тип
 +
!Описание
 
|-
 
|-
|order_params
+
!colspan="3"|Обязательные параметры
|Массив
 
|Массив параметров заказа. Устарело. Рекомендуется использовать параметр attribute_values.
 
 
|-
 
|-
|&bull;
+
|driver_id
 
|Целое
 
|Целое
|ИД параметра заказа
+
|ИД водителя
 
|-
 
|-
|attribute_values
+
|oper_sum
|Массив
+
|Дробное
|Массив значений атрибутов
+
|Сумма
 
|-
 
|-
|&bull; id
+
|oper_type
|Целое
+
|Строка
|Идентификатор атрибута
+
|Тип операции:
 +
 
 +
• receipt - приход
 +
 
 +
• expense - расход
 
|-
 
|-
|&bull; bool_value
+
!colspan="3"|Необязательные параметры
|true или false
 
|Значение, если тип атрибута «Логический»
 
 
|-
 
|-
|&bull; num_value
+
|name
|Дробное
 
|Значение, если тип атрибута:
 
* «Число» (непосредственное значение)
 
* «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
 
* «Перечисляемый» (значение выбранного элемента перечисления)
 
|-
 
|&bull; str_value
 
 
|Строка
 
|Строка
|Значение, если тип атрибута «Строка»
+
|Наименование операции
 
|-
 
|-
|cost_order
+
|oper_time
|Дробное
+
|ГГГГММДДччммсс
|Сумма заказа
+
|Время создания операции (если не задано, текущее)  !! Не используется с ТМ 3.7
 
|-
 
|-
|state_id
+
|comment
|Целое
+
|Строка
|ИД состояния заказа
+
|Комментарий
 
|-
 
|-
|discount_id
+
|account_kind
 
|Целое
 
|Целое
|ИД скидки
+
|ИД типа счета (0 - основной счет), по умолчанию 0
 +
|}
 +
 
 +
Специальные возвращаемые коды:
 +
 
 +
{|
 +
!Код
 +
!Описание
 
|-
 
|-
|auto_select_discount
+
|100
|true или false
+
|Водитель не найден ИД=DRIVER_ID
|Автоматически подобрать скидку, если не указана явно
 
 
|-
 
|-
|auto_select_tariff
+
|101
|true или false
+
|Не найден тип счета ИД=ACCOUNT_KIND
|Автоматически подобрать тариф, если не указан явно
+
|}
 +
 
 +
Возвращаемые данные в случае успешного выполнения запроса:
 +
 
 +
{|
 +
!Параметр
 +
!Тип
 +
!Описание
 
|-
 
|-
|auto_recalc_cost
+
|oper_id
|true или false
 
|Автоматически пересчитать сумму заказа
 
|-
 
|auto_update_order_params
 
|true или false
 
|Автоматически обновить параметры заказа по клиенту и группе клиента
 
|-
 
|email
 
|Строка
 
|Email для уведомлений
 
|-
 
|prior_to_current_before_minutes
 
 
|Целое
 
|Целое
|Время перехода из предварительного в текущие заказы, мин
+
|ИД операции
|-
 
|flight_number
 
|Строка
 
|Номер рейса
 
|-
 
|need_custom_validate
 
|true или false
 
|Использовать специальную проверку перед изменением заказа
 
 
|}
 
|}
  
Специальные возвращаемые коды:
+
 
{|
+
Пример:
!Код
+
 
!Описание
+
<pre>
|-
+
 
|100
+
Запрос:
|Заказ не найден
+
 
|-
+
POST https://ip:port/common_api/1.0/create_driver_operation
|101
+
Signature: <...>
|Состояние заказа не найдено
+
Content-Type: application/json
|-
+
Content-Length: 99
|102
+
 
|Тариф не найден
+
{
|-
+
  "driver_id": 1,
|103
+
  "oper_sum": 10.00,
|Скидка не найдена
+
  "oper_type": "receipt",
|-
+
  "name": "Пополнение счета",
|104
+
  "oper_time": "20141210100719",
|Группа экипажа не найдена
+
  "comment": "Комментарий к операции"
|-
+
    "account_kind": 1
|105
+
}
|Служба не найдена
+
 
 +
Ответ:
 +
 
 +
{
 +
  "code":0,
 +
  "descr":"OK",
 +
  "data":{
 +
  "oper_id":31
 +
  }
 +
}
 +
 
 +
</pre>
 +
 
 +
=== Запрос операций по водителю ===
 +
 
 +
Метод: GET
 +
 
 +
Название запроса: get_driver_operations
 +
 
 +
Параметры:
 +
 
 +
{|
 +
!Параметр
 +
!Тип
 +
!Описание
 +
|-
 +
!colspan="3"|Обязательные параметры
 
|-
 
|-
|106
+
|driver_id
|Клиент не найден
+
|Целое
 +
|ИД водителя
 
|-
 
|-
|107
+
|start_time
|Изменение состояния не соответствует необходимым условиям
+
|ГГГГММДДччммсс
 +
|Начало периода
 
|-
 
|-
|108
+
|finish_time
|Параметр заказа не найден
+
|ГГГГММДДччммсс
 +
|Конец периода
 
|-
 
|-
|109
+
!colspan="3"|Необязательные параметры
|Атрибут не может быть привязан к заказу
 
 
|-
 
|-
|110
+
|account_kind
|Ошибка специальной проверки заказа перед изменением. В ответе будет возвращаться:
+
|Целое
  "data": {
+
|ИД типа счета (0 - основной счет), по умолчанию 0
    "message":"Текст ошибки для пользователя."
 
  }
 
 
|}
 
|}
  
Возвращаемые данные в случае успешного выполнения запроса: нет.
 
  
Пример:
+
Специальные возвращаемые коды:
 +
{|
 +
!Код
 +
!Описание
 +
|-
 +
|100
 +
|Не найден водитель ИД=DRIVER_ID
 +
|-
 +
|101
 +
|Не найден тип счета ИД=ACCOUNT_KIND
 +
|}
  
<pre>
 
POST https://ip:port/common_api/1.0/update_order HTTP/1.1
 
Signature: <...>
 
Content-Type: application/json
 
Content-Length: <...>
 
  
{
+
Возвращаемые данные в случае успешного выполнения запроса:
    "order_id": 12105,
+
{|
    "phone": "555",
+
!Параметр
    "source_time": "20141216095044",
+
!Тип
    "is_prior": true,
+
!Описание
    "auto_select_discount": true,
+
|-
    "auto_select_tariff": true,
+
|oper_id
    "auto_recalc_cost": true,
+
|Целое
    "auto_update_order_params": true,
+
|ИД операции
    "customer": "Заказчик",
+
|-
    "passenger": "Пассажир",
+
|oper_time
    "comment": "Комментарий",
+
|ГГГГММДДччммсс
    "crew_group_id": 8,
+
|Время создания операции
    "client_id": 30,
+
|-
    "tariff_id": 33,
+
|sum
    "addresses":[
+
|Дробное
      {"address":"SOURCE","lat":56.896817,"lon":53.147830},     
+
|Сумма
      {"address":"STOP1","lat":56.845452,"lon":53.226775},
+
|-
      {"address":"STOP2"},
+
|order_id
      {"address":"DESTINATION","lat":56.861230,"lon":53.241870}
+
|Целое
    ],
+
|Заказ, связанный с операцией
    "cost_order": 200,
+
|-
    "state_id": 55,
+
|oper_type
    "discount_id": 1,
+
|Целое
    "email" : "mail@mail.ru",
+
|Тип операции:
    "prior_to_current_before_minutes":30,
+
 
    "flight_number":"Number",
+
"receipt" - приход
    "need_custom_validate":false,
+
 
    "attribute_values": [
+
"expense" - расход
      {
 
            "id": 1,
 
            "bool_value": true
 
      },
 
      {
 
            "id": 2,
 
            "num_value": 1
 
      },
 
      {
 
            "id": 3,
 
            "num_value": 10
 
      },
 
      {
 
            "id": 4,
 
            "str_value": "строка"
 
      }
 
  ]
 
}
 
 
 
Ответ:
 
{
 
  "code":0,
 
  "descr":"OK",
 
  "data":{}
 
}
 
</pre>
 
 
 
=== Анализ телефона ===
 
 
 
Метод: GET
 
 
 
Название запроса: analyze_phone
 
 
 
Параметры:
 
{|
 
!Параметр
 
!Тип
 
!Описание
 
 
|-
 
|-
!colspan="3"|Обязательные параметры
+
|name
 +
|Строка
 +
|Наименование
 
|-
 
|-
|phone
+
|comment
 
|Строка
 
|Строка
|Номер телефона
+
|Комментарий
 
|-
 
|-
!colspan="3"|Необязательные параметры
+
|account_kind
 +
|Целое
 +
| ИД типа счета
 
|-
 
|-
|search_in_drivers_mobile
+
|cancelled_by_oper_id
|true или false
+
|Целое
|Искать среди телефонов водителей
+
|ИД операции отмены (для отмененной операции)
 
|-
 
|-
|search_in_clients
+
|cancelled_oper_id
|true или false
+
|Целое
|Искать среди телефонов клиентов
+
|ИД отмененной операции (для операции отмены)
|-
 
|search_in_phones
 
|true или false
 
|Искать в справочнике телефонов
 
 
|}
 
|}
 
 
Если параметры search_in_drivers_mobile, search_in_clients, search_in_phones не заданы, то поиск телефона будет происходить во всех справочниках.
 
 
Специальные возвращаемые коды:
 
{|
 
!Код
 
!Описание
 
|-
 
|100
 
|Телефон не найден
 
|}
 
 
Возвращаемые данные в случае успешного выполнения запроса:
 
{|
 
!Параметр
 
!Тип
 
!Описание
 
|-
 
|phone_type
 
|Строка
 
|Может принимать значения: «driver_mobile», «client», «phone».
 
|-
 
|id
 
|Целое
 
|ИД водителя, клиента, телефона из справочника.
 
|-
 
|client_employee_id
 
|Целое
 
|ИД сотрудника клиента (если телефон найден среди телефонов клиента)
 
|}
 
 
  
 
Пример:
 
Пример:
Строка 7673: Строка 8523:
 
Запрос:
 
Запрос:
  
GET /common_api/1.0/analyze_phone?
+
GET https://ip:port/common_api/1.0/get_driver_operations?
phone=89501234567&search_in_drivers_mobile=true&search_in_drivers_home=true&search_in_clients=true&
+
driver_id=112&start_time=20130201092112&finish_time=20130221092112
search_in_phones=true
+
Signature: <...>
 
 
Host: 127.0.0.1:8089
 
Keep-Alive: 300
 
Connection: keep-alive
 
Signature: 4285286a446064353f4a951b721c54f7
 
  
 
Ответ:
 
Ответ:
Строка 7688: Строка 8533:
 
   "descr":"OK",
 
   "descr":"OK",
 
   "data":{
 
   "data":{
  "phone_type":"client",
+
    "operations":[
  "id":1
+
      {
  "client_employee_id":2
+
        "oper_id":111,
  }
+
        "oper_time":"20130219091328",
}
+
        "sum":"21,8",
 
+
        "order_id":11800,
</pre>
+
        "oper_type":"receipt",
 
+
        "name":"DRIVER_OPERATION_1",
=== Показать сообщение в ТМ ===
+
        "comment":"DRIVER_OPERATION_COMMENT_1",
 +
        "account_kind":0,
 +
        "cancelled_by_oper_id":0,
 +
        "cancelled_oper_id":112
 +
      },
 +
      {
 +
        "oper_id":112,
 +
        "oper_time":"20130220112245",
 +
        "sum":"4500",
 +
        "order_id":11801,
 +
        "oper_type":"receipt",
 +
        "name":"DRIVER_OPERATION_2",
 +
        "comment":"DRIVER_OPERATION_COMMENT_2",
 +
        "account_kind":0,
 +
        "cancelled_by_oper_id":111,
 +
        "cancelled_oper_id":0
 +
      }
 +
    ]
 +
  }
 +
}
 +
</pre>
  
 +
=== Назначение динамического приоритета водителю ===
 
Метод: POST
 
Метод: POST
  
Название запроса: show_tm_message
+
Название запроса: create_driver_dyn_priority
  
Параметры:
+
Параметры в формате JSON:
  
 
{|
 
{|
Строка 7711: Строка 8577:
 
!colspan="3"|Обязательные параметры
 
!colspan="3"|Обязательные параметры
 
|-
 
|-
|text
+
|driver_id
|Строка
+
|Целое
|Текст сообщения
+
|ИД водителя (должно быть что-то одно: либо driver_id, либо crew_id)
 
|-
 
|-
!colspan="3"|Необязательные параметры
+
|crew_id
 +
|Целое
 +
|ИД экипажа (должно быть что-то одно: либо driver_id, либо crew_id)
 
|-
 
|-
|header
+
|priority
|Строка
+
|Целое
|Заголовок сообщения
+
|Приоритет
 
|-
 
|-
|timeout
+
|start_time
|Целое
+
|ГГГГММДДччммсс
|Скрывать сообщение через, сек. (0 — не скрывать)
+
|Время начала действия приоритета
 
|-
 
|-
|users
+
|finish_time
|Массив
+
|ГГГГММДДччммсс
|Массив пользователей (если не указаны — отправлять всем)
+
|Время окончания действия приоритета
 
|-
 
|-
|&bull;
+
|name
|Целое
+
|Строка
|ИД пользователя
+
|Наименование приоритета
 
|}
 
|}
 
  
 
Специальные возвращаемые коды:
 
Специальные возвращаемые коды:
 
 
{|
 
{|
 
!Код
 
!Код
Строка 7742: Строка 8608:
 
|-
 
|-
 
|100
 
|100
|Пользователи для отправки сообщения не найдены
+
|Водитель не найден ИД=DRIVER_ID
 +
|-
 +
|101
 +
|Экипаж не найден ИД=CREW_ID
 +
|-
 +
|102
 +
|Время начала действия приоритета должно быть меньше времени окончания
 +
|-
 +
|103
 +
|Время действия приоритета уже истекло
 
|}
 
|}
  
 +
Возвращаемые данные в случае успешного выполнения запроса:
 +
{|
 +
!Параметр
 +
!Тип
 +
!Описание
 +
|-
 +
|dyn_priority_id
 +
|Целое
 +
|ИД созданного динамического приоритета
 +
|}
  
Возвращаемые данные в случае успешного выполнения запроса: нет.
+
Пример:
  
Пример:
 
 
<pre>
 
<pre>
 
 
Запрос:
 
Запрос:
POST /common_api/1.0/show_tm_message
+
POST https://ip:port/common_api/1.0/create_driver_dyn_priority
Host: 127.0.0.1:8089
+
Signature: <...>
Keep-Alive: 300
+
Content-Type: application/json
Connection: keep-alive
+
Content-Length: <...>
Signature: 4285286a446064353f4a951b721c54f7
 
  
 
{
 
{
   "text": "Текст сообщения",
+
   "driver_id": 1,
   "users": [
+
   "priority": 10,
      1,
+
   "start_time": "20150101100000",
      2,
+
   "finish_time": "20150101200000",
      3
+
   "name": "За выполнение заказа в отдаленный район"
   ],
 
   "header": "Заголовок",
 
   "timeout": 12
 
 
}
 
}
 
  
 
Ответ:
 
Ответ:
  
 
{
 
{
  "code":0,
+
  "code":0,
  "descr":"OK",
+
  "descr":"OK",
  "data":{}
+
  "data":{
 +
  "dyn_priority_id":123
 +
  }
 
}
 
}
 
 
</pre>
 
</pre>
  
=== Запрос списка купленных смен водителей ===
+
=== Задание координат экипажей ===
 +
Метод: POST
  
Метод: GET
+
Название запроса: set_crews_coords
 
 
Название запроса: get_driver_shifts
 
 
 
Параметры:
 
  
 +
Параметры в формате JSON:
 
{|
 
{|
 
!Параметр
 
!Параметр
Строка 7795: Строка 8672:
 
!colspan="3"|Обязательные параметры
 
!colspan="3"|Обязательные параметры
 
|-
 
|-
|start_time
+
|crew_coords
|ГГГГММДДччммсс
+
|Массив
|Начало периода
+
|Массив координат экипажей
 
|-
 
|-
|finish_time
+
|&bull; crew_id
|ГГГГММДДччммсс
+
|Целое
|Конец периода
+
|ИД экипажа
 
|-
 
|-
!colspan="3"|Необязательные параметры
+
|&bull; gps_id
|-
 
|driver_id
 
 
|Целое
 
|Целое
|ИД водителя
+
|GPS идентификатор (если не задан ИД экипажа). Данный параметр устарел - не применяется, начиная с версии 3.9
 
|-
 
|-
|new_shifts
+
|&bull; lat
|true или false
+
|Дробное
|Включить в ответ новые смены (по умолчанию true)
+
|Широта
 
|-
 
|-
|in_work_shifts
+
|&bull; lon
|true или false
+
|Дробное
|Включить в ответ смены в работе (по умолчанию true)
+
|Долгота
 
|-
 
|-
|finished_shifts
+
!colspan="3"|Необязательные параметры
|true или false
 
|Включить в ответ выполненные смены (по умолчанию true)
 
 
|-
 
|-
|failed_shifts
+
|speed
|true или false
+
|Дробное
|Включить в ответ неуспешно завершенные смены (по умолчанию true)
+
|Скорость
 
|-
 
|-
|returned_shifts
+
|direction
|true или false
+
|Целое
|Включить в ответ возвращенные смены (по умолчанию false)
+
|Направление движения (0-Север, 90-Восток, 180-Юг, 270-Запад, -1-не задано)
 
|}
 
|}
 +
  
 
Специальные возвращаемые коды: нет
 
Специальные возвращаемые коды: нет
  
Возвращаемые данные в случае успешного выполнения запроса:
+
Возвращаемые данные в случае успешного выполнения запроса: нет
 +
 
 +
 
 +
Пример:
 +
 
 +
<pre>
 +
Запрос:
 +
 
 +
POST https://ip:port/common_api/1.0/set_crews_coords HTTP/1.1
 +
Signature: <...>
 +
Content-Type: application/json
 +
Content-Length: <...>
  
{|
+
{
!Параметр
+
  "crews_coords":[
!Тип
+
    {
!Описание
+
      "crew_id":1,
|-
+
      "lat":11.111111,
|shifts
+
      "lon":22.222222,
|Массив
+
      "speed":66.66,
|Массив купленных смен
+
      "direction":333
|-
+
    },
|&bull; shift_id
+
    {
|Целое
+
      "gps_id":2,
|ИД купленной смены
+
      "lat":33.333333,
|-
+
      "lon":44.444444
|&bull; driver_id
+
    }
|Целое
+
  ]
|ИД водителя
+
}
 +
 
 +
Ответ:
 +
 
 +
{
 +
  "code":0,
 +
  "descr":"OK",
 +
  "data":{}
 +
}
 +
</pre>
 +
 
 +
=== Изменение информации по заказу ===
 +
Метод: POST
 +
 
 +
Название запроса: update_order
 +
 
 +
Параметры в формате JSON:
 +
 
 +
{|
 +
!Параметр
 +
!Тип
 +
!Описание
 
|-
 
|-
|&bull;driver_name
+
!colspan="3"|Обязательные параметры
|Строка
 
|ФИО водителя
 
 
|-
 
|-
|&bull; plan_shift_id
+
|order_id
|Строка
+
|Целое
|ИД запланированной смены
+
|ИД заказа
 
|-
 
|-
|&bull; plan_shift_name
+
!colspan="3"|Необязательные параметры
|Строка
 
|Наименование запланированной смены
 
 
|-
 
|-
|&bull; plan_shift_cost
+
|phone
|Дробное
+
|Строка, <= 30 символов
|Цена смены
+
|Номер телефона
 
|-
 
|-
|&bull; plan_shift_type
+
|source_time
|Строка
+
|ГГГГММДДччммсс
|Тип смены («limited» - срочная, «unlimited» - бессрочная)
+
|Время подачи
 
|-
 
|-
|&bull; plan_shift_start_time
+
|is_prior
|ГГГГММДДччммсс
+
|true или false
|План-начало смены (для срочных)
+
|Предварительный заказ
 
|-
 
|-
|&bull; plan_shift_finish_time
+
|customer
|ГГГГММДДччммсс
+
|Строка
|План-конец смены (для срочных)
+
|Заказчик
 
|-
 
|-
|&bull; plan_shift_length
+
|passenger
|Целое
+
|Строка
|План продолжительность смены, ч. (для бессрочных)
+
|Пассажир
 +
|-
 +
|comment
 +
|Строка
 +
|Комментарий
 
|-
 
|-
|&bull; plan_shift_crew_group_id
+
|crew_group_id
|Целое  
+
|Целое
|ИД первой группы экипажей, которая может купить смену
+
|ИД группы экипажей
 
|-
 
|-
|&bull; plan_shift_crew_groups
+
|client_id
|Массив
+
|Целое
|ИД групп экипажей, которые могут купить смену
+
|ИД клиента
 
|-
 
|-
|&bull; shift_state
+
|uds_id
|Строка
+
|Целое
|Состояние смены («new» - новая, «in_work» - в работе, «finished» - завершена успешно, «failed» - завершена неуспешно)
+
|ИД службы ЕДС
 
|-
 
|-
|&bull; buy_time
+
|tariff_id
|ГГГГММДДччммсс
+
|Целое
|Время продажи смены водителю
+
|ИД тариф
 
|-
 
|-
|&bull; is_returned
+
|addresses
|true или false
+
|Массив
|Признак возвращенной смены
+
|Массив адресов. Первый элемент — адрес
 +
подачи(обязательно), последний — адрес назначения,
 +
между ними — остановки.
 
|-
 
|-
|&bull; return_time
+
|&bull; address
|ГГГГММДДччммсс
+
|Строка
|Время возврата смены
+
|Адрес подачи
 
|-
 
|-
|&bull; orders_count
+
|&bull; lat
|Целое
+
|Дробное
|Количество заказов, выполненных водителем за смену
+
|Широта адреса
 
|-
 
|-
|&bull; orders_sum
+
|&bull; lon
|Дробное  
+
|Дробное
|Сумма заказов, выполненных водителем за смену
+
|Долгота адреса
 
|-
 
|-
|&bull; fact_length
+
|order_params
|Дробное
+
|Массив
|Фактическая продолжительность смены, ч.
+
|Массив параметров заказа. Устарело. Рекомендуется использовать параметр attribute_values.
|}
+
|-
 
+
|&bull;
Пример:
+
|Целое
 
+
|ИД параметра заказа
<pre>
+
|-
Запрос:
+
|attribute_values
 
+
|Массив
GET https://ip:port/common_api/1.0/get_driver_shifts?start_time=20140101101010&finish_time=20140101202020
+
|Массив значений атрибутов
Signature: <...>
+
|-
 
+
|&bull; id
 
+
|Целое
Ответ:
+
|Идентификатор атрибута
 
+
|-
{
+
|&bull; bool_value
  "code":0,
+
|true или false
  "descr":"OK",
+
|Значение, если тип атрибута «Логический»
  "data":{
+
|-
    "shifts":[
+
|&bull; num_value
      {
+
|Дробное
        "shift_id":1,
+
|Значение, если тип атрибута:
        "driver_id":1,
+
* «Число» (непосредственное значение)
        "driver_name":"DRIVER_1",
+
* «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
        "plan_shift_id":1,
+
* «Перечисляемый» (значение выбранного элемента перечисления)
        "plan_shift_name":"PLAN_SHIFT_1",
+
* «Дата» и «Дата/время» (Unix-время, всегда целое число)
        "plan_shift_cost":100,
+
|-
        "plan_shift_type":"limited",
+
|&bull; str_value
        "plan_shift_start_time":"20140101101010",
+
|Строка
        "plan_shift_finish_time":"20140101101010",
+
|Значение, если тип атрибута «Строка»
        "plan_shift_length":null,
+
|-
        "plan_shift_crew_group_id":1,
+
|cost_order
        "shift_state":new,
+
|Дробное
        "buy_time":"20140101101010",
+
|Сумма заказа
        "is_returned":false,
+
|-
        "return_time":null,
+
|state_id
        "orders_count":10,
+
|Целое
        "orders_sum":1000,
+
|ИД состояния заказа
        "fact_length":1.2
 
      },
 
      {
 
        "shift_id":2,
 
        "driver_id":2,
 
        "driver_name":"DRIVER_2",
 
        "plan_shift_id":2,
 
        "plan_shift_name":"PLAN_SHIFT_2",
 
        "plan_shift_cost":200,
 
        "plan_shift_type":"unlimited",
 
        "plan_shift_start_time":null,
 
        "plan_shift_finish_time":null,
 
        "plan_shift_length":8,
 
        "plan_shift_crew_group_id":null,
 
        "shift_state":new,
 
        "buy_time":"20140101101010",
 
        "is_returned":true,
 
        "return_time":"20140101101010",
 
        "orders_count":0,
 
        "orders_sum":0,
 
        "fact_length":0
 
      }
 
    ]
 
  }
 
}
 
</pre>
 
 
 
=== Запрос списка запланированных смен водителей ===
 
 
 
Метод: GET
 
 
 
Название запроса: get_driver_plan_shifts
 
 
 
Параметры:
 
 
 
{|
 
!Параметр
 
!Тип
 
!Описание
 
 
|-
 
|-
!colspan="3"|Обязательные параметры
+
|discount_id
 +
|Целое
 +
|ИД скидки
 
|-
 
|-
|start_time
+
|auto_select_discount
|ГГГГММДДччммсс
+
|true или false
|Начало периода (если включаем в ответ срочные смены)
+
|Автоматически подобрать скидку, если не указана явно
 
|-
 
|-
|finish_time
+
|auto_select_tariff
|ГГГГММДДччммсс
+
|true или false
|Конец периода (если включаем в ответ срочные смены)
+
|Автоматически подобрать тариф, если не указан явно
 
|-
 
|-
!colspan="3"|Необязательные параметры
+
|auto_recalc_cost
 +
|true или false
 +
|Автоматически пересчитать сумму заказа
 
|-
 
|-
|limited_shifts
+
|auto_update_order_params
|true или false  
+
|true или false
|Включить в ответ срочные смены (по умолчанию true)
+
|Автоматически обновить параметры заказа по клиенту и группе клиента
 +
|-
 +
|email
 +
|Строка
 +
|Email для уведомлений
 +
|-
 +
|prior_to_current_before_minutes
 +
|Целое
 +
|Время перехода из предварительного в текущие заказы, мин
 +
|-
 +
|flight_number
 +
|Строка
 +
|Номер рейса
 +
|-
 +
|need_custom_validate
 +
|true или false
 +
|Использовать специальную проверку перед изменением заказа
 
|-
 
|-
|unlimited_shifts
+
|client_employee_id
|true или false
+
|Целое
|Включить в ответ бессрочные смены (по умолчанию true)
+
|ИД сотрудника, должен быть подчиненным старого ИД клиента в заявке, если не передавали новый ИД клиента, либо подчиненным нового ИД клиента, если передали новый ИД клиента
 
|}
 
|}
  
Специальные возвращаемые коды: нет
+
Специальные возвращаемые коды:
 
 
Возвращаемые данные в случае успешного выполнения запроса:
 
 
{|
 
{|
!Параметр
+
!Код
!Тип
 
 
!Описание
 
!Описание
 
|-
 
|-
|plan_shifts
+
|100
|Массив
+
|Заказ не найден
|Массив запланированных смен
 
 
|-
 
|-
|&bull; plan_shift_id
+
|101
|Целое
+
|Состояние заказа не найдено
|ИД запланированной смены
 
 
|-
 
|-
|&bull; plan_shift_name
+
|102
|Строка
+
|Тариф не найден
|Наименование запланированной смены
 
 
|-
 
|-
|&bull; plan_shift_comment
+
|103
|Строка
+
|Скидка не найдена
|Комментарий запланированной смены
 
 
|-
 
|-
|&bull; plan_shift_cost
+
|104
|Дробное
+
|Группа экипажа не найдена
|Цена смены
 
 
|-
 
|-
|&bull; plan_shift_type
+
|105
|Строка
+
|Служба не найдена
|Тип смены («limited» - срочная, «unlimited» - бессрочная)
 
 
|-
 
|-
|&bull; plan_shift_start_time
+
|106
|ГГГГММДДччммсс
+
|Клиент не найден
|План-начало смены (для срочных)
+
|-
 +
|107
 +
|Изменение состояния не соответствует необходимым условиям
 +
|-
 +
|108
 +
|Параметр заказа не найден
 +
|-
 +
|109
 +
|Атрибут не может быть привязан к заказу
 +
|-
 +
|110
 +
|Ошибка специальной проверки заказа перед изменением. В ответе будет возвращаться:
 +
  "data": {
 +
    "message":"Текст ошибки для пользователя."
 +
  }
 
|-
 
|-
|&bull; plan_shift_finish_time
+
|111
|ГГГГММДДччммсс
+
|Недостаточно средств на безналичном счете клиента в ТМ
|План-конец смены (для срочных)
 
 
|-
 
|-
|&bull; plan_shift_length
+
|112
|Целое
+
|Для клиента запрещена оплата заказа наличными. Клиент должен максимально использовать в заказе безналичную оплату (оплату с основного счета)
|План продолжительность смены, ч. (для бессрочных)
 
 
|-
 
|-
|&bull; plan_shift_crew_group_id
+
|113
|Целое
+
|Клиент заблокирован
|ИД первой группы экипажей, которая может купить смену
 
 
|-
 
|-
|&bull; plan_shift_crew_groups
+
|114
|Массив
+
|Сотрудник клиента не найден
|ИД групп экипажей, которые могут купить смену
 
 
|-
 
|-
|&bull; max_sell_count
+
|115
|Целое
+
|Не найден клиент, который может использовать собственный счет для оплаты заказов
|Максимальное количество продаж смены
 
 
|-
 
|-
|&bull; sold_count
+
|116
|Целое
+
|Сотрудник клиента заблокирован
|Количество продаж смены
 
 
|}
 
|}
 +
 +
Возвращаемые данные в случае успешного выполнения запроса: нет.
  
 
Пример:
 
Пример:
  
 
<pre>
 
<pre>
Запрос:
+
POST https://ip:port/common_api/1.0/update_order HTTP/1.1
 
 
GET https://ip:port/common_api/1.0/get_driver_plan_shifts?start_time=20140101101010&finish_time=20140101202020
 
 
Signature: <...>
 
Signature: <...>
 
+
Content-Type: application/json
 
+
Content-Length: <...>
Ответ:
 
  
 
{
 
{
  "code":0,
+
    "order_id": 12105,
  "descr":"OK",
+
    "phone": "555",
  "data":{
+
    "source_time": "20141216095044",
     "plan_shifts":[
+
    "is_prior": true,
       {
+
    "auto_select_discount": true,
        "plan_shift_id":1,
+
    "auto_select_tariff": true,
        "plan_shift_name":"PLAN_SHIFT_1",
+
    "auto_recalc_cost": true,
        "plan_shift_comment":"PLAN_SHIFT_COMMENT_1",
+
    "auto_update_order_params": true,
        "plan_shift_cost":100,
+
    "customer": "Заказчик",
        "plan_shift_type":"limited",
+
    "passenger": "Пассажир",
        "plan_shift_start_time":"20140101101010",
+
    "comment": "Комментарий",
        "plan_shift_finish_time":"20140101101010",
+
    "crew_group_id": 8,
        "plan_shift_length":null,
+
    "client_id": 30,
        "plan_shift_crew_group_id":1,
+
    "tariff_id": 33,
        "max_sell_count":100,
+
     "addresses":[
        "sold_count":10
+
      {"address":"SOURCE","lat":56.896817,"lon":53.147830},        
 +
      {"address":"STOP1","lat":56.845452,"lon":53.226775},
 +
      {"address":"STOP2"},  
 +
      {"address":"DESTINATION","lat":56.861230,"lon":53.241870}
 +
    ],
 +
    "cost_order": 200,
 +
    "state_id": 55,
 +
    "discount_id": 1,
 +
    "email" : "mail@mail.ru",
 +
    "prior_to_current_before_minutes":30,
 +
    "flight_number":"Number",
 +
    "need_custom_validate":false,
 +
    "attribute_values": [
 +
      {
 +
            "id": 1,
 +
            "bool_value": true
 +
      },
 +
      {
 +
            "id": 2,
 +
            "num_value": 1
 +
      },
 +
      {
 +
            "id": 3,
 +
            "num_value": 10
 
       },
 
       },
 
       {
 
       {
        "plan_shift_id":2,
+
            "id": 4,
        "plan_shift_name":"PLAN_SHIFT_2",
+
            "str_value": "строка"
        "plan_shift_comment":"PLAN_SHIFT_COMMENT_2",
 
        "plan_shift_cost":200,
 
        "plan_shift_type":"unlimited",
 
        "plan_shift_start_time":null,
 
        "plan_shift_finish_time":null,
 
        "plan_shift_length":8,
 
        "plan_shift_crew_group_id":2,
 
        "max_sell_count":200,
 
        "sold_count":20
 
 
       }
 
       }
    ]
+
  ]
  }
 
 
}
 
}
</pre>
 
  
=== Продажа смены водителю ===
+
Ответ:
 +
{
 +
  "code":0,
 +
  "descr":"OK",
 +
  "data":{}
 +
}
 +
</pre>
  
Метод: POST
+
=== Анализ телефона ===
 +
 
 +
Метод: GET
  
Название запроса: driver_buy_shift
+
Название запроса: analyze_phone
  
 
Параметры:
 
Параметры:
 
 
{|
 
{|
 
!Параметр
 
!Параметр
Строка 8138: Строка 9044:
 
!colspan="3"|Обязательные параметры
 
!colspan="3"|Обязательные параметры
 
|-
 
|-
|crew_id
+
|phone
|Целое
+
|Строка
|ИД экипажа
+
|Номер телефона
 +
|-
 +
!colspan="3"|Необязательные параметры
 +
|-
 +
|search_in_drivers_mobile
 +
|true или false
 +
|Искать среди телефонов водителей
 +
|-
 +
|search_in_clients
 +
|true или false
 +
|Искать среди телефонов клиентов
 
|-
 
|-
|plan_shift_id
+
|search_in_phones
|Целое
+
|true или false
|ИД запланированной смены
+
|Искать в справочнике телефонов
 
|}
 
|}
 +
 +
 +
Если параметры search_in_drivers_mobile, search_in_clients, search_in_phones не заданы, то поиск телефона будет происходить во всех справочниках.
  
 
Специальные возвращаемые коды:
 
Специальные возвращаемые коды:
 
 
{|
 
{|
 
!Код
 
!Код
 
!Описание
 
!Описание
 
|-
 
|-
|100  
+
|100
|Запланированная смена не найдена
+
|Телефон не найден
 +
|}
 +
 
 +
Возвращаемые данные в случае успешного выполнения запроса:
 +
{|
 +
!Параметр
 +
!Тип
 +
!Описание
 
|-
 
|-
|101
+
|phone_type
|Экипаж не найден
+
|Строка
 +
|Может принимать значения: «driver_mobile», «client», «phone».
 
|-
 
|-
|102
+
|id
|Водитель не найден
+
|Целое
 +
|ИД водителя, клиента, телефона из справочника.
 
|-
 
|-
|103
+
|client_employee_id
|Недостаточно денег на счете водителя
+
|Целое
|-
+
|ИД сотрудника клиента (если телефон найден среди телефонов клиента)
|104
 
|Водитель уволен либо заблокирован
 
|-
 
|105
 
|Запланированная смена устарела
 
|-
 
|106
 
|Не подходит группа экипажа
 
|-
 
|107
 
|Превышено максимальное число покупок смены
 
|-
 
|108
 
|Повторная покупка смены
 
|-
 
|109
 
|Экипажу не назначен атрибут для доступа к смене
 
 
|}
 
|}
  
 
Возвращаемые данные в случае успешного выполнения запроса: нет.
 
  
 
Пример:
 
Пример:
Строка 8192: Строка 9100:
 
Запрос:
 
Запрос:
  
POST https://ip:port/common_api/1.0/driver_buy_shift
+
GET /common_api/1.0/analyze_phone?
Signature: <...>
+
phone=89501234567&search_in_drivers_mobile=true&search_in_drivers_home=true&search_in_clients=true&
Content-Type: application/x-www-form-urlencoded
+
search_in_phones=true
Content-Length: 25
 
crew_id=1&plan_shift_id=1
 
  
 +
Host: 127.0.0.1:8089
 +
Keep-Alive: 300
 +
Connection: keep-alive
 +
Signature: 4285286a446064353f4a951b721c54f7
  
 
Ответ:
 
Ответ:
Строка 8204: Строка 9114:
 
   "code":0,
 
   "code":0,
 
   "descr":"OK",
 
   "descr":"OK",
   "data":{}
+
   "data":{
 +
  "phone_type":"client",
 +
  "id":1
 +
  "client_employee_id":2
 +
  }
 
}
 
}
 +
 
</pre>
 
</pre>
  
=== Сохранение отзыва клиента ===
+
=== Показать сообщение в ТМ ===
 +
 
 
Метод: POST
 
Метод: POST
  
Название запроса: save_client_feed_back
+
Название запроса: show_tm_message
  
Параметры в формате JSON:
+
Параметры:
  
 
{|
 
{|
Строка 8222: Строка 9138:
 
!colspan="3"|Обязательные параметры
 
!colspan="3"|Обязательные параметры
 
|-
 
|-
|phone
+
|text
 
|Строка
 
|Строка
|Телефон
+
|Текст сообщения
 
|-
 
|-
|rating
+
!colspan="3"|Необязательные параметры
|Целое
 
|Рейтинг (от 1 до 5)
 
 
|-
 
|-
|text
+
|type
 
|Строка
 
|Строка
|Текстовый отзыв
+
|Тип сообщения ("warning", "error", "information", "confirmation"), по умолчанию "information"
 
|-
 
|-
!colspan="3"|Необязательные параметры
+
|header
 +
|Строка
 +
|Заголовок сообщения
 
|-
 
|-
|order_id
+
|timeout
 
|Целое
 
|Целое
|ИД заказа
+
|Скрывать сообщение через, сек. (0 — не скрывать)
|}
+
|-
 +
|users
 +
|Массив
 +
|Массив пользователей (если не указаны — отправлять всем)
 +
|-
 +
|&bull;
 +
|Целое
 +
|ИД пользователя
 +
|-
 +
|color
 +
|Строка
 +
|Цвет уведомления в формате RGB: #FFFFFF
 +
|-
 +
|order_id
 +
|Целое
 +
|ИД заказа для кнопки открытия карточки в уведомлении
 +
|-
 +
|car_id
 +
|Целое
 +
|ИД автомобиля для кнопки открытия карточки в уведомлении
 +
|-
 +
|driver_id
 +
|Целое
 +
|ИД водителя для кнопки открытия карточки в уведомлении
 +
|-
 +
|crew_id
 +
|Целое
 +
|ИД экипажа для кнопки открытия карточки в уведомлении
 +
|-
 +
|client_id
 +
|Целое
 +
|ИД клиента для кнопки открытия карточки в уведомлении
 +
|}
 +
 
 +
 
 +
Специальные возвращаемые коды:
  
Допускается указывать либо параметр rating либо text, либо оба параметра.
+
{|
 +
!Код
 +
!Описание
 +
|-
 +
|100
 +
|Пользователи для отправки сообщения не найдены
 +
|}
  
Специальные возвращаемые коды: нет.
 
  
 
Возвращаемые данные в случае успешного выполнения запроса: нет.
 
Возвращаемые данные в случае успешного выполнения запроса: нет.
Строка 8249: Строка 9205:
 
Пример:
 
Пример:
 
<pre>
 
<pre>
 +
 
Запрос:
 
Запрос:
POST /common_api/1.0/save_client_feed_back
+
 
Host: 127.0.0.1:8090
+
POST https://ip:port/common_api/1.0/show_tm_message HTTP/1.1
Keep-Alive: 300
+
Signature: <...>
Connection: keep-alive
 
 
Content-Type: application/json
 
Content-Type: application/json
Content-Length: 72
+
Content-Length: <...>
Signature: <...>
 
  
 
{
 
{
  "phone":"89123456789",
+
    "text": "Текст сообщения",
  "rating":4,
+
    "type": "warning",
  "text":"test feedback",
+
    "users": [
  "order_id":100
+
        1,
 +
        2,
 +
        3
 +
    ],
 +
    "header": "Заголовок",
 +
    "timeout": 12,
 +
    "color":"#FFFF80",
 +
    "car_id":55
 
}
 
}
 +
 +
 
Ответ:
 
Ответ:
 +
 
{
 
{
 
   "code":0,
 
   "code":0,
Строка 8270: Строка 9235:
 
   "data":{}
 
   "data":{}
 
}
 
}
 +
 
</pre>
 
</pre>
  
=== Поиск экипажей по координатам ===
+
=== Запрос списка купленных смен водителей ===
 +
 
 
Метод: GET
 
Метод: GET
  
Название запроса: find_crews_by_coords
+
Название запроса: get_driver_shifts
  
 
Параметры:
 
Параметры:
Строка 8286: Строка 9253:
 
!colspan="3"|Обязательные параметры
 
!colspan="3"|Обязательные параметры
 
|-
 
|-
|lat
+
|start_time
|Дробное
+
|ГГГГММДДччммсс
|Широта точки центра поиска
+
|Начало периода
 
|-
 
|-
|lon
+
|finish_time
|Дробное
+
|ГГГГММДДччммсс
|Долгота точки центра поиска
+
|Конец периода
|-
 
|radius
 
|Дробное
 
|Радиус поиска, км или мили
 
 
|-
 
|-
 
!colspan="3"|Необязательные параметры
 
!colspan="3"|Необязательные параметры
 
|-
 
|-
|crews_without_coords
+
|driver_id
|true или false
 
|Искать экипажи без реальных координат по координатам стоянок
 
|-
 
|crews_release_in
 
 
|Целое
 
|Целое
|Допустимое время до освобождения в зоне поиска, если надо возвращать занятые экипажи (если 0, то искать только свободные экипажи), мин
+
|ИД водителя
 
|-
 
|-
|crew_group_id
+
|new_shifts
|Целое
+
|true или false
|ИД группы экипажей, заказы из которой должны видеть подходящие экипажи
+
|Включить в ответ новые смены (по умолчанию true)
 
|-
 
|-
|uds_id
+
|in_work_shifts
|Целое
+
|true или false
|ИД службы ЕДС, к которой должны принадлежать подходящие экипажи
+
|Включить в ответ смены в работе (по умолчанию true)
 
|-
 
|-
|attributes
+
|finished_shifts
|Строка
+
|true или false
|Список ИД атрибутов заказа, которыми должны обладать подходящие экипажи (через точку с запятой, пример: «1;2;3»). Устарело. Рекомендуется использовать параметр attribute_values.
+
|Включить в ответ выполненные смены (по умолчанию true)
 
|-
 
|-
|attribute_values
+
|failed_shifts
|Массив
+
|true или false
|Массив значений атрибутов
+
|Включить в ответ неуспешно завершенные смены (по умолчанию true)
 
|-
 
|-
|&bull; id
+
|returned_shifts
|Целое
 
|Идентификатор атрибута
 
|-
 
|&bull; bool_value
 
 
|true или false
 
|true или false
|Значение, если тип атрибута «Логический»
+
|Включить в ответ возвращенные смены (по умолчанию false)
|-
 
|&bull; num_value
 
|Дробное
 
|Значение, если тип атрибута:
 
* «Число» (непосредственное значение)
 
* «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
 
* «Перечисляемый» (значение выбранного элемента перечисления)
 
|-
 
|&bull; str_value
 
|Строка
 
|Значение, если тип атрибута «Строка»
 
 
|}
 
|}
  
Строка 8353: Строка 9297:
 
!Описание
 
!Описание
 
|-
 
|-
|waiting_count
+
|shifts
|Целое
+
|Массив
|Количество свободных экипажей в зоне поиска
+
|Массив купленных смен
 
|-
 
|-
|on_order_count
+
|&bull; shift_id
|Целое
+
|Целое  
|Количество занятых экипажей, освобождающихся в зоне поиска
+
|ИД купленной смены
|}
 
 
 
Пример:
 
<pre>
 
Запрос:
 
GET https://ip:port/common_api/1.0/find_crews_by_coords?
 
lat=11.111111&lon=22.222222&radius=2&crews_release_in=5
 
Signature: <...>
 
Ответ:
 
{
 
  "code":0,
 
  "descr":"OK",
 
  "data":{
 
  "waiting_count":5,
 
  "on_order_count":2
 
  }
 
}
 
</pre>
 
 
 
=== Подбор тарифа для заказа ===
 
Метод: POST
 
 
 
Название запроса: select_tariff_for_order
 
 
 
Параметры в формате JSON:
 
 
 
{|
 
!Параметр
 
!Тип
 
!Описание
 
 
|-
 
|-
!colspan="3"|Необязательные параметры
+
|&bull; driver_id
 +
|Целое
 +
|ИД водителя
 
|-
 
|-
|client_id
+
|&bull;driver_name
|Целое
+
|Строка
|ИД клиента
+
|ФИО водителя
 
|-
 
|-
|crew_group_id
+
|&bull; plan_shift_id
|Целое
+
|Строка
|ИД группы экипажей
+
|ИД запланированной смены
 
|-
 
|-
|uds_id
+
|&bull; plan_shift_name
|Целое
+
|Строка
|ИД службы ЕДС
+
|Наименование запланированной смены
 
|-
 
|-
|source_time
+
|&bull; plan_shift_cost
|ГГГГММДДччммсс
+
|Дробное
|Время подачи
+
|Цена смены
 +
|-
 +
|&bull; plan_shift_type
 +
|Строка
 +
|Тип смены («limited» - срочная, «unlimited» - бессрочная)
 +
|-
 +
|&bull; plan_shift_start_time
 +
|ГГГГММДДччммсс  
 +
|План-начало смены (для срочных)
 +
|-
 +
|&bull; plan_shift_finish_time
 +
|ГГГГММДДччммсс
 +
|План-конец смены (для срочных)
 +
|-
 +
|&bull; plan_shift_length
 +
|Целое
 +
|План продолжительность смены, ч. (для бессрочных)
 
|-
 
|-
|is_prize
+
|&bull; plan_shift_crew_group_id
|true или false
+
|Целое
|Призовой заказ
+
|ИД первой группы экипажей, которая может купить смену
 
|-
 
|-
|addresses
+
|&bull; plan_shift_crew_groups
 
|Массив
 
|Массив
|Массив координат адресов. Первый элемент — адрес подачи,
+
|ИД групп экипажей, которые могут купить смену
последний — адрес назначения, между ними — остановки.
+
|-
Заполняется если определены координаты всех адресов.
+
|&bull; shift_state
 +
|Строка
 +
|Состояние смены («new» - новая, «in_work» - в работе, «finished» - завершена успешно, «failed» - завершена неуспешно)
 +
|-
 +
|&bull; buy_time
 +
|ГГГГММДДччммсс
 +
|Время продажи смены водителю
 +
|-
 +
|&bull; is_returned
 +
|true или false
 +
|Признак возвращенной смены
 +
|-
 +
|&bull; return_time
 +
|ГГГГММДДччммсс
 +
|Время возврата смены
 +
|-
 +
|&bull; orders_count
 +
|Целое
 +
|Количество заказов, выполненных водителем за смену
 
|-
 
|-
|* lon
+
|&bull; orders_sum
 
|Дробное  
 
|Дробное  
|Долгота адреса
+
|Сумма заказов, выполненных водителем за смену
 
|-
 
|-
|* lat
+
|&bull; fact_length
 
|Дробное  
 
|Дробное  
|Широта адреса
+
|Фактическая продолжительность смены, ч.
 
|}
 
|}
  
Специальные возвращаемые коды:
+
Пример:
 +
 
 +
<pre>
 +
Запрос:
  
{|
+
GET https://ip:port/common_api/1.0/get_driver_shifts?start_time=20140101101010&finish_time=20140101202020
!Код
+
Signature: <...>
!Описание
 
|-
 
|100
 
|Клиент не найден
 
|}
 
  
Возвращаемые данные в случае успешного выполнения запроса:
 
  
{|
+
Ответ:
!Параметр
 
!Тип
 
!Описание
 
|-
 
|tariff_id
 
|Целое
 
|Тариф
 
|}
 
 
 
Пример:
 
  
<pre>
 
Запрос:
 
POST https://ip:port/common_api/1.0/select_tariff_for_order
 
Signature: <...>
 
Content-Type: application/json
 
Content-Length: <...>
 
{
 
  "client_id":1,
 
  "crew_group_id":2,
 
  "source_time":"20160101100000",
 
  "is_prize":true
 
"addresses": [
 
      {
 
            "lat": 11.111111,
 
            "lon": 22.222222
 
      },
 
      {
 
            "lat": 33.333333,
 
            "lon": 44.444444
 
}
 
}
 
Ответ:
 
 
{
 
{
 
   "code":0,
 
   "code":0,
 
   "descr":"OK",
 
   "descr":"OK",
 
   "data":{
 
   "data":{
  "tariff_id":2
+
    "shifts":[
}
+
      {
}
+
        "shift_id":1,
</pre>
+
        "driver_id":1,
 
+
        "driver_name":"DRIVER_1",
=== Импорт марок автомобилей в БД  ===
+
        "plan_shift_id":1,
Метод: POST
+
        "plan_shift_name":"PLAN_SHIFT_1",
 +
        "plan_shift_cost":100,
 +
        "plan_shift_type":"limited",
 +
        "plan_shift_start_time":"20140101101010",
 +
        "plan_shift_finish_time":"20140101101010",
 +
        "plan_shift_length":null,
 +
        "plan_shift_crew_group_id":1,
 +
        "shift_state":new,
 +
        "buy_time":"20140101101010",
 +
        "is_returned":false,
 +
        "return_time":null,
 +
        "orders_count":10,
 +
        "orders_sum":1000,
 +
        "fact_length":1.2
 +
      },
 +
      {
 +
        "shift_id":2,
 +
        "driver_id":2,
 +
        "driver_name":"DRIVER_2",
 +
        "plan_shift_id":2,
 +
        "plan_shift_name":"PLAN_SHIFT_2",
 +
        "plan_shift_cost":200,
 +
        "plan_shift_type":"unlimited",
 +
        "plan_shift_start_time":null,
 +
        "plan_shift_finish_time":null,
 +
        "plan_shift_length":8,
 +
        "plan_shift_crew_group_id":null,
 +
        "shift_state":new,
 +
        "buy_time":"20140101101010",
 +
        "is_returned":true,
 +
        "return_time":"20140101101010",
 +
        "orders_count":0,
 +
        "orders_sum":0,
 +
        "fact_length":0
 +
      }
 +
    ]
 +
  }
 +
}
 +
</pre>
 +
 
 +
=== Запрос списка запланированных смен водителей ===
 +
 
 +
Метод: GET
  
Название запроса: import_car_marks
+
Название запроса: get_driver_plan_shifts
  
Параметры в формате JSON:  
+
Параметры:
  
 
{|
 
{|
Строка 8497: Строка 9454:
 
!colspan="3"|Обязательные параметры
 
!colspan="3"|Обязательные параметры
 
|-
 
|-
|marks
+
|start_time
|Массив строк
+
|ГГГГММДДччммсс
|Импортируемые марки автомобилей
+
|Начало периода (если включаем в ответ срочные смены)
 +
|-
 +
|finish_time
 +
|ГГГГММДДччммсс
 +
|Конец периода (если включаем в ответ срочные смены)
 +
|-
 +
!colspan="3"|Необязательные параметры
 +
|-
 +
|limited_shifts
 +
|true или false
 +
|Включить в ответ срочные смены (по умолчанию true)
 +
|-
 +
|unlimited_shifts
 +
|true или false
 +
|Включить в ответ бессрочные смены (по умолчанию true)
 
|}
 
|}
  
Специальные возвращаемые коды: нет  
+
Специальные возвращаемые коды: нет
  
Возвращаемые данные в случае успешного выполнения запроса: нет
+
Возвращаемые данные в случае успешного выполнения запроса:
 
+
{|
Пример:
+
!Параметр
 
 
<pre>
 
Запрос:
 
 
 
POST https://ip:port/common_api/1.0/import_car_marks
 
Signature: <...>
 
Content-Type: application/json
 
Content-Length: <...>
 
{
 
  "marks": [
 
    "Mercedes",
 
    "BMW"
 
  ]
 
}
 
 
 
Ответ:
 
 
 
{
 
  "code":0,
 
  "descr":"OK",
 
  "data":{}
 
}
 
 
 
</pre>
 
 
 
=== Импорт цветов автомобилей в БД  ===
 
Метод: POST
 
 
 
Название запроса:  import_car_colors
 
 
 
Параметры в формате JSON:
 
 
 
{|
 
!Параметр
 
 
!Тип
 
!Тип
 
!Описание
 
!Описание
 
|-
 
|-
!colspan="3"|Обязательные параметры
+
|plan_shifts
 +
|Массив
 +
|Массив запланированных смен
 +
|-
 +
|&bull; plan_shift_id
 +
|Целое
 +
|ИД запланированной смены
 +
|-
 +
|&bull; plan_shift_name
 +
|Строка
 +
|Наименование запланированной смены
 +
|-
 +
|&bull; plan_shift_comment
 +
|Строка
 +
|Комментарий запланированной смены
 
|-
 
|-
|colors
+
|&bull; plan_shift_cost
|Массив строк
+
|Дробное
|Импортируемые цвета автомобилей
+
|Цена смены
|}
+
|-
 
+
|&bull; plan_shift_type
Специальные возвращаемые коды: нет
+
|Строка
 
+
|Тип смены («limited» - срочная, «unlimited» - бессрочная)
Возвращаемые данные в случае успешного выполнения запроса: нет
+
|-
 
+
|&bull; plan_shift_start_time
Пример:  
+
|ГГГГММДДччммсс
 
+
|План-начало смены (для срочных)
<pre>
+
|-
Запрос:  
+
|&bull; plan_shift_finish_time
 +
|ГГГГММДДччммсс
 +
|План-конец смены (для срочных)
 +
|-
 +
|&bull; plan_shift_length
 +
|Целое
 +
|План продолжительность смены, ч. (для бессрочных)
 +
|-
 +
|&bull; plan_shift_crew_group_id
 +
|Целое
 +
|ИД первой группы экипажей, которая может купить смену
 +
|-
 +
|&bull; plan_shift_crew_groups
 +
|Массив
 +
|ИД групп экипажей, которые могут купить смену
 +
|-
 +
|&bull; max_sell_count
 +
|Целое
 +
|Максимальное количество продаж смены
 +
|-
 +
|&bull; sold_count
 +
|Целое
 +
|Количество продаж смены
 +
|}
 +
 
 +
Пример:
 +
 
 +
<pre>
 +
Запрос:
  
POST https://ip:port/common_api/1.0/import_car_colors
+
GET https://ip:port/common_api/1.0/get_driver_plan_shifts?start_time=20140101101010&finish_time=20140101202020
Signature: <...>
+
Signature: <...>
Content-Type: application/json
 
Content-Length: <...>
 
  
{
 
  "colors": [
 
    "красный",
 
    "синий"
 
  ]
 
}
 
  
Ответ:
+
Ответ:
  
{
+
{
 
   "code":0,
 
   "code":0,
 
   "descr":"OK",
 
   "descr":"OK",
   "data":{}
+
   "data":{
}
+
    "plan_shifts":[
 
+
      {
</pre>
+
        "plan_shift_id":1,
 
+
        "plan_shift_name":"PLAN_SHIFT_1",
=== Запрос информации по сотруднику клиента  ===
+
        "plan_shift_comment":"PLAN_SHIFT_COMMENT_1",
Метод: GET
+
        "plan_shift_cost":100,
 +
        "plan_shift_type":"limited",
 +
        "plan_shift_start_time":"20140101101010",
 +
        "plan_shift_finish_time":"20140101101010",
 +
        "plan_shift_length":null,
 +
        "plan_shift_crew_group_id":1,
 +
        "max_sell_count":100,
 +
        "sold_count":10
 +
      },
 +
      {
 +
        "plan_shift_id":2,
 +
        "plan_shift_name":"PLAN_SHIFT_2",
 +
        "plan_shift_comment":"PLAN_SHIFT_COMMENT_2",
 +
        "plan_shift_cost":200,
 +
        "plan_shift_type":"unlimited",
 +
        "plan_shift_start_time":null,
 +
        "plan_shift_finish_time":null,
 +
        "plan_shift_length":8,
 +
        "plan_shift_crew_group_id":2,
 +
        "max_sell_count":200,
 +
        "sold_count":20
 +
      }
 +
    ]
 +
  }
 +
}
 +
</pre>
 +
 
 +
=== Продажа смены водителю ===
 +
 
 +
Метод: POST
  
Название запроса: get_client_employee_info
+
Название запроса: driver_buy_shift
  
 
Параметры:
 
Параметры:
Строка 8596: Строка 9596:
 
!colspan="3"|Обязательные параметры
 
!colspan="3"|Обязательные параметры
 
|-
 
|-
|client_employee_id
+
|crew_id
|Целое
+
|Целое  
|ИД сотрудника клиента
+
|ИД экипажа
|}
 
 
 
Специальные возвращаемые коды:
 
{|
 
!Код
 
!Описание
 
 
|-
 
|-
|100
+
|plan_shift_id
|Не найден сотрудник клиента ИД=CLIENT_EMPLOYEE_ID
+
|Целое
 +
|ИД запланированной смены
 
|}
 
|}
  
Возвращаемые данные в случае успешного выполнения запроса:
+
Специальные возвращаемые коды:
  
 
{|
 
{|
!Параметр
+
!Код
!Тип
 
 
!Описание
 
!Описание
 
|-
 
|-
|client_employee_id
+
|100
|Целое
+
|Запланированная смена не найдена
|ИД сотрудника
 
 
|-
 
|-
|client_id
+
|101
|Целое
+
|Экипаж не найден
|ИД клиента
+
|-
 +
|102
 +
|Водитель не найден
 
|-
 
|-
|name
+
|103
|Строка
+
|Недостаточно денег на счете водителя
|ФИО сотрудника
 
 
|-
 
|-
|is_deleted
+
|104
|true или false
+
|Водитель уволен либо заблокирован
|Признак удаленного сотрудника
 
 
|-
 
|-
|email
+
|105
|Строка
+
|Запланированная смена устарела
|E-mail
 
 
|-
 
|-
|use_email_informing
+
|106
|true или false
+
|Не подходит группа экипажа
|Использовать E-mail для отправки уведомлений по заказу
 
 
|-
 
|-
|default_crew_group
+
|107
|Целое
+
|Превышено максимальное число покупок смены
|Группа экипажей по умолчанию
 
 
|-
 
|-
|phones
+
|108
|Массив
+
|Повторная покупка смены
|Массив телефонов сотрудника клиента
 
 
|-
 
|-
|&bull; phone
+
|109
|Строка
+
|Экипажу не назначен атрибут для доступа к смене
|Номер телефона сотрудника
 
 
|}
 
|}
  
Пример:  
+
 
 +
Возвращаемые данные в случае успешного выполнения запроса: нет.
 +
 
 +
Пример:
  
 
<pre>
 
<pre>
 
Запрос:
 
Запрос:
  
GET https://ip:port/common_api/1.0/get_client_employee_info?client_employee_id=10
+
POST https://ip:port/common_api/1.0/driver_buy_shift
Signature: <...>  
+
Signature: <...>
 +
Content-Type: application/x-www-form-urlencoded
 +
Content-Length: 25
 +
crew_id=1&plan_shift_id=1
 +
 
  
 
Ответ:
 
Ответ:
  
{
+
{
 
   "code":0,
 
   "code":0,
 
   "descr":"OK",
 
   "descr":"OK",
   "data":{
+
   "data":{}
    "client_employee_id":5,
+
}
    "client_id":1,
+
</pre>
    "name":"Иванов Иван",
+
 
    "is_deleted":false,
+
=== Сохранение отзыва клиента ===
    "email":"mail@mail.ru",
+
Метод: POST
    "use_email_informing":true,
 
    "default_crew_group":1,
 
    "phones":[
 
      {
 
        "phone":"88"
 
      },
 
      {
 
        "phone":"99"
 
      }
 
    ]
 
  }
 
}
 
  
</pre>
+
Название запроса: save_client_feed_back
  
=== Создание сотрудника клиента ===
+
Параметры в формате JSON:
Метод: POST
 
 
 
Название запроса: create_client_employee
 
 
 
Параметры в формате JSON:  
 
  
 
{|
 
{|
Строка 8702: Строка 9680:
 
!colspan="3"|Обязательные параметры
 
!colspan="3"|Обязательные параметры
 
|-
 
|-
|client_id
+
|phone
 +
|Строка
 +
|Телефон
 +
|-
 +
|rating
 
|Целое
 
|Целое
|ИД клиента
+
|Рейтинг (от 1 до 5)
 
|-
 
|-
|name
+
|text
 
|Строка
 
|Строка
|ФИО сотрудника
+
|Текстовый отзыв
 
|-
 
|-
 
!colspan="3"|Необязательные параметры
 
!colspan="3"|Необязательные параметры
 
|-
 
|-
|email
+
|order_id
|Строка
+
|Целое
|E-mail
+
|ИД заказа
 +
|-
 +
|attribute_values
 +
|Массив
 +
|Массив значений атрибутов
 +
|-
 +
|&bull; id
 +
|Целое
 +
|Идентификатор атрибута
 
|-
 
|-
|use_email_informing
+
|&bull; bool_value
 
|true или false
 
|true или false
|Использовать E-mail для отправки уведомлений по заказу
+
|Значение, если тип атрибута «Логический»
 
|-
 
|-
|phones
+
|&bull; num_value
|Массив
+
|Дробное
|Массив телефонов сотрудника
+
|Значение, если тип атрибута:
 +
* «Число» (непосредственное значение)
 +
* «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
 +
* «Перечисляемый» (значение выбранного элемента перечисления)
 +
* «Дата» и «Дата/время» (Unix-время, всегда целое число)
 
|-
 
|-
|&bull; phone
+
|&bull; str_value
 
|Строка
 
|Строка
|Номер телефона
+
|Значение, если тип атрибута «Строка»
 
|}
 
|}
  
Специальные возвращаемые коды:  
+
Допускается указывать либо параметр rating либо text, либо оба параметра.
{|
+
 
!Код
+
Специальные возвращаемые коды: нет.
!Описание
 
|-
 
|100
 
|Клиент с ИД=CLIENT_ID не найден
 
|-
 
|101
 
|Клиент с ИД=ID имеет такой же номер телефона=PHONE
 
|}
 
  
Возвращаемые данные в случае успешного выполнения запроса: нет.  
+
Возвращаемые данные в случае успешного выполнения запроса: нет.
  
 
Пример:
 
Пример:
 
 
<pre>
 
<pre>
Запрос:  
+
Запрос:
 
+
POST /common_api/1.0/save_client_feed_back
POST https://ip:port/common_api/1.0/create_client_employee
+
Host: 127.0.0.1:8090
Signature: <...>
+
Keep-Alive: 300
Content-Type: application/json  
+
Connection: keep-alive
Content-Length: 104
+
Content-Type: application/json
 +
Content-Length: 72
 +
Signature: <...>
  
 
{
 
{
   "client_id":10
+
   "phone":"89123456789",
  "name":"Иванов Иван",
+
   "rating":4,
   "email":"mail@mail.ru",
+
   "text":"test feedback",
   "use_email_informing":true,
+
  "order_id":100
  "phones":[
+
}
    {
+
Ответ:
      "phone":"79999999999",
+
{
    },
 
    {
 
      "phone":"79999999999",
 
    }
 
  ]
 
}
 
 
 
Ответ:
 
{
 
 
   "code":0,
 
   "code":0,
 
   "descr":"OK",
 
   "descr":"OK",
 
   "data":{}
 
   "data":{}
}
+
}
 
 
 
</pre>
 
</pre>
  
=== Обновление информации о сотруднике клиента ===
+
=== Поиск экипажей по координатам ===
Метод: POST
+
Метод: GET
  
Название запроса: update_client_employee_info
+
Название запроса: find_crews_by_coords
  
Параметры в формате JSON:  
+
Параметры:
  
 
{|
 
{|
Строка 8791: Строка 9768:
 
!colspan="3"|Обязательные параметры
 
!colspan="3"|Обязательные параметры
 
|-
 
|-
|client_employee_id
+
|lat
 +
|Дробное
 +
|Широта точки центра поиска
 +
|-
 +
|lon
 +
|Дробное
 +
|Долгота точки центра поиска
 +
|-
 +
|radius
 +
|Дробное
 +
|Радиус поиска, км или мили
 +
|-
 +
!colspan="3"|Необязательные параметры
 +
|-
 +
|crews_without_coords
 +
|true или false
 +
|Искать экипажи без реальных координат по координатам стоянок
 +
|-
 +
|crews_release_in
 +
|Целое
 +
|Допустимое время до освобождения в зоне поиска, если надо возвращать занятые экипажи (если 0, то искать только свободные экипажи), мин
 +
|-
 +
|crew_group_id
 
|Целое
 
|Целое
|ИД редактируемого сотрудника клиента 
+
|ИД группы экипажей, заказы из которой должны видеть подходящие экипажи
 
|-
 
|-
!colspan="3"|Необязательные параметры
+
|uds_id
 +
|Целое
 +
|ИД службы ЕДС, к которой должны принадлежать подходящие экипажи
 
|-
 
|-
|name
+
|attributes
 
|Строка
 
|Строка
|ФИО сотрудника
+
|Список ИД атрибутов заказа, которыми должны обладать подходящие экипажи (через точку с запятой, пример: «1;2;3»). Устарело. Рекомендуется использовать параметр attribute_values.
 
|-
 
|-
|is_deleted
+
|attribute_values
|true или false
+
|Массив
|Признак удаленного сотрудника
+
|Массив значений атрибутов
 
|-
 
|-
|email
+
|&bull; id
|Строка
+
|Целое
|E-mail
+
|Идентификатор атрибута
 
|-
 
|-
|use_email_informing
+
|&bull; bool_value
 
|true или false
 
|true или false
|Использовать E-mail для отправки уведомлений по заказу
+
|Значение, если тип атрибута «Логический»
 
|-
 
|-
|phones
+
|&bull; num_value
|Массив
+
|Дробное
|Массив телефонов сотрудника
+
|Значение, если тип атрибута:
 +
* «Число» (непосредственное значение)
 +
* «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
 +
* «Перечисляемый» (значение выбранного элемента перечисления)
 +
* «Дата» и «Дата/время» (Unix-время, всегда целое число)
 
|-
 
|-
|&bull; phone
+
|&bull; str_value
 
|Строка
 
|Строка
|Номер телефона
+
|Значение, если тип атрибута «Строка»
 
|}
 
|}
  
Примечание: запрещено редактировать телефоны удаленного сотрудника.
+
Специальные возвращаемые коды: нет
  
 +
Возвращаемые данные в случае успешного выполнения запроса:
  
Специальные возвращаемые коды:
 
 
{|
 
{|
!Код
+
!Параметр
 +
!Тип
 
!Описание
 
!Описание
 
|-
 
|-
|100
+
|waiting_count
|Сотрудник с ИД=CLIENT_EMPLOYEE_ID не найден
+
|Целое
 +
|Количество свободных экипажей в зоне поиска
 
|-
 
|-
|101
+
|on_order_count
|Клиент с ИД=ID имеет такой же номер телефона=PHONE
+
|Целое
|-
+
|Количество занятых экипажей, освобождающихся в зоне поиска
|102
 
|Запрещено редактирование телефонов удаленного сотрудника
 
 
|}
 
|}
 
Возвращаемые данные в случае успешного выполнения запроса: нет.
 
  
 
Пример:
 
Пример:
 
 
<pre>
 
<pre>
Запрос:  
+
Запрос:
 
+
GET https://ip:port/common_api/1.0/find_crews_by_coords?
POST https://ip:port/common_api/1.0/update_client_employee_info
+
lat=11.111111&lon=22.222222&radius=2&crews_release_in=5
Signature: <...>  
+
Signature: <...>
Content-Type: application/json
+
Ответ:
Content-Length: 104
 
 
 
 
{
 
{
  "client_employee_id":10
 
  "name":"Иванов Иван",
 
  "is_deleted":false,
 
  "email":"mail@mail.ru",
 
  "use_email_informing":true,
 
  "phones":[
 
    {
 
      "phone":"79999999999",
 
    },
 
    {
 
      "phone":"79999999999",
 
    }
 
  ]
 
}
 
 
Ответ:
 
{
 
 
   "code":0,
 
   "code":0,
 
   "descr":"OK",
 
   "descr":"OK",
   "data":{}
+
   "data":{
}
+
  "waiting_count":5,
 
+
  "on_order_count":2
 +
  }
 +
}
 
</pre>
 
</pre>
  
=== Запрос списка состояний заказа ===
+
=== Подбор тарифа для заказа ===
Метод: GET
+
Метод: POST
  
Название запроса: get_order_states_list
+
Название запроса: select_tariff_for_order
  
Параметры: нет
+
Параметры в формате JSON:
  
Специальные возвращаемые коды: нет
 
 
Возвращаемые данные в случае успешного выполнения запроса:
 
 
{|
 
{|
 
!Параметр
 
!Параметр
Строка 8892: Строка 9874:
 
!Описание
 
!Описание
 
|-
 
|-
|order_params
+
!colspan="3"|Необязательные параметры
|Массив
+
|-
|Список параметров заказа
+
|client_id
 +
|Целое
 +
|ИД клиента
 +
|-
 +
|crew_group_id
 +
|Целое
 +
|ИД группы экипажей
 +
|-
 +
|uds_id
 +
|Целое
 +
|ИД службы ЕДС
 +
|-
 +
|source_time
 +
|ГГГГММДДччммсс
 +
|Время подачи
 +
|-
 +
|is_prize
 +
|true или false
 +
|Призовой заказ
 
|-
 
|-
|&bull; id
+
|addresses
|Целое
+
|Массив
|ИД параметра
+
|Массив координат адресов. Первый элемент — адрес подачи,
 +
последний — адрес назначения, между ними — остановки.
 +
Заполняется если определены координаты всех адресов.
 
|-
 
|-
|&bull; name
+
|&bull; lon
|Строка
+
|Дробное
|Название параметра
+
|Долгота адреса
 
|-
 
|-
|&bull; state_type
+
|&bull; lat
|Строка
+
|Дробное
|Тип состояния. Может принимать значения:
+
|Широта адреса
 +
|}
  
• "accepted" — заказ принят
+
Специальные возвращаемые коды:
  
• "in_work" — заказ в работе
+
{|
 
+
!Код
• "finished" — заказ выполнен
+
!Описание
 
+
|-
• "aborted" — заказ прекращен
+
|100
 +
|Клиент не найден
 
|}
 
|}
  
Пример:
+
Возвращаемые данные в случае успешного выполнения запроса:
 +
 
 +
{|
 +
!Параметр
 +
!Тип
 +
!Описание
 +
|-
 +
|tariff_id
 +
|Целое
 +
|Тариф
 +
|}
 +
 
 +
Пример:
  
 
<pre>
 
<pre>
 
Запрос:
 
Запрос:
 
+
POST https://ip:port/common_api/1.0/select_tariff_for_order
 
 
GET https://ip:port/common_api/1.0/get_order_states_list
 
 
 
 
Signature: <...>
 
Signature: <...>
 
+
Content-Type: application/json
 +
Content-Length: <...>
 +
{
 +
  "client_id":1,
 +
  "crew_group_id":2,
 +
  "source_time":"20160101100000",
 +
  "is_prize":true
 +
"addresses": [
 +
      {
 +
            "lat": 11.111111,
 +
            "lon": 22.222222
 +
      },
 +
      {
 +
            "lat": 33.333333,
 +
            "lon": 44.444444
 +
}
 +
}
 
Ответ:
 
Ответ:
 
 
 
{
 
{
"code":0,
+
  "code":0,
"descr":"OK",
+
  "descr":"OK",
"data":{
+
  "data":{
"order_params":[
+
  "tariff_id":2
    {
+
}
      "id":1,
 
      "name":"Принят",
 
      "state_type":"accepted"
 
    },
 
    {
 
      "id":2,
 
      "name":"В работе",
 
      "state_type":"in_work"
 
      },
 
    ...
 
                ]
 
        }
 
 
}
 
}
 
 
</pre>
 
</pre>
  
===  Запрос списка состояний экипажа ===
+
=== Импорт марок автомобилей в БД ===
Метод: GET
+
Метод: POST
  
Название запроса: get_crew_states_list
+
Название запроса: import_car_marks
  
Параметры: нет
+
Параметры в формате JSON:  
  
Специальные возвращаемые коды: нет
 
 
Возвращаемые данные в случае успешного выполнения запроса:
 
 
{|
 
{|
 
!Параметр
 
!Параметр
Строка 8967: Строка 9978:
 
!Описание
 
!Описание
 
|-
 
|-
|order_params
+
!colspan="3"|Обязательные параметры
|Массив
 
|Список параметров заказа
 
 
|-
 
|-
|&bull; id
+
|marks
|Целое
+
|Массив строк
|ИД параметра
+
|Импортируемые марки автомобилей
|-
+
|}
|&bull; name
 
|Строка
 
|Название параметра
 
|-
 
|&bull; state_type
 
|Строка
 
|Тип состояния. Может принимать значения:
 
  
• "waiting" — экипаж свободен
+
Специальные возвращаемые коды: нет
  
• "not_available" — экипаж не на линии
+
Возвращаемые данные в случае успешного выполнения запроса: нет
  
• "on_order" — экипаж на заказе
+
Пример:
  
• "on_break" — экипаж на перерыве
+
<pre>
|}
+
Запрос:
  
Пример:
+
POST https://ip:port/common_api/1.0/import_car_marks
 +
Signature: <...>
 +
Content-Type: application/json
 +
Content-Length: <...>
 +
{
 +
  "marks": [
 +
    "Mercedes",
 +
    "BMW"
 +
  ]
 +
}
  
<pre>
+
Ответ:
Запрос:
 
GET https://ip:port/common_api/1.0/get_crew_states_list
 
Signature: <...>
 
  
Ответ:
+
{
{
+
  "code":0,
"code":0,
+
  "descr":"OK",
"descr":"OK",
+
  "data":{}
"data":{
+
  }
  "order_params":[
 
        {
 
          "id":1,
 
          "name":"Свободен",
 
          "state_type":"waiting"
 
        },
 
        {
 
          "id":2,
 
          "name":"Не работает",
 
          "state_type":"not_available"
 
        },
 
        ...
 
              ]
 
        }
 
}
 
  
 
</pre>
 
</pre>
  
 +
=== Импорт цветов автомобилей в БД  ===
 +
Метод: POST
  
=== Запрос информации по клиентам ===
+
Название запроса: import_car_colors
Метод: GET
 
  
Название запроса: get_clients_info
+
Параметры в формате JSON:  
 
 
Параметры:
 
  
 
{|
 
{|
Строка 9035: Строка 10 027:
 
!Описание
 
!Описание
 
|-
 
|-
!colspan="3"|Необязательные параметры
+
!colspan="3"|Обязательные параметры
 
|-
 
|-
|text
+
|colors
|Строка
+
|Массив строк
|Текст для поиска по названию или по номеру договора клиента
+
|Импортируемые цвета автомобилей
|-
 
|max_clients_count
 
|Целое
 
|Максимальное количество клиентов, которое надо вернуть. Если не указано, то 10.
 
 
|}
 
|}
  
Специальные возвращаемые коды: Нет
+
Специальные возвращаемые коды: нет
  
Возвращаемые данные в случае успешного выполнения запроса:
+
Возвращаемые данные в случае успешного выполнения запроса: нет
  
{|
+
Пример:  
!Параметр
 
!Тип
 
!Описание
 
|-
 
|client_id
 
|Целое
 
|ИД клиента
 
|-
 
|name
 
|Строка
 
|Наименование
 
|-
 
|number
 
|Строка
 
|Номер договора
 
|}
 
 
 
Пример:
 
  
 
<pre>
 
<pre>
Запрос:
+
Запрос:  
GET https://ip:port/common_api/1.0/get_clients_info?text=test&max_clients_count=10
 
Signature: <...>
 
  
Ответ:
+
POST https://ip:port/common_api/1.0/import_car_colors
 +
Signature: <...>
 +
Content-Type: application/json
 +
Content-Length: <...>
  
{
+
{
 +
  "colors": [
 +
    "красный",
 +
    "синий"
 +
  ]
 +
}
 +
 
 +
Ответ:
 +
 
 +
{
 
   "code":0,
 
   "code":0,
 
   "descr":"OK",
 
   "descr":"OK",
   "data":{
+
   "data":{}
    "clients_info":[
+
}
      {
 
        "client_id":390,
 
        "name":"tester1",
 
        "number":"001"
 
      },
 
      {
 
        "client_id":394,
 
        "name":"tester2",
 
        "number":"002"
 
      }
 
    ]
 
  }
 
}
 
  
 
</pre>
 
</pre>
  
=== Запрос глобальных атрибутов ===
+
=== Запрос информации по сотруднику клиента  ===
Метод: GET
+
Метод: GET  
  
Название запроса: get_global_attributes
+
Название запроса: get_client_employee_info
  
Версия ТМ: 3.9
+
Параметры:
  
Параметры: нет
+
{|
 +
!Параметр
 +
!Тип
 +
!Описание
 +
|-
 +
!colspan="3"|Обязательные параметры
 +
|-
 +
|client_employee_id
 +
|Целое
 +
|ИД сотрудника клиента
 +
|}
  
Специальные возвращаемые коды: нет
+
Специальные возвращаемые коды:  
 +
{|
 +
!Код
 +
!Описание
 +
|-
 +
|100
 +
|Не найден сотрудник клиента ИД=CLIENT_EMPLOYEE_ID
 +
|}
  
 
Возвращаемые данные в случае успешного выполнения запроса:
 
Возвращаемые данные в случае успешного выполнения запроса:
 +
 
{|
 
{|
 
!Параметр
 
!Параметр
Строка 9115: Строка 10 100:
 
!Описание
 
!Описание
 
|-
 
|-
|attribute_values
+
|client_employee_id
|Массив
+
|Целое
|Массив значений глобальных атрибутов
+
|ИД сотрудника
 
|-
 
|-
|&bull; id
+
|client_id
 
|Целое
 
|Целое
|Идентификатор атрибута
+
|ИД клиента
 +
|-
 +
|name
 +
|Строка
 +
|ФИО сотрудника
 +
|-
 +
|is_deleted
 +
|true или false
 +
|Признак удаленного сотрудника
 +
|-
 +
|email
 +
|Строка
 +
|E-mail
 
|-
 
|-
|&bull; bool_value
+
|use_email_informing
 
|true или false
 
|true или false
|Значение, если тип атрибута «Логический»
+
|Использовать E-mail для отправки уведомлений по заказу
 +
|-
 +
|default_crew_group
 +
|Целое
 +
|Группа экипажей по умолчанию
 
|-
 
|-
|&bull; num_value
+
|phones
|Дробное
+
|Массив
|Значение, если тип атрибута:
+
|Массив телефонов сотрудника клиента
* «Число» (непосредственное значение)
 
* «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
 
* «Перечисляемый» (значение выбранного элемента перечисления)
 
 
|-
 
|-
|&bull; str_value
+
|&bull; phone
 
|Строка
 
|Строка
|Значение, если тип атрибута «Строка»
+
|Номер телефона сотрудника
 
|}
 
|}
  
Пример:
+
Пример:  
  
 
<pre>
 
<pre>
Пример запроса:
+
Запрос:
  
GET https://ip:port/common_api/1.0/get_global_attributes
+
GET https://ip:port/common_api/1.0/get_client_employee_info?client_employee_id=10
 +
Signature: <...>
  
Пример ответа:
+
Ответ:
  
{
+
{
 
   "code":0,
 
   "code":0,
 
   "descr":"OK",
 
   "descr":"OK",
 
   "data":{
 
   "data":{
     "global_attributes":[
+
    "client_employee_id":5,
 +
    "client_id":1,
 +
    "name":"Иванов Иван",
 +
    "is_deleted":false,
 +
    "email":"mail@mail.ru",
 +
    "use_email_informing":true,
 +
    "default_crew_group":1,
 +
     "phones":[
 
       {
 
       {
         "id":123,
+
         "phone":"88"
        "bool_value":true
 
 
       },
 
       },
 
       {
 
       {
         "id":124,
+
         "phone":"99"
        "num_value":314
 
      },
 
      {
 
        "id":125,
 
        "str_value": "AAA"
 
 
       }
 
       }
 
     ]
 
     ]
 
   }
 
   }
}
+
}
  
 
</pre>
 
</pre>
  
 +
=== Создание сотрудника клиента ===
 +
Метод: POST
  
=== Изменение глобального атрибута ===
+
Название запроса: create_client_employee
Метод: POST
 
  
Название запроса: update_global_attribute
+
Параметры в формате JSON:  
 
 
Версия ТМ: 3.9
 
 
 
Параметры в формате JSON:
 
  
 
{|
 
{|
Строка 9188: Строка 10 185:
 
!colspan="3"|Обязательные параметры
 
!colspan="3"|Обязательные параметры
 
|-
 
|-
|id
+
|client_id
 
|Целое
 
|Целое
|ИД изменяемого атрибута
+
|ИД клиента
 +
|-
 +
|name
 +
|Строка
 +
|ФИО сотрудника
 
|-
 
|-
 
!colspan="3"|Необязательные параметры
 
!colspan="3"|Необязательные параметры
 
|-
 
|-
|bool_value
+
|email
 +
|Строка
 +
|E-mail
 +
|-
 +
|use_email_informing
 
|true или false
 
|true или false
|Значение, если тип атрибута «Логический»
+
|Использовать E-mail для отправки уведомлений по заказу
 
|-
 
|-
|num_value
+
|phones
|Дробное
+
|Массив
|Значение, если тип атрибута:
+
|Массив телефонов сотрудника
* «Число» (непосредственное значение)
 
* «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
 
* «Перечисляемый» (значение выбранного элемента перечисления)
 
 
|-
 
|-
|str_value
+
|&bull; phone
 
|Строка
 
|Строка
|Значение, если тип атрибута «Строка»
+
|Номер телефона
 
|}
 
|}
  
Специальные возвращаемые коды:
+
Специальные возвращаемые коды:  
 
{|
 
{|
 
!Код
 
!Код
Строка 9216: Строка 10 218:
 
|-
 
|-
 
|100
 
|100
|Атрибут не найден
+
|Клиент с ИД=CLIENT_ID не найден
 
|-
 
|-
 
|101
 
|101
|Атрибут не глобальный
+
|Клиент с ИД=ID имеет такой же номер телефона=PHONE
 
|}
 
|}
  
Возвращаемые данные в случае успешного выполнения запроса: нет.
+
Возвращаемые данные в случае успешного выполнения запроса: нет.  
  
 
Пример:
 
Пример:
  
 
<pre>
 
<pre>
Пример запроса:
+
Запрос:  
  
POST https://ip:port/common_api/1.0/update_global_attribute HTTP/1.1
+
POST https://ip:port/common_api/1.0/create_client_employee
Signature: <...>
+
Signature: <...>  
Content-Type: application/json
+
Content-Type: application/json  
Content-Length: <...>
+
Content-Length: 104
  
 
{
 
{
   "id": 12,
+
   "client_id":10
   "bool_value": true
+
  "name":"Иванов Иван",
}
+
   "email":"mail@mail.ru",
 +
  "use_email_informing":true,
 +
  "phones":[
 +
    {
 +
      "phone":"79999999999",
 +
    },
 +
    {
 +
      "phone":"79999999999",
 +
    }
 +
  ]
 +
}
  
Пример ответа:
+
Ответ:
 
+
{
{
 
 
   "code":0,
 
   "code":0,
 
   "descr":"OK",
 
   "descr":"OK",
 
   "data":{}
 
   "data":{}
}
+
}
  
 
</pre>
 
</pre>
  
== Описание протокола TMTAPI Версия 1.0 ==
+
=== Обновление информации о сотруднике клиента ===
 +
Метод: POST
  
=== Общее описание протокола ===
+
Название запроса: update_client_employee_info
  
==== Формат запроса ====
+
Параметры в формате JSON:
  
TM API принимает входящие запросы по протоколу HTTPS. В URI запроса после ip адреса и порта, который будет слушать TM API, должно идти название API (tm_tapi) и версия API.
+
{|
 +
!Параметр
 +
!Тип
 +
!Описание
 +
|-
 +
!colspan="3"|Обязательные параметры
 +
|-
 +
|client_employee_id
 +
|Целое
 +
|ИД редактируемого сотрудника клиента 
 +
|-
 +
!colspan="3"|Необязательные параметры
 +
|-
 +
|name
 +
|Строка
 +
|ФИО сотрудника
 +
|-
 +
|is_deleted
 +
|true или false
 +
|Признак удаленного сотрудника
 +
|-
 +
|email
 +
|Строка
 +
|E-mail
 +
|-
 +
|use_email_informing
 +
|true или false
 +
|Использовать E-mail для отправки уведомлений по заказу
 +
|-
 +
|phones
 +
|Массив
 +
|Массив телефонов сотрудника
 +
|-
 +
|&bull; phone
 +
|Строка
 +
|Номер телефона
 +
|}
  
Пример:
+
Примечание: запрещено редактировать телефоны удаленного сотрудника.
  
<pre>
 
GET https://ip:port/tm_tapi/1.0/get_info_by_phone
 
</pre>
 
  
Для получения данных из БД используются запросы типа GET. Для записи данных в БД используются запросы типа POST. В запросе типа GET параметры запроса передаются в URI.
+
Специальные возвращаемые коды:
 +
{|
 +
!Код
 +
!Описание
 +
|-
 +
|100
 +
|Сотрудник с ИД=CLIENT_EMPLOYEE_ID не найден
 +
|-
 +
|101
 +
|Клиент с ИД=ID имеет такой же номер телефона=PHONE
 +
|-
 +
|102
 +
|Запрещено редактирование телефонов удаленного сотрудника
 +
|}
 +
 
 +
Возвращаемые данные в случае успешного выполнения запроса: нет.  
  
 
Пример:
 
Пример:
  
 
<pre>
 
<pre>
GET https://ip:port/tm_tapi/1.0/get_info_by_phone?phone=89058800565&fields=PHONE_TYPE-PHONE_
+
Запрос:  
TO_DIAL&signature=661ce071eeefcb4f7fc8bc1f17bd520b
 
</pre>
 
  
В запросе типа POST параметры передаются в теле запроса в формате application/x-www-form-
+
POST https://ip:port/common_api/1.0/update_client_employee_info
urlencoded.
+
Signature: <...>
 +
Content-Type: application/json
 +
Content-Length: 104
  
Пример:
+
{
 +
  "client_employee_id":10
 +
  "name":"Иванов Иван",
 +
  "is_deleted":false,
 +
  "email":"mail@mail.ru",
 +
  "use_email_informing":true,
 +
  "phones":[
 +
    {
 +
      "phone":"79999999999",
 +
    },
 +
    {
 +
      "phone":"79999999999",
 +
    }
 +
  ]
 +
}
  
<pre>
+
Ответ:
POST https://ip:port/tm_tapi/1.0/change_order_state
+
{
Content-Type: application/x-www-form-urlencoded
+
  "code":0,
Content-Length: 71
+
  "descr":"OK",
 +
  "data":{}
 +
}
  
order_id=98798&need_state=12&signature=a204c50c7e48f0c6849a87485fe5e171
 
 
</pre>
 
</pre>
  
В любом запросе обязательно с другими полями должно передаваться поле signature. В нем передается MD5 хэш, рассчитанный для строки, которая получается сцеплением строки параметров запроса с секретным ключом. Секретный ключ задается в настройках модуля TMAPI в Такси-Мастер.
+
=== Запрос списка состояний заказа ===
 +
Метод: GET
 +
 
 +
Название запроса: get_order_states_list
  
Пример:
+
Параметры: нет
  
<pre>
+
Специальные возвращаемые коды: нет
 +
 
 +
Возвращаемые данные в случае успешного выполнения запроса:
 +
{|
 +
!Параметр
 +
!Тип
 +
!Описание
 +
|-
 +
|order_params
 +
|Массив
 +
|Список параметров заказа
 +
|-
 +
|&bull; id
 +
|Целое
 +
|ИД параметра
 +
|-
 +
|&bull; name
 +
|Строка
 +
|Название параметра
 +
|-
 +
|&bull; state_type
 +
|Строка
 +
|Тип состояния. Может принимать значения:
 +
 
 +
• "accepted" — заказ принят
 +
 
 +
• "in_work" — заказ в работе
 +
 
 +
• "finished" — заказ выполнен
 +
 
 +
• "aborted" — заказ прекращен
 +
|}
 +
 
 +
Пример:
 +
 
 +
<pre>
 
Запрос:
 
Запрос:
GET https://ip:port/tm_tapi/1.0/get_info_by_phone?phone=89058800565&fields=PHONE_TYPE
 
&signature=ef17ea682d09e452af544a5758dba396
 
  
Секретный ключ:
 
321
 
  
Signature = MD5("phone=89058800565&fields=PHONE_TYPE" + "321") = ef17ea682d09e452af544a5758dba396
+
GET https://ip:port/common_api/1.0/get_order_states_list
  
</pre>
+
Signature: <...>
  
==== Формат ответа ====
+
Ответ:
TM API всегда возвращает HTTP код 200 ОК. Результат выполнения запроса содержится в теле ответа в формате XML. Общий вид возвращаемого результата:
 
  
<pre>
 
<response>
 
<code>Числовой код результата</code>
 
<descr>Строковое описание результата</descr>
 
<data>Дополнительная информация</data>
 
</response>
 
</pre>
 
  
Существуют общие для всех запросов коды результатов:
+
{
{|
+
"code":0,
! Код
+
"descr":"OK",
! Описание
+
"data":{
|-
+
"order_params":[
|0
+
    {
|Успешное выполнение запроса
+
      "id":1,
|-
+
      "name":"Принят",
|1
+
      "state_type":"accepted"
|Неизвестная ошибка
+
    },
|-
+
    {
|2
+
      "id":2,
|Неизвестный тип API
+
      "name":"В работе",
|-
+
      "state_type":"in_work"
|3
+
      },
|API отключено в настройках модуля TM API в Такси-Мастер
+
    ...
|-
+
                ]
|4
+
        }
|Не совпадает секретный ключ
+
}
|-
+
 
|5
+
</pre>
|Неподдерживаемая версия API
 
|-
 
|6
 
|Неизвестное название запроса
 
|-
 
|7
 
|Неверный тип запроса GET
 
|-
 
|8
 
|Не хватает входного параметра (в доп. информации ответа будет название отсутствующего параметра)
 
|-
 
|9
 
|Некорректный входной параметр (в доп. информации ответа будет название некорректного параметра)
 
|-
 
|10
 
|Внутренняя ошибка обработки запроса
 
|}
 
  
=== Описание запросов ===
+
=== Запрос списка состояний экипажа ===
 +
Метод: GET
  
==== Запрос информации по номеру телефона ====
+
Название запроса: get_crew_states_list
Метод: GET
 
  
Название запроса: get_info_by_phone
+
Параметры: нет
  
Параметры:
+
Специальные возвращаемые коды: нет
  
 +
Возвращаемые данные в случае успешного выполнения запроса:
 
{|
 
{|
!Параметр  
+
!Параметр
!Тип  
+
!Тип
 
!Описание
 
!Описание
 
|-
 
|-
!colspan="3"|Обязательные параметры
+
|order_params
 +
|Массив
 +
|Список параметров заказа
 
|-
 
|-
|PHONE
+
|&bull; id
|Строка, <= 16 символов
+
|Целое
|Номер телефона
+
|ИД параметра
 
|-
 
|-
|FIELDS
+
|&bull; name
 
|Строка
 
|Строка
|Список полей, которые необходимо вернуть. Поля перечисляются через символ ''"-"''
+
|Название параметра
 
|-
 
|-
|signature
+
|&bull; state_type
|Строка  
+
|Строка
|Поле для проверки секретного ключа.
+
|Тип состояния. Может принимать значения:
|}
 
  
Специальные возвращаемые коды: нет
+
• "waiting" — экипаж свободен
  
Возвращаемые данные в случае успешного выполнения запроса: зависит от того какие поля были переданы в поле fields.
+
• "not_available" — экипаж не на линии
  
{|
+
• "on_order" — экипаж на заказе
!Параметр
 
!Тип
 
!Описание
 
|-
 
|PHONE_TYPE
 
|Целое
 
|Тип телефона звонящего:
 
1 - если звонит водитель с основного телефона;
 
  
2 - если звонит физическое лицо;
+
• "on_break" — экипаж на перерыве
 +
|}
  
3 - если звонит юридическое лицо;
+
Пример:
  
4 - если звонит номер из справочника Телефоны;
+
<pre>
 +
Запрос:
 +
GET https://ip:port/common_api/1.0/get_crew_states_list
 +
Signature: <...>
  
5 - если звонит водитель с неосновного телефона;
+
Ответ:
 +
{
 +
"code":0,
 +
"descr":"OK",
 +
"data":{
 +
"order_params":[
 +
        {
 +
          "id":1,
 +
          "name":"Свободен",
 +
          "state_type":"waiting"
 +
        },
 +
        {
 +
          "id":2,
 +
          "name":"Не работает",
 +
          "state_type":"not_available"
 +
        },
 +
        ...
 +
              ]
 +
        }
 +
}
  
6 - если звонит ЦОЗ водитель;
+
</pre>
 +
 
 +
 
 +
=== Запрос глобальных атрибутов ===
 +
Метод: GET
 +
 
 +
Название запроса: get_global_attributes
 +
 
 +
Версия ТМ: 3.9
 +
 
 +
Параметры: нет
 +
 
 +
Специальные возвращаемые коды: нет
  
0 - неизвестный номер.
+
Возвращаемые данные в случае успешного выполнения запроса:
 +
{|
 +
!Параметр
 +
!Тип
 +
!Описание
 
|-
 
|-
|PHONE_TO_DIAL
+
|global_attributes
|Строка, <= 16 символов
+
|Массив
|Номер телефона для отзвона по заказу
+
|Массив значений глобальных атрибутов
 
|-
 
|-
|CREW_ID
+
|&bull; id
|Целое
 
|ИД экипажа
 
|-
 
|IS_PRIOR
 
|0 или 1 (false или true)
 
|Признак предварительного заказа
 
|-
 
|IS_PRIZE
 
|0 или 1 (false или true)
 
|Признак призового заказа
 
|-
 
|ORDER_CLIENT_ID
 
 
|Целое
 
|Целое
|ИД клиента из заказа
+
|Идентификатор атрибута
 
|-
 
|-
|DRIVER_PHONE
+
|&bull; bool_value
|Строка, <= 16 символов
+
|true или false
|Номер телефона водителя
+
|Значение, если тип атрибута «Логический»
 
|-
 
|-
|CREW_SYSTEMSTATE
+
|&bull; num_value
|Целое
+
|Дробное
|Состояние экипажа
+
|Значение, если тип атрибута:
 +
* «Число» (непосредственное значение)
 +
* «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
 +
* «Перечисляемый» (значение выбранного элемента перечисления)
 +
* «Дата» и «Дата/время» (Unix-время, всегда целое число)
 
|-
 
|-
|CLIENT_ID
+
|&bull; str_value
|Целое
+
|Строка
|ИД клиента
+
|Значение, если тип атрибута «Строка»
|-
+
|}
|CLIENT_TYPE
+
 
|Целое
+
Пример:
|Тип клиента
+
 
 +
<pre>
 +
Пример запроса:
 +
 
 +
GET https://ip:port/common_api/1.0/get_global_attributes
 +
 
 +
Пример ответа:
 +
 
 +
{
 +
  "code":0,
 +
  "descr":"OK",
 +
  "data":{
 +
    "global_attributes":[
 +
      {
 +
        "id":123,
 +
        "bool_value":true
 +
      },
 +
      {
 +
        "id":124,
 +
        "num_value":314
 +
      },
 +
      {
 +
        "id":125,
 +
        "str_value": "AAA"
 +
      }
 +
    ]
 +
  }
 +
}
 +
 
 +
</pre>
 +
 
 +
=== Изменение глобального атрибута ===
 +
Метод: POST
 +
 
 +
Название запроса: update_global_attribute
 +
 
 +
Версия ТМ: 3.9
 +
 
 +
Параметры в формате JSON:
 +
 
 +
{|
 +
!Параметр
 +
!Тип
 +
!Описание
 
|-
 
|-
|CATEGORYID
+
!colspan="3"|Обязательные параметры
|Целое
 
|ИД категории телефона
 
 
|-
 
|-
|PHONE_SYSTEM_CATEGORY
+
|id
|Целое  
+
|Целое
|Системное значение категории телефона (0 - обычный, 1 - черный, 2 - белый, 3 - серый)
+
|ИД изменяемого атрибута
 
|-
 
|-
|ORDER_ID
+
!colspan="3"|Необязательные параметры
|Целое
 
|ИД заказа
 
 
|-
 
|-
|DRIVER_ID
+
|bool_value
|Целое
+
|true или false
|ИД водителя
+
|Значение, если тип атрибута «Логический»
 
|-
 
|-
|ORDER_STATE
+
|num_value
|Целое
+
|Дробное
|Состояние заказа
+
|Значение, если тип атрибута:
 +
* «Число» (непосредственное значение)
 +
* «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
 +
* «Перечисляемый» (значение выбранного элемента перечисления)
 +
* «Дата» и «Дата/время» (Unix-время, всегда целое число)
 
|-
 
|-
|DRIVER_REMAINDER
+
|str_value
|Дробное
+
|Строка
|Баланс счета водителя
+
|Значение, если тип атрибута «Строка»
 +
|}
 +
 
 +
Специальные возвращаемые коды:
 +
{|
 +
!Код
 +
!Описание
 
|-
 
|-
|DISCOUNTEDSUMM
+
|100
|Строка
+
|Атрибут не найден
|Сумма заказа с учетом всех скидок
 
 
|-
 
|-
|CREW_GROUP_ID
+
|101
|Целое
+
|Атрибут не глобальный
|ИД группы экипажа (если в заказе указан экипаж, то берется ИД группы экипажа, если нет — из карты заказа)
+
|}
|-
+
 
|FIRST_CREW_GROUP_ID
+
Возвращаемые данные в случае успешного выполнения запроса: нет.
|Целое
+
 
|ИД первой группы экипажа
+
Пример:
|-
+
 
|CLIENT_BALANCE
+
<pre>
|Дробное
+
Пример запроса:
|Баланс клиента
+
 
|-
+
POST https://ip:port/common_api/1.0/update_global_attribute HTTP/1.1
|DRIVER_TIMECOUNT
+
Signature: <...>
|Целое
+
Content-Type: application/json
|Время пути водителя до адреса подачи в минутах
+
Content-Length: <...>
|-
+
 
|SOURCE_TIMECOUNT
+
{
|Целое
+
  "id": 12,
|Время оставшееся до подачи в минутах
+
  "bool_value": true
 +
}
 +
 
 +
Пример ответа:
 +
 
 +
{
 +
  "code":0,
 +
  "descr":"OK",
 +
  "data":{}
 +
}
 +
 
 +
</pre>
 +
 
 +
=== Создание резервирования автомобиля ===
 +
Метод: POST
 +
 
 +
Название запроса: create_car_reservation
 +
 
 +
Версия ТМ: 3.9.46
 +
 
 +
Параметры в формате JSON:
 +
{|
 +
!Параметр
 +
!Тип
 +
!Описание
 
|-
 
|-
|SOUND_COLOR
+
!colspan="3"|Обязательные параметры
|Строка
 
|Запись с информацией о цвете
 
 
|-
 
|-
|SOUND_MARK
+
|car_id
|Строка
+
|Целое
|Запись с информацией о марке автомобиля
+
|ИД автомобиля
 
|-
 
|-
|GOSNUMBER
+
|driver_id
|Строка
 
|Государственный номер автомобиля
 
|-
 
|CAR_COLOR
 
|Строка
 
|Цвет автомобиля
 
|-
 
|CAR_MARK
 
|Строка
 
|Марка автомобиля
 
|-
 
|ORDER_COORDS
 
|Строка
 
|Координаты места подачи. Порядок координат: долгота адреса, широта адреса.
 
|-
 
|CREW_COORDS
 
|Строка
 
|Координаты назначенного экипажа. Порядок координат: долгота адреса, широта адреса.
 
|-
 
|MARKET_TYPE
 
 
|Целое
 
|Целое
|Тип биржи заказов (2 — Яндекс, 3 — ЦОЗ).
+
|ИД водителя
 
|-
 
|-
|ORDERS_COUNT
+
|car_reservation_type_id
 
|Целое
 
|Целое
|Для телефона клиента — количество текущих и предварительных заказов по телефону; для телефона водителя — количество текущих заказов, на которые назначен данный водитель
+
|ИД типа резервирования
 
|-
 
|-
|CLIENT_GROUP_ID
+
|start_time
|Целое
+
|ГГГГММДД
|ИД группы клиента
+
 
 +
или
 +
 
 +
ГГГГММДДччммсс
 +
|Дата или дата/время начала.
 +
Если указывается дата без времени, то планируемое время начала резервирования устанавливается исходя из времени начала, указанного в соответствующем типе резервирования
 
|-
 
|-
|CLIENT_BONUS_BALANCE
+
!colspan="3"|Необязательные параметры
|Дробное
 
|Бонусный баланс клиента
 
 
|-
 
|-
|AD_LIGHTHOUSE
+
|finish_time
 +
|ГГГГММДДччммсс
 +
|Время окончания резервирования. Если не указано, рассчитывается на основании времени планируемого начала резервирования и продолжительности резервирования, указанного в соответствующем типе резервирования
 +
|-
 +
|comment
 
|Строка
 
|Строка
|Признак наличия шашек. Пустая строка – номер клиента или водителя без экипажа. 1 – есть шашки, 0 – нет шашек.
+
|Комментарий
 +
|}
 +
 
 +
Специальные возвращаемые коды:
 +
{|
 +
!Код
 +
!Описание
 
|-
 
|-
|CREW_STATE
+
|100
|Целое
+
|Не найден автомобиль
|Состояние экипажа.
 
 
|-
 
|-
|SOURCE_TIME
+
|101
|ГГГГММДДччммсс
+
|Не найден водитель
|Дата и время подачи
 
 
|-
 
|-
|DRV_SHIFT_START_TIME
+
|102
|ГГГГММДДччммсс
+
|Не найден тип резервирования
|Начало фактической смены водителя
 
 
|-
 
|-
|START_USER_SIP_ACCOUNTS
+
|103
|Строка
+
|Время начала резервирования должно быть меньше времени завершения
|Список логинов SIP–аккаунтов пользователя, принявшего заказ
 
 
|-
 
|-
|CREATION_WAY
+
|104
|Строка
+
|Автомобиль уже зарезервирован в указанный период времени
|Способ создания заказа (operator, sms, market, common_api, t_api, taxophone, driver, daily_order, taxophone_web, unknown)
 
 
|-
 
|-
|CREATOR_TAXI_PHONE
+
|105
|Строка
+
|Водитель уже имеет зарезервированный автомобиль в указанный период времени
|Телефон службы-создателя для заказов, принятых из ЦОЗ
+
|}
 +
 
 +
Возвращаемые данные в случае успешного выполнения запроса:
 +
{|
 +
!Параметр
 +
!Тип
 +
!Описание
 
|-
 
|-
|PERFORMER_TAXI_PHONE
+
|car_reservation_id
|Строка
+
|Целое
|Телефон службы-исполнителя для заказов, отданных в ЦОЗ
+
|ИД резервирования
|-
 
|CLIENT_IS_LOCKED
 
|0 или 1 (false или true)
 
|Признак блокировки клиента
 
 
|}
 
|}
 
Пример:
 
  
 
<pre>
 
<pre>
Запрос:
+
Пример запроса:
GET https://ip:port/tm_tapi/1.0/get_info_by_phone?phone=89058800565l&fields=PHONE_TYPE-PHONE_
 
TO_DIAL-CREW_ID-ORDER_ID&signature=d35ab2765f2968d48c096d5f5327db26
 
  
Ответ:
+
POST https://ip:port/common_api/1.0/create_car_reservation HTTP/1.1
 +
Signature: <...>
 +
Content-Type: application/json
 +
Content-Length: <...>
 +
 
 +
{
 +
  "car_id": 1,
 +
  "driver_id": 1,
 +
  "car_reservation_type_id": 1,
 +
  "start_date": "20201231",
 +
  "comment": "COMMENT"
 +
}
 +
 
 +
Пример ответа:
 +
 
 +
{
 +
  "code": 0,
 +
  "descr": "OK",
 +
  "data": {
 +
    "car_reservation_id": 5
 +
  }
 +
}
  
<response>
 
  <code>0</code>
 
  <descr>OK</descr>
 
  <data>
 
    <PHONE_TYPE>0</PHONE_TYPE>
 
    <PHONE_TO_DIAL></PHONE_TO_DIAL>
 
    <CREW_ID>3</CREW_ID>
 
    <ORDER_ID>6</ORDER_ID>
 
    <SOURCE_TIME>20140929134911</SOURCE_TIME>
 
    <DRV_SHIFT_START_TIME>20141007105050</DRV_SHIFT_START_TIME>
 
  </data>
 
</response>
 
 
</pre>
 
</pre>
  
==== Запрос информации по ИД заказа ====
+
=== Создание недоступности автомобиля ===
 
+
Метод: POST
Метод: GET
 
  
Название запроса: get_info_by_order_id
+
Название запроса: create_car_inaccessibility
  
Параметры:
+
Версия ТМ: 3.9.46
  
 +
Параметры в формате JSON:
 
{|
 
{|
!Параметр  
+
!Параметр
!Тип  
+
!Тип
 
!Описание
 
!Описание
 
|-
 
|-
 
!colspan="3"|Обязательные параметры
 
!colspan="3"|Обязательные параметры
 
|-
 
|-
|ORDER_ID
+
|car_id
|Целое  
+
|Целое
|ИД заказа
+
|ИД автомобиля
 +
|-
 +
|car_inaccessibility_type_id
 +
|Целое
 +
|ИД типа недоступности
 +
|-
 +
|start_time
 +
|ГГГГММДДччммсс
 +
|Время начала
 +
|-
 +
!colspan="3"|Необязательные параметры
 
|-
 
|-
|FIELDS
+
|finish_time
|Строка
+
|ГГГГММДДччммсс
|Список полей, которые необходимо вернуть. Поля перечисляются через символ ''"-"''
+
|Время завершения
 
|-
 
|-
|signature
+
|comment
|Строка  
+
|Строка
|Поле для проверки секретного ключа
+
|Комментарий
 
|}
 
|}
  
Специальные возвращаемые коды: нет
+
Специальные возвращаемые коды:
 
 
Возвращаемые данные в случае успешного выполнения запроса: зависит от того какие поля были переданы в поле fields.
 
 
 
 
{|
 
{|
!Параметр
+
!Код
!Тип
 
 
!Описание
 
!Описание
 
|-
 
|-
|DRIVER_TIMECOUNT
+
|100
|Строка, <= 16 символов
+
|Не найден автомобиль
|Время до подачи в минутах, указанное водителем
 
 
|-
 
|-
|SOUND_COLOR
+
|101
|Строка
+
|Не найден тип недоступности
|Запись с информацией о цвете
 
 
|-
 
|-
|CAR_MARK
+
|102
|Строка
+
|Время начала недоступности должно быть меньше времени завершения
|Марка автомобиля
+
|}
 +
 
 +
Возвращаемые данные в случае успешного выполнения запроса:
 +
{|
 +
!Параметр
 +
!Тип
 +
!Описание
 
|-
 
|-
|CAR_COLOR
+
|car_inaccessibility_id
|Строка
+
|Целое
|Цвет автомобиля
+
|ИД недоступности
 +
|}
 +
 
 +
<pre>
 +
Пример запроса:
 +
 
 +
POST https://ip:port/common_api/1.0/create_car_inaccessibility HTTP/1.1
 +
Signature: <...>
 +
Content-Type: application/json
 +
Content-Length: <...>
 +
 
 +
{
 +
  "car_id": 1,
 +
  "car_inaccesibility_type_id": 1,
 +
  "start_time": "20201231235959",
 +
  "finish_time": "20210101050000",
 +
  "comment": "COMMENT"
 +
}
 +
 
 +
Пример ответа:
 +
 
 +
{
 +
  "code": 0,
 +
  "descr": "OK",
 +
  "data": {
 +
    "car_inaccessibility_id": 5
 +
  }
 +
}
 +
 
 +
</pre>
 +
 
 +
=== Вызвать системное событие ===
 +
Метод: POST
 +
 
 +
Название запроса: run_system_event
 +
 
 +
Версия ТМ: 3.10
 +
 
 +
Параметры в формате JSON:
 +
{|
 +
!Параметр
 +
!Тип
 +
!Описание
 
|-
 
|-
|GOSNUMBER
+
!colspan="3"|Обязательные параметры
|Строка
 
|Государственный номер автомобиля
 
|-
 
|SOUND_MARK
 
|Строка
 
|Запись с информацией о марке автомобиля
 
|-
 
|CREW_GROUP_ID
 
|Целое
 
|ИД группы экипажа (значение из карты заказа)
 
 
|-
 
|-
|FIRST_CREW_GROUP_ID
+
|system_event_id
 
|Целое
 
|Целое
|ИД первой группы экипажа
+
|ИД системного события с типом "По запросу CommonAPI"
 
|-
 
|-
|IS_PRIOR
+
!colspan="3"|Необязательные параметры
|0 или 1 (false или true)
 
|Признак предварительного заказа
 
 
|-
 
|-
|IS_PRIZE
+
|Произвольный параметр
|0 или 1 (false или true)
+
|любой
|Признак призового заказа
+
|В запросе можно передавать дополнительные произвольные параметры с любыми названиями и значениями. Эти параметры могут использоваться в системном событии.
 +
|}
 +
 
 +
Специальные возвращаемые коды:
 +
{|
 +
!Код
 +
!Описание
 
|-
 
|-
|DISCOUNTEDSUMM
+
|100
|Строка
+
|У системного события тип не "По запросу CommonAPI"
|Сумма заказа с учетом всех скидок
 
 
|-
 
|-
|DRIVER_PHONE
+
|101
|Строка, <= 16 символов
+
|Системное событие не найдено
|Номер телефона водителя
 
 
|-
 
|-
|CATEGORYID
+
|102
|Целое
+
|Системное событие не активно
|ИД категории телефона
+
|}
 +
 
 +
Возвращаемые данные в случае успешного выполнения запроса: нет.
 +
 
 +
<pre>
 +
Пример запроса:
 +
 
 +
POST https://ip:port/common_api/1.0/run_system_event HTTP/1.1
 +
Signature: <...>
 +
Content-Type: application/json
 +
Content-Length: <...>
 +
 
 +
{
 +
  "system_event_id": 123,
 +
  "custom_param_1": true
 +
  "custom_param_2": 123,
 +
  "custom_param_3": 123.45,
 +
  "custom_param_4": "aaa"
 +
}
 +
 
 +
Пример ответа:
 +
 
 +
{
 +
  "code":0,
 +
  "descr":"OK",
 +
  "data":{}
 +
}
 +
 
 +
</pre>
 +
 
 +
=== Проверить штраф клиента за отмену заказа ===
 +
Метод: GET
 +
 
 +
Название запроса: check_cancel_order_penalty
 +
 
 +
Версия ТМ: 3.11
 +
 
 +
Параметры в формате JSON:
 +
{|
 +
!Параметр
 +
!Тип
 +
!Описание
 
|-
 
|-
|SOURCE_TIMECOUNT
+
!colspan="3"|Обязательные параметры
|Целое
 
|Время до подачи в минутах
 
 
|-
 
|-
|ORDER_COORDS
+
|order_id
|Строка
+
|Целое
|Координаты места подачи. Порядок координат: долгота адреса, широта адреса.
+
|ИД заказа
 
|-
 
|-
|CREW_COORDS
+
|cancel_order_state_id
|Строка
+
|Целое
|Координаты назначенного экипажа. Порядок координат: долгота адреса, широта адреса.
+
|ИД состояния заказа, в которое переходит заказ при отмене
 +
|}
 +
 
 +
Специальные возвращаемые коды:
 +
{|
 +
!Код
 +
!Описание
 
|-
 
|-
|ORDER_STATE
+
|100
|Целое
+
|Не найден заказ ИД=order_id
|ИД состояния заказа
 
 
|-
 
|-
|MARKET_TYPE
+
|101
|Целое
+
|Не найдено состояние заказа ИД=cancel_order_state_id
|Тип биржи заказов (2 — Яндекс, 3 — ЦОЗ).
 
 
|-
 
|-
|AD_LIGHTHOUSE
+
|102
|Строка
+
|Состояние заказа не соответствует необходимым условиям
|Признак наличия шашек (1 – шашки есть, 0 – шашек нет).
+
|}
 +
 
 +
Возвращаемые данные в случае успешного выполнения запроса:
 +
{|
 +
!Параметр
 +
!Тип
 +
!Описание
 
|-
 
|-
|CREW_STATE
+
|cancel_order_penalty_sum
|Целое
+
|Дробное
|Состояние экипажа
+
|Величина штрафа, которая будет начислена клиенту в случае отмены заказа или 0, если штрафа нет
|-
 
|SOURCE_TIME
 
|ГГГГММДДччммсс
 
|Дата и время подачи
 
|-
 
|START_USER_SIP_ACCOUNTS
 
|Строка
 
|Список логинов SIP–аккаунтов пользователя, принявшего заказ
 
|-
 
|ORDER_PARAMS
 
|Целое
 
|Список ИД параметров заказа
 
|-
 
|CREATION_WAY
 
|Строка
 
|Способ создания заказа (operator, sms, market, common_api, t_api, taxophone, driver, daily_order, taxophone_web, unknown)
 
|-
 
|CREATOR_TAXI_PHONE
 
|Строка
 
|Телефон службы-создателя для заказов, принятых из ЦОЗ
 
|-
 
|PERFORMER_TAXI_PHONE
 
|Строка
 
|Телефон службы-исполнителя для заказов, отданных в ЦОЗ
 
 
|}
 
|}
  
Пример:
 
  
 
<pre>
 
<pre>
Запрос:
+
Пример запроса:
 +
GET https://ip:port/common_api/1.0/check_cancel_order_penalty?order_id=12345&cancel_order_state_id=12 HTTP/1.1
 +
Signature: <...>
 +
 
 +
Пример ответа:
 +
{
 +
  "code":0,
 +
  "descr":"OK",
 +
  "data":{
 +
    "cancel_order_penalty_sum":350
 +
  }
 +
}
  
GET https://ip:port/tm_tapi/1.0/get_info_by_order_id?order_id=60&fields=DRIVER_SOURCETIME-MARKCOLOR-
 
GOSNUMBER-IS_PRIOR-MOBILE_PHONE-SOURCE_TIME&signature=fdcd04e570443b56176b83f44748dc23
 
 
 
Ответ:
 
  
<response>
 
  <code>0</code>
 
  <descr>OK</descr>
 
  <data>
 
    <DRIVER_SOURCETIME></DRIVER_SOURCETIME>
 
    <MARK></MARK>
 
    <COLOR></COLOR>
 
    <GOSNUMBER></GOSNUMBER>
 
    <IS_PRIOR></IS_PRIOR>
 
    <MOBILE_PHONE></MOBILE_PHONE>
 
    <SOURCE_TIME>20140929134911</SOURCE_TIME>
 
  </data>
 
</response>
 
 
</pre>
 
</pre>
  
==== Смена состояния заказа ====
+
=== Запрос трека экипажа ===
Метод: POST
+
Метод: GET
 +
 
 +
Название запроса: get_crew_track
  
Название запроса: change_order_state
+
Версия ТМ: 3.11
  
 
Параметры:
 
Параметры:
 
 
{|
 
{|
!Параметр  
+
!Параметр
!Тип  
+
!Тип
 
!Описание
 
!Описание
 
|-
 
|-
 
!colspan="3"|Обязательные параметры
 
!colspan="3"|Обязательные параметры
 
|-
 
|-
|ORDER_ID
+
|crew_id
|Целое  
+
|Целое
|ИД заказа
+
|ИД экипажа
 
|-
 
|-
|NEED_STATE
+
|start_time
|Целое
+
|ГГГГММДДччммсс
|Новое состояние заказа
+
|Начало периода
 
|-
 
|-
|signature
+
|finish_time
|Строка
+
|ГГГГММДДччммсс
|Поле для проверки секретного ключа
+
|Конец периода, должен отличаться о начала периода не более чем на 7 дней
 
|}
 
|}
  
 
Специальные возвращаемые коды:
 
Специальные возвращаемые коды:
 
 
{|
 
{|
!Код  
+
!Код
 
!Описание
 
!Описание
 
|-
 
|-
|100  
+
|100
|Заказ с таким ИД не найден
+
|Не найден экипаж ИД=crew_id
 
|-
 
|-
|101  
+
|101
|Изменение состояния не соответствует необходимым условиям
+
|Задан период времени более 7 дней
 
|}
 
|}
  
Возвращаемые данные в случае успешного выполнения запроса:
+
Возвращаемые данные в случае успешного выполнения запроса:  
 
 
 
{|
 
{|
!Параметр  
+
!Параметр
!Тип  
+
!Тип
 
!Описание
 
!Описание
 
|-
 
|-
|ORDER_ID
+
|track
|Целое
+
|Массив
|ИД заказа
+
|Массив, трек экипажа за период времени
 
|-
 
|-
|NEED_STATE
+
|&bull; lat
|Целое  
+
|Дробное
|Новое состояние заказа
+
|Широта точки маршрута
 +
|-
 +
|&bull; lon
 +
|Дробное
 +
|Долгота точки маршрута
 +
|-
 +
|&bull; time
 +
|ГГГГММДДччммсс
 +
|Время данной точки
 +
|-
 +
|&bull; speed
 +
|Целое
 +
|Скорость в данный момент, км/ч
 +
|-
 +
|&bull; direction
 +
|Целое
 +
|Направление движения, градусы (0 - север, 90 - восток, 180 - юг, 270 - запад)
 
|}
 
|}
  
Пример:
 
  
 
<pre>
 
<pre>
Запрос:
+
Пример запроса:
  
POST https://ip:port/tm_tapi/1.0/change_order_state
+
GET https://ip:port/common_api/1.0/get_crew_track?crew_id=1&start_time=20210911120000&finish_time=20210911130000 HTTP/1.1
Content-Type: application/x-www-form-urlencoded
+
Signature: <...>
Content-Length: 71
 
  
order_id=18561&need_state=14&signature=3e8107e0c044e55d983db1fbed82fd8c
+
Пример ответа:
  
Ответ:
+
{
 +
  "code":0,
 +
  "descr":"OK",
 +
  "data":{
 +
    "track": [
 +
      {
 +
        "lat": 11.111111,
 +
        "lon": 22.222222,
 +
        "time": "20210911120000",
 +
        "speed": 123,
 +
        "direction": 0
 +
      }
 +
    ]
 +
  }
 +
}
  
<response>
 
  <code>0</code>
 
  <descr>OK</descr>
 
  <data>
 
    <ORDER_ID>18561</ORDER_ID>
 
    <NEW_STATE>14</NEW_STATE>
 
  </data>
 
</response>
 
 
</pre>
 
</pre>
  
==== Запись пути к файлу разговора в базу данных ====
+
=== Создание фиксированной смены водителя ===
 +
Метод: POST
 +
 
 +
Название запроса: create_fixed_driver_shift
 +
 
 +
Версия ТМ: 3.12
 +
 
 +
Параметры:
 +
{|
 +
!Параметр
 +
!Тип
 +
!Описание
 +
|-
 +
!colspan="3"|Обязательные параметры
 +
|-
 +
|driver_id
 +
|Целое
 +
|ИД водителя
 +
|-
 +
|start_time
 +
|ГГГГММДДччммсс
 +
|Время начала
 +
|-
 +
|finish_time
 +
|ГГГГММДДччммсс
 +
|Время завершения
 +
|}
 +
 
 +
Специальные возвращаемые коды:
 +
{|
 +
!Код
 +
!Описание
 +
|-
 +
|100
 +
|Не найден водитель
 +
|-
 +
|101
 +
|Время начала фиксированной смены должно быть меньше времени завершения
 +
|-
 +
|102
 +
|Создаваемая смена пересекается по времени с уже существующей сменой данного водителя
 +
|}
 +
 
 +
Возвращаемые данные в случае успешного выполнения запроса:
 +
{|
 +
!Параметр
 +
!Тип
 +
!Описание
 +
|-
 +
|fixed_driver_shift_id
 +
|Целое
 +
|ИД фиксированной смены
 +
|}
 +
 
 +
Пример:
 +
<pre>
 +
Запрос:
 +
 
 +
POST https://ip:port/common_api/1.0/create_fixed_driver_shift HTTP/1.1
 +
Signature: <...>
 +
Content-Type: application/json
 +
Content-Length: <...>
 +
 
 +
{
 +
  "driver_id": 1,
 +
  "start_time": "20201231235959",
 +
  "finish_time": "20210101050000"
 +
}
 +
 
 +
Ответ:
 +
 
 +
{
 +
  "code": 0,
 +
  "descr": "OK",
 +
  "data": {
 +
    "fixed_driver_shift_id": 5
 +
  }
 +
}
 +
 
 +
</pre>
 +
 
 +
=== Удаление фиксированной смены водителя ===
 +
Метод: POST
 +
 
 +
Название запроса: delete_fixed_driver_shift
 +
 
 +
Версия ТМ: 3.12
 +
 
 +
Параметры:
 +
{|
 +
!Параметр
 +
!Тип
 +
!Описание
 +
|-
 +
!colspan="3"|Обязательные параметры
 +
|-
 +
|fixed_driver_shift_id
 +
|Целое
 +
|ИД фиксированной смены водителя
 +
|}
 +
 
 +
Специальные возвращаемые коды:
 +
{|
 +
!Код
 +
!Описание
 +
|-
 +
|100
 +
|Фиксированная смена водителя не найдена
 +
|}
 +
 
 +
Возвращаемые данные в случае успешного выполнения запроса: нет.
 +
 
 +
Пример:
 +
<pre>
 +
Запрос:
 +
 
 +
POST https://ip:port/common_api/1.0/delete_fixed_driver_shift HTTP/1.1
 +
Signature: <...>
 +
Content-Type: application/x-www-form-urlencoded
 +
Content-Length: <...>
 +
 
 +
fixed_driver_shift_id=1
 +
 
 +
Ответ:
 +
 
 +
{
 +
  "code":0,
 +
  "descr":"OK",
 +
  "data":{}
 +
}
 +
 
 +
</pre>
 +
 
 +
 
 +
=== Создание путевого листа ===
 +
Метод: POST
 +
 
 +
Название запроса: create_way_bill
 +
 
 +
Версия ТМ: 3.14
 +
 
 +
Параметры:
 +
{|
 +
!Параметр
 +
!Тип
 +
!Описание
 +
|-
 +
!colspan="3"|Обязательные параметры
 +
|-
 +
|start_time
 +
|ГГГГММДДччммсс
 +
|Время начала
 +
|-
 +
|finish_time
 +
|ГГГГММДДччммсс
 +
|Время завершения
 +
|-
 +
|driver_id
 +
|Целое
 +
|ИД водителя
 +
|-
 +
|car_id
 +
|Целое
 +
|ИД автомобиля
 +
|-
 +
!colspan="3"|Необязательные параметры
 +
|-
 +
|number
 +
|Строка
 +
|Номер путевого листа
 +
|-
 +
|comment
 +
|Строка
 +
|Комментарий
 +
|}
 +
 
 +
Специальные возвращаемые коды:
 +
{|
 +
!Код
 +
!Описание
 +
|-
 +
|100
 +
|Нет лицензии на использование путевых листов
 +
|-
 +
|101
 +
|Не найден водитель
 +
|-
 +
|102
 +
|Не найден автомобиль
 +
|}
 +
 
 +
Возвращаемые данные в случае успешного выполнения запроса:
 +
{|
 +
!Параметр
 +
!Тип
 +
!Описание
 +
|-
 +
|way_bill_id
 +
|Целое
 +
|ИД созданного путевого листа
 +
|}
 +
 
 +
Пример:
 +
<pre>
 +
Запрос:
 +
 
 +
POST https://ip:port/common_api/1.0/create_way_bill HTTP/1.1
 +
Signature: <...>
 +
Content-Type: application/json
 +
Content-Length: <...>
 +
 
 +
{
 +
  "number": "api_123",
 +
  "start_time": "20230508000000",
 +
  "finish_time": "20230509000000",
 +
  "driver_id": 123,
 +
  "car_id": 123,
 +
  "comment": "Комментарий"
 +
}
 +
 
 +
Ответ:
 +
 
 +
{
 +
  "code": 0,
 +
  "descr": "OK",
 +
  "data": {
 +
    "way_bill_id": 5
 +
  }
 +
}
 +
 
 +
</pre>
 +
 
 +
=== Создание осмотра по путевому листу ===
 +
Метод: POST
 +
 
 +
Название запроса: create_way_bill_check
 +
 
 +
Версия ТМ: 3.14
 +
 
 +
Параметры:
 +
{|
 +
!Параметр
 +
!Тип
 +
!Описание
 +
|-
 +
!colspan="3"|Обязательные параметры
 +
|-
 +
|way_bill_id
 +
|Целое
 +
|ИД путевого листа (должен быть задан либо ИД либо номер)
 +
|-
 +
|way_bill_number
 +
|Строка
 +
|Номер путевого листа (должен быть задан либо ИД либо номер)
 +
|-
 +
|kind
 +
|Строка
 +
|Тип осмотра ("med/tech")
 +
|-
 +
|user_name
 +
|Строка
 +
|Имя пользователя
 +
|-
 +
|success
 +
|true или false
 +
|Результат осмотра
 +
|-
 +
!colspan="3"|Необязательные параметры
 +
|-
 +
|number
 +
|Строка
 +
|Номер осмотра
 +
|-
 +
|comment
 +
|Строка
 +
|Комментарий
 +
|}
 +
 
 +
Специальные возвращаемые коды:
 +
{|
 +
!Код
 +
!Описание
 +
|-
 +
|100
 +
|Нет лицензии на использование путевых листов
 +
|-
 +
|101
 +
|Не найден путевой лист
 +
|}
 +
 
 +
Возвращаемые данные в случае успешного выполнения запроса: нет
 +
 
 +
Пример:
 +
<pre>
 +
Запрос:
 +
 
 +
POST https://ip:port/common_api/1.0/create_way_bill_check HTTP/1.1
 +
Signature: <...>
 +
Content-Type: application/json
 +
Content-Length: <...>
 +
 
 +
{
 +
  "way_bill_id": 123,
 +
  "number": "api_med_123",
 +
  "kind": "med",
 +
  "user_name": "Имя",
 +
  "success": true,
 +
  "comment": "Комментарий"
 +
}
 +
 
 +
Ответ:
 +
 
 +
{
 +
  "code": 0,
 +
  "descr": "OK",
 +
  "data": {}
 +
}
 +
 
 +
</pre>
 +
 
 +
== Описание протокола TMTAPI Версия 1.0 ==
 +
 
 +
=== Общее описание протокола ===
 +
 
 +
==== Формат запроса ====
 +
 
 +
TM API принимает входящие запросы по протоколу HTTPS. В URI запроса после ip адреса и порта, который будет слушать TM API, должно идти название API (tm_tapi) и версия API.
 +
 
 +
Пример:
 +
 
 +
<pre>
 +
GET https://ip:port/tm_tapi/1.0/get_info_by_phone
 +
</pre>
 +
 
 +
Для получения данных из БД используются запросы типа GET. Для записи данных в БД используются запросы типа POST. В запросе типа GET параметры запроса передаются в URI.
 +
 
 +
Пример:
 +
 
 +
<pre>
 +
GET https://ip:port/tm_tapi/1.0/get_info_by_phone?phone=89058800565&fields=PHONE_TYPE-PHONE_
 +
TO_DIAL&signature=661ce071eeefcb4f7fc8bc1f17bd520b
 +
</pre>
 +
 
 +
В запросе типа POST параметры передаются в теле запроса в формате application/x-www-form-
 +
urlencoded.
 +
 
 +
Пример:
 +
 
 +
<pre>
 +
POST https://ip:port/tm_tapi/1.0/change_order_state
 +
Content-Type: application/x-www-form-urlencoded
 +
Content-Length: 71
 +
 
 +
order_id=98798&need_state=12&signature=a204c50c7e48f0c6849a87485fe5e171
 +
</pre>
 +
 
 +
В любом запросе обязательно с другими полями должно передаваться поле signature. В нем передается MD5 хэш, рассчитанный для строки, которая получается сцеплением строки параметров запроса с секретным ключом. Секретный ключ задается в настройках модуля TMAPI в Такси-Мастер.
 +
 
 +
Пример:
 +
 
 +
<pre>
 +
Запрос:
 +
GET https://ip:port/tm_tapi/1.0/get_info_by_phone?phone=89058800565&fields=PHONE_TYPE
 +
&signature=ef17ea682d09e452af544a5758dba396
 +
 
 +
Секретный ключ:
 +
321
 +
 
 +
Signature = MD5("phone=89058800565&fields=PHONE_TYPE" + "321") = ef17ea682d09e452af544a5758dba396
 +
 
 +
</pre>
 +
 
 +
==== Формат ответа ====
 +
TM API всегда возвращает HTTP код 200 ОК. Результат выполнения запроса содержится в теле ответа в формате XML. Общий вид возвращаемого результата:
 +
 
 +
<pre>
 +
<response>
 +
<code>Числовой код результата</code>
 +
<descr>Строковое описание результата</descr>
 +
<data>Дополнительная информация</data>
 +
</response>
 +
</pre>
 +
 
 +
Существуют общие для всех запросов коды результатов:
 +
{|
 +
! Код
 +
! Описание
 +
|-
 +
|0
 +
|Успешное выполнение запроса
 +
|-
 +
|1
 +
|Неизвестная ошибка
 +
|-
 +
|2
 +
|Неизвестный тип API
 +
|-
 +
|3
 +
|API отключено в настройках модуля TM API в Такси-Мастер
 +
|-
 +
|4
 +
|Не совпадает секретный ключ
 +
|-
 +
|5
 +
|Неподдерживаемая версия API
 +
|-
 +
|6
 +
|Неизвестное название запроса
 +
|-
 +
|7
 +
|Неверный тип запроса GET
 +
|-
 +
|8
 +
|Не хватает входного параметра (в доп. информации ответа будет название отсутствующего параметра)
 +
|-
 +
|9
 +
|Некорректный входной параметр (в доп. информации ответа будет название некорректного параметра)
 +
|-
 +
|10
 +
|Внутренняя ошибка обработки запроса
 +
|}
 +
 
 +
=== Описание запросов ===
 +
 
 +
==== Запрос информации по номеру телефона ====
 +
Метод: GET
 +
 
 +
Название запроса: get_info_by_phone
 +
 
 +
Параметры:
 +
 
 +
{|
 +
!Параметр
 +
!Тип
 +
!Описание
 +
|-
 +
!colspan="3"|Обязательные параметры
 +
|-
 +
|PHONE
 +
|Строка, <= 16 символов
 +
|Номер телефона
 +
|-
 +
|FIELDS
 +
|Строка
 +
|Список полей, которые необходимо вернуть. Поля перечисляются через символ ''"-"''
 +
|-
 +
|signature
 +
|Строка
 +
|Поле для проверки секретного ключа.
 +
|}
 +
 
 +
Специальные возвращаемые коды: нет
 +
 
 +
Возвращаемые данные в случае успешного выполнения запроса: зависит от того какие поля были переданы в поле fields.
 +
 
 +
{|
 +
!Параметр
 +
!Тип
 +
!Описание
 +
|-
 +
|PHONE_TYPE
 +
|Целое
 +
|Тип телефона звонящего:
 +
1 - если звонит водитель с основного телефона;
 +
 
 +
2 - если звонит физическое лицо;
 +
 
 +
3 - если звонит юридическое лицо;
 +
 
 +
4 - если звонит номер из справочника Телефоны;
 +
 
 +
5 - если звонит водитель с неосновного телефона;
 +
 
 +
6 - если звонит ЦОЗ водитель;
 +
 
 +
0 - неизвестный номер.
 +
|-
 +
|PHONE_TO_DIAL
 +
|Строка, <= 16 символов
 +
|Номер телефона для отзвона по заказу
 +
|-
 +
|CREW_ID
 +
|Целое
 +
|ИД экипажа
 +
|-
 +
|IS_PRIOR
 +
|0 или 1 (false или true)
 +
|Признак предварительного заказа
 +
|-
 +
|IS_PRIZE
 +
|0 или 1 (false или true)
 +
|Признак призового заказа
 +
|-
 +
|ORDER_CLIENT_ID
 +
|Целое
 +
|ИД клиента из заказа
 +
|-
 +
|DRIVER_PHONE
 +
|Строка, <= 16 символов
 +
|Номер телефона водителя
 +
|-
 +
|CREW_SYSTEMSTATE
 +
|Целое
 +
|Состояние экипажа
 +
|-
 +
|CLIENT_ID
 +
|Целое
 +
|ИД клиента
 +
|-
 +
|CLIENT_TYPE
 +
|Целое
 +
|Тип клиента
 +
|-
 +
|CATEGORYID
 +
|Целое
 +
|ИД категории телефона
 +
|-
 +
|PHONE_SYSTEM_CATEGORY
 +
|Целое
 +
|Системное значение категории телефона (0 - обычный, 1 - черный, 2 - белый, 3 - серый)
 +
|-
 +
|ORDER_ID
 +
|Целое
 +
|ИД заказа
 +
|-
 +
|DRIVER_ID
 +
|Целое
 +
|ИД водителя
 +
|-
 +
|ORDER_STATE
 +
|Целое
 +
|Состояние заказа
 +
|-
 +
|DRIVER_REMAINDER
 +
|Дробное
 +
|Баланс счета водителя
 +
|-
 +
|DISCOUNTEDSUMM
 +
|Строка
 +
|Сумма заказа с учетом всех скидок
 +
|-
 +
|CREW_GROUP_ID
 +
|Целое
 +
|ИД группы экипажа (если в заказе указан экипаж, то берется ИД группы экипажа, если нет — из карты заказа)
 +
|-
 +
|FIRST_CREW_GROUP_ID
 +
|Целое
 +
|ИД первой группы экипажа
 +
|-
 +
|CLIENT_BALANCE
 +
|Дробное
 +
|Баланс клиента
 +
|-
 +
|DRIVER_TIMECOUNT
 +
|Целое
 +
|Время пути водителя до адреса подачи в минутах
 +
|-
 +
|SOURCE_TIMECOUNT
 +
|Целое
 +
|Время оставшееся до подачи в минутах
 +
|-
 +
|GOSNUMBER
 +
|Строка
 +
|Государственный номер автомобиля
 +
|-
 +
|CAR_COLOR
 +
|Строка
 +
|Цвет автомобиля
 +
|-
 +
|CAR_MARK
 +
|Строка
 +
|Марка автомобиля
 +
|-
 +
|CAR_MODEL
 +
|Строка
 +
|Модель автомобиля
 +
|-
 +
|ORDER_COORDS
 +
|Строка
 +
|Координаты места подачи. Порядок координат: долгота адреса, широта адреса.
 +
|-
 +
|CREW_COORDS
 +
|Строка
 +
|Координаты назначенного экипажа. Порядок координат: долгота адреса, широта адреса.
 +
|-
 +
|MARKET_TYPE
 +
|Целое
 +
|Тип биржи заказов (2 — Яндекс, 3 — ЦОЗ).
 +
|-
 +
|ORDERS_COUNT
 +
|Целое
 +
|Для телефона клиента — количество текущих и предварительных заказов по телефону; для телефона водителя — количество текущих заказов, на которые назначен данный водитель
 +
|-
 +
|CLIENT_GROUP_ID
 +
|Целое
 +
|ИД группы клиента
 +
|-
 +
|CLIENT_BONUS_BALANCE
 +
|Дробное
 +
|Бонусный баланс клиента
 +
|-
 +
|AD_LIGHTHOUSE
 +
|Строка
 +
|Признак наличия шашек. Пустая строка – номер клиента или водителя без экипажа. 1 – есть шашки, 0 – нет шашек.
 +
|-
 +
|CREW_STATE
 +
|Целое
 +
|Состояние экипажа.
 +
|-
 +
|SOURCE_TIME
 +
|ГГГГММДДччммсс
 +
|Дата и время подачи
 +
|-
 +
|DRV_SHIFT_START_TIME
 +
|ГГГГММДДччммсс
 +
|Начало фактической смены водителя
 +
|-
 +
|START_USER_SIP_ACCOUNTS
 +
|Строка
 +
|Список логинов SIP–аккаунтов пользователя, принявшего заказ
 +
|-
 +
|CREATION_WAY
 +
|Строка
 +
|Способ создания заказа (operator, sms, market, common_api, t_api, taxophone, driver, daily_order, taxophone_web, unknown)
 +
|-
 +
|CREATOR_TAXI_PHONE
 +
|Строка
 +
|Телефон службы-создателя для заказов, принятых из ЦОЗ
 +
|-
 +
|PERFORMER_TAXI_PHONE
 +
|Строка
 +
|Телефон службы-исполнителя для заказов, отданных в ЦОЗ
 +
|-
 +
|CLIENT_IS_LOCKED
 +
|0 или 1 (false или true)
 +
|Признак блокировки клиента
 +
|}
 +
 
 +
Пример:
 +
 
 +
<pre>
 +
Запрос:
 +
GET https://ip:port/tm_tapi/1.0/get_info_by_phone?phone=89058800565l&fields=PHONE_TYPE-PHONE_
 +
TO_DIAL-CREW_ID-ORDER_ID&signature=d35ab2765f2968d48c096d5f5327db26
 +
 
 +
Ответ:
 +
 
 +
<response>
 +
  <code>0</code>
 +
  <descr>OK</descr>
 +
  <data>
 +
    <PHONE_TYPE>0</PHONE_TYPE>
 +
    <PHONE_TO_DIAL></PHONE_TO_DIAL>
 +
    <CREW_ID>3</CREW_ID>
 +
    <ORDER_ID>6</ORDER_ID>
 +
    <SOURCE_TIME>20140929134911</SOURCE_TIME>
 +
    <DRV_SHIFT_START_TIME>20141007105050</DRV_SHIFT_START_TIME>
 +
  </data>
 +
</response>
 +
</pre>
 +
 
 +
==== Запрос информации по ИД заказа ====
 +
 
 +
Метод: GET
 +
 
 +
Название запроса: get_info_by_order_id
 +
 
 +
Параметры:
 +
 
 +
{|
 +
!Параметр
 +
!Тип
 +
!Описание
 +
|-
 +
!colspan="3"|Обязательные параметры
 +
|-
 +
|ORDER_ID
 +
|Целое
 +
|ИД заказа
 +
|-
 +
|FIELDS
 +
|Строка
 +
|Список полей, которые необходимо вернуть. Поля перечисляются через символ ''"-"''
 +
|-
 +
|signature
 +
|Строка
 +
|Поле для проверки секретного ключа
 +
|}
 +
 
 +
Специальные возвращаемые коды: нет
 +
 
 +
Возвращаемые данные в случае успешного выполнения запроса: зависит от того какие поля были переданы в поле fields.
 +
 
 +
{|
 +
!Параметр
 +
!Тип
 +
!Описание
 +
|-
 +
|DRIVER_TIMECOUNT
 +
|Строка, <= 16 символов
 +
|Время до подачи в минутах, указанное водителем
 +
|-
 +
|CAR_MARK
 +
|Строка
 +
|Марка автомобиля
 +
|-
 +
|CAR_MODEL
 +
|Строка
 +
|Модель автомобиля
 +
|-
 +
|CAR_COLOR
 +
|Строка
 +
|Цвет автомобиля
 +
|-
 +
|GOSNUMBER
 +
|Строка
 +
|Государственный номер автомобиля
 +
|-
 +
|CREW_GROUP_ID
 +
|Целое
 +
|ИД группы экипажа (значение из карты заказа)
 +
|-
 +
|FIRST_CREW_GROUP_ID
 +
|Целое
 +
|ИД первой группы экипажа
 +
|-
 +
|IS_PRIOR
 +
|0 или 1 (false или true)
 +
|Признак предварительного заказа
 +
|-
 +
|IS_PRIZE
 +
|0 или 1 (false или true)
 +
|Признак призового заказа
 +
|-
 +
|DISCOUNTEDSUMM
 +
|Строка
 +
|Сумма заказа с учетом всех скидок
 +
|-
 +
|DRIVER_PHONE
 +
|Строка, <= 16 символов
 +
|Номер телефона водителя
 +
|-
 +
|CATEGORYID
 +
|Целое
 +
|ИД категории телефона
 +
|-
 +
|SOURCE_TIMECOUNT
 +
|Целое
 +
|Время до подачи в минутах
 +
|-
 +
|ORDER_COORDS
 +
|Строка
 +
|Координаты места подачи. Порядок координат: долгота адреса, широта адреса.
 +
|-
 +
|CREW_COORDS
 +
|Строка
 +
|Координаты назначенного экипажа. Порядок координат: долгота адреса, широта адреса.
 +
|-
 +
|ORDER_STATE
 +
|Целое
 +
|ИД состояния заказа
 +
|-
 +
|MARKET_TYPE
 +
|Целое
 +
|Тип биржи заказов (3 — ЦОЗ).
 +
|-
 +
|AD_LIGHTHOUSE
 +
|Строка
 +
|Признак наличия шашек (1 – шашки есть, 0 – шашек нет).
 +
|-
 +
|CREW_STATE
 +
|Целое
 +
|Состояние экипажа
 +
|-
 +
|SOURCE_TIME
 +
|ГГГГММДДччммсс
 +
|Дата и время подачи
 +
|-
 +
|START_USER_SIP_ACCOUNTS
 +
|Строка
 +
|Список логинов SIP–аккаунтов пользователя, принявшего заказ
 +
|-
 +
|ORDER_PARAMS
 +
|Целое
 +
|Список ИД параметров заказа
 +
|-
 +
|CREATION_WAY
 +
|Строка
 +
|Способ создания заказа (operator, sms, market, common_api, t_api, taxophone, driver, daily_order, taxophone_web, unknown)
 +
|-
 +
|CREATOR_TAXI_PHONE
 +
|Строка
 +
|Телефон службы-создателя для заказов, принятых из ЦОЗ
 +
|-
 +
|PERFORMER_TAXI_PHONE
 +
|Строка
 +
|Телефон службы-исполнителя для заказов, отданных в ЦОЗ
 +
|}
 +
 
 +
Пример:
 +
 
 +
<pre>
 +
Запрос:
 +
 
 +
GET https://ip:port/tm_tapi/1.0/get_info_by_order_id?order_id=60&fields=DRIVER_SOURCETIME-MARKCOLOR-
 +
GOSNUMBER-IS_PRIOR-MOBILE_PHONE-SOURCE_TIME&signature=fdcd04e570443b56176b83f44748dc23
 +
 
 +
 
 +
Ответ:
 +
 
 +
<response>
 +
  <code>0</code>
 +
  <descr>OK</descr>
 +
  <data>
 +
    <DRIVER_SOURCETIME></DRIVER_SOURCETIME>
 +
    <MARK></MARK>
 +
    <COLOR></COLOR>
 +
    <GOSNUMBER></GOSNUMBER>
 +
    <IS_PRIOR></IS_PRIOR>
 +
    <MOBILE_PHONE></MOBILE_PHONE>
 +
    <SOURCE_TIME>20140929134911</SOURCE_TIME>
 +
  </data>
 +
</response>
 +
</pre>
 +
 
 +
==== Смена состояния заказа ====
 +
Метод: POST
 +
 
 +
Название запроса: change_order_state
 +
 
 +
Параметры:
 +
 
 +
{|
 +
!Параметр
 +
!Тип
 +
!Описание
 +
|-
 +
!colspan="3"|Обязательные параметры
 +
|-
 +
|ORDER_ID
 +
|Целое
 +
|ИД заказа
 +
|-
 +
|NEED_STATE
 +
|Целое
 +
|Новое состояние заказа
 +
|-
 +
|signature
 +
|Строка
 +
|Поле для проверки секретного ключа
 +
|}
 +
 
 +
Специальные возвращаемые коды:
 +
 
 +
{|
 +
!Код
 +
!Описание
 +
|-
 +
|100
 +
|Заказ с таким ИД не найден
 +
|-
 +
|101
 +
|Изменение состояния не соответствует необходимым условиям
 +
|}
 +
 
 +
Возвращаемые данные в случае успешного выполнения запроса:
 +
 
 +
{|
 +
!Параметр
 +
!Тип
 +
!Описание
 +
|-
 +
|ORDER_ID
 +
|Целое
 +
|ИД заказа
 +
|-
 +
|NEED_STATE
 +
|Целое
 +
|Новое состояние заказа
 +
|}
 +
 
 +
Пример:
 +
 
 +
<pre>
 +
Запрос:
 +
 
 +
POST https://ip:port/tm_tapi/1.0/change_order_state
 +
Content-Type: application/x-www-form-urlencoded
 +
Content-Length: 71
 +
 
 +
order_id=18561&need_state=14&signature=3e8107e0c044e55d983db1fbed82fd8c
 +
 
 +
Ответ:
 +
 
 +
<response>
 +
  <code>0</code>
 +
  <descr>OK</descr>
 +
  <data>
 +
    <ORDER_ID>18561</ORDER_ID>
 +
    <NEW_STATE>14</NEW_STATE>
 +
  </data>
 +
</response>
 +
</pre>
 +
 
 +
==== Запись пути к файлу разговора в базу данных ====
 +
 
 +
Метод: POST
 +
 
 +
Название запроса: create_record_link
 +
 
 +
Параметры:
 +
 
 +
{|
 +
!Параметр
 +
!Тип
 +
!Описание
 +
|-
 +
!colspan="3"|Обязательные параметры
 +
|-
 +
|CALL_ID
 +
|Строка, <= 60 символов
 +
|ИД звонка (необязателен, если указан PHONE)
 +
|-
 +
|PHONE
 +
|Строка, <= 16 символов
 +
|Номер телефона (необязателен, если указан CALL_ID)
 +
|-
 +
|CALL_TYPE
 +
|0 или 1
 +
|0 — Исходящий, 1 — Входящий
 +
|-
 +
|signature
 +
|Строка
 +
|Поле для проверки секретного ключа
 +
|-
 +
!colspan="3"|Необязательные параметры
 +
|-
 +
|RECORD_DATE
 +
|ДДММГГГГччммсс
 +
|Дата записи
 +
|-
 +
|RECORD_LENGTH
 +
|Целое
 +
|Продолжительность записи (в секундах)
 +
|-
 +
|FILE_PATH
 +
|Строка, <=255 символов
 +
|Путь к файлу записи
 +
|-
 +
|USER_LOGIN
 +
|Строка,<=16 символов
 +
|Логин оператора (внутренняя линия)
 +
|-
 +
|EXTERNAL_LINE
 +
|Строка,<=16 символов
 +
|Внешняя линия (на которую пришел входящий звонок)
 +
|-
 +
|TRANSFERED_TO
 +
|Строка,<=30 символов
 +
|Номер телефона(линии) на который(ую) был переведен звонок (доп. параметр для CALL_RESULT="transfered")
 +
|-
 +
|CALL_RESULT
 +
|Строка
 +
|Результат звонка, возможны следующие значения:
 +
* "success" - успешный,
 +
* "no_answer" - не дозвонились,
 +
* "answered" - ответили,
 +
* "missed" - пропущен,
 +
* "transfered" - переведен,
 +
* "broke_off" - сброшен,
 +
* "other_user_answered" - принят другим оператором.
 +
* Если не задан, то "success"
 +
|-
 +
|ORDER_ID
 +
|Целое
 +
|ИД заказа
 +
|}
 +
 
 +
Специальные возвращаемые коды: нет.
 +
 
 +
Возвращаемые данные в случае успешного выполнения запроса
 +
 
 +
{|
 +
!Параметр
 +
!Тип
 +
!Описание
 +
|-
 +
|RECORD_ID
 +
|Целое
 +
|ИД созданной записи
 +
|}
 +
 
 +
Пример:
 +
 
 +
<pre>
 +
Запрос:
 +
 
 +
POST https://ip:port/tm_tapi/1.0/create_record_link HTTP/1.1
 +
Content-Type: application/x-www-form-urlencoded
 +
Content-Length: <...>
  
Метод: POST
+
RECORD_DATE=20130122180949&RECORD_LENGTH=215&CALL_ID=12345&PHONE=8987564&FILE_PATH=d%3A%5Ctemp%5CTM%5Ctrunk%5CSource%5CDevUtils%5CTMAPITest%5C&CALL_TYPE=1&CALL_RESULT=no_answer&signature=<...>
 
 
Название запроса: create_record_link
 
 
 
Параметры:
 
 
 
{|
 
!Параметр
 
!Тип
 
!Описание
 
|-
 
!colspan="3"|Обязательные параметры
 
|-
 
|RECORD_DATE
 
|ДДММГГГГччммсс
 
|Дата записи
 
|-
 
|RECORD_LENGTH
 
|Целое
 
|Продолжительность записи (в секундах)
 
|-
 
|CALL_ID
 
|Строка, <= 60 символов
 
|ИД звонка (необязателен, если указан PHONE)
 
|-
 
|PHONE
 
|Строка, <= 16 символов
 
|Номер телефона (необязателен, если указан CALL_ID)
 
|-
 
|FILE_PATH
 
|Строка, <=255 символов
 
|Путь к файлу записи
 
|-
 
|CALL_TYPE
 
|0 или 1
 
|0 — Исходящий, 1 — Входящий
 
|-
 
|signature
 
|Строка
 
|Поле для проверки секретного ключа
 
|}
 
 
 
Специальные возвращаемые коды: нет.
 
 
 
Возвращаемые данные в случае успешного выполнения запроса
 
 
 
{|
 
!Параметр
 
!Тип
 
!Описание
 
|-
 
|RECORD_ID
 
|Целое
 
|ИД созданной записи
 
|}
 
 
 
Пример:
 
 
 
<pre>
 
Запрос:
 
 
 
POST https://ip:port/tm_tapi/1.0/create_record_link
 
Content-Type: application/x-www-form-urlencoded
 
Content-Length: 185
 
 
 
RECORD_DATE=20130122180949&RECORD_LENGTH=215&CALL_ID=12345&PHONE=8987564&FILE_PATH=d%3A%5Ctemp%5CTM
 
%5Ctrunk%5CSource%5CDevUtils%5CTMAPITest%5C&CALL_TYPE=1&signature=56851c4e8d2d4bb9ba615615f76ad7f7
 
  
 
Ответ:
 
Ответ:
Строка 10 281: Строка 12 468:
 
|-
 
|-
 
|PHONE_TYPE
 
|PHONE_TYPE
|0 или 1
+
|0..2
|Признак, что звонили клиенту (если 0 - водителю)
+
|Признак, что звонили 1-  клиенту, 0 – водителю, 2 -диспетчеру
 
|-
 
|-
 
|ORDER_ID
 
|ORDER_ID

Текущая версия на 09:06, 11 июня 2024

TM API - специальный набор инструментов Такси-Мастер, который позволит объединить систему с вашим сайтом и различными полезными сервисами. Он предоставляется вам на свободных условиях.

Благодаря этому набору вы сможете:

  1. Создать механизм приема заказов через интернет.
  2. Сделать ваш сайт более информативным: публиковать полезную для клиентов информацию прямо из системы - список ближайших экипажей, предварительный расчет стоимости поездки, мониторинг движения автомобиля такси в процессе выполнения заказа, карты города и контактную информацию.
Предупреждение!
Все перечисленные функции работают в Такси-Мастер не ниже 3.14 от 11.12.2023г. В более ранних версиях программы часть функций может не поддерживаться.

Содержание

Параметры TM API

Задать настройки для корректной работы TM API вы сможете в программе Такси-Мастер в меню «Настройки» в одноименной ветке «TM API».

  1. Установите флажок «Template-checkbox-off.png Использовать TM API», чтобы приступить к его использованию.
  2. В поле «Локальный порт» введите номер порта подключения к интернету, на котором работает и будет ожидать запросы о новых заказах TMServer. Рекомендуется оставить номер порта по умолчанию.
  3. При необходимости установите флажок «Template-checkbox-off.png Использовать автопроброс порта с помощью UPnP», также укажите «Внешний порт» и «Локальный IP».

Ветка «Открытое API»

В данной ветке регулируется доступ к синхронизации Такси-Мастер со сторонним сервисом (сайтом), с помощью которого клиенты будут создавать заказы. С примером кода для работы вы можете ознакомиться в данной статье в разделе Общее описание протокола.

  1. Установите флажок «Template-checkbox-off.png Использовать открытое API» для того, чтобы запустить работу протокола TMCommonAPI.
  2. В поле «Секретный ключ» укажите произвольный номер. В дальнейшем этот номер следует использовать в API-запросах на сайте.
  3. В таблице "Пользователи CommonAPI" можно настроить доступ к CommonAPI. Для этого нужно создать пользователей, у которых будет отдельный секретный ключ, и отметить доступные запросы CommonAPI.

Ветка «API для телефонии»

В данной ветке регулируются настройки API для телефонии, т.е. взаимодействие Такси-Мастер с call-центром через программный интерфейс. С его помощью call-центр может дать команду Такси-Мастер создать заказ или запросить информацию о статусе текущего заказа.

  1. Установите флажок «Template-checkbox-off.png Использовать открытое API для телефонии» для того, чтобы запустить работу протокола TMTAPI.
  2. В поле «Секретный ключ» укажите номер секретного ключа для работы.

Ветка «TaxoPhone API»

Ветка «Платежные терминалы»

Интересная информация
Ранее для связи платежных систем и Такси-Мастер служила такая утилита, как TMWeb. В данный момент мы отказались от ее использования, а функции были распределены между двумя компонентами системы: TM API и TMServer.

Параметры этой ветки отвечают за работу модуля интеграции с платежными системами.

  1. Установите флажок «Template-checkbox-off.png Включить прием терминальных платежей». Данная функция позволит отображать все платежные операции по приходу средств от водителей через терминалы в базе данных программы.
  2. В поле «Секретный ключ» укажите номер секретного ключа для работы с платежными системами и сверки платежей, который будет выслан вам в письме от менеджера. Секретный ключ - это определенный набор символов, необходимый для формирования подписи при передаче информации о платеже.
  3. Кнопка «Задать всем водителям терминальный аккаунт по их ИД» служит для соединения TM API с сервером Такси-Мастер. В результате соединения записи о терминальных аккаунтах генерируются, заносятся (для тех водителей, у которых они отсутствуют) и обновляются (для тех водителей, у которых уже существуют терминальные аккаунты) в Такси-Мастер.

Общее описание протокола

Формат запроса

TMAPI принимает входящие запросы по протоколу HTTPS. В URI запроса после ip адреса и порта, который будет слушать TM API, должно идти название API (common_api) и версия API. Пример:

GET https://ip:port/common_api/1.0/get_crew_groups_list HTTP/1.1

Для получения данных из БД используются запросы типа GET. Для записи данных в базу данных используются запросы типа POST. В запросе типа GET параметры запроса передаются в URI. Пример:

GET https://ip:port/common_api/1.0/calc_order_cost?tariff_id=1&distance_city=10 
Signature: <...>

В запросе типа POST параметры передаются в теле запроса в формате application/x-www-form-urlencoded или application/json в зависимости от запроса. Пример:

POST https://ip:port/common_api/1.0/create_order HTTP/1.1
Signature: <...>
Content-Type: application/x-www-form-urlencoded
Content-Length: 118

phone=89123456789&source=SOURCE&source_time=20120501100000&dest=DEST&customer=CUSTOMER&
comment=COMMENT&crew_group_id=1

В любом запросе обязательно должен быть заголовок Signature. В нем передается MD5 хэш, рассчитанный для строки, которая получается сцеплением строки параметров запроса с секретным ключом. Секретный ключ задается в «Файл - Настройки - TM API - Открытое API». Пример:

Запрос:
GET https://ip:port/common_api/1.0/calc_order_cost?tariff_id=1&distance_city=10 HTTP/1.1

Секретный ключ:
1234567890

Signature = MD5("tariff_id=1&distance_city=10" + "1234567890") = d7b8fb11b5499b64d750b8efe53e2877

Также в запросе может содержаться заголовок "X-User-Id" c ИД пользователя CommonAPI, если запрос делается от какого-то конкретного пользователя CommonAPI. Если будет передан этот заголовок, то секретный ключ будет проверяться именно для указанного пользователя CommonAPI, а также будут проверяться права доступа пользователя CommonAPI к данному запросу. Если заголовок "X-User-Id" не будет передан, то тогда будет проверяться общий секретный ключ CommonAPI, и будет разрешен доступ ко всем запросам CommonAPI. Пример запроса с указанием ИД пользователя:

POST https://ip:port/common_api/1.0/create_order HTTP/1.1
Signature: <...>
X-User-Id: 123
Content-Type: application/x-www-form-urlencoded
Content-Length: 118

phone=89123456789&source=SOURCE&source_time=20120501100000&dest=DEST&customer=CUSTOMER&comment=COMMENT&crew_group_id=1


Формат ответа

TM API всегда возвращает HTTP код 200 ОК. Результат выполнения запроса содержится в теле ответа в формате JSON. Общий вид возвращаемого результата:

{
"code":<Числовой код результата>,
"descr":"<Строковое описание результата>",
"data":{<Дополнительная информация>}
}

Существуют общие для всех запросов коды результатов:

Код Описание
0 Успешное выполнение запроса
1 Неизвестная ошибка
2 Неизвестный тип API
3 API отключено в настройках модуля TM API в ТМ
4 Не совпадает секретный ключ
5 Неподдерживаемая версия API
6 Неизвестное название запроса
7 Неверный тип запроса GET/POST
8 Не хватает входного параметра (в доп. информации ответа будет название отсутствующего параметра)
9 Некорректный входной параметр (в доп. информации ответа будет название некорректного параметра)
10 Внутренняя ошибка обработки запроса
13 Не найден пользователь CommonAPI с ИД, указанным в заголовке X-User-Id
14 Запрос недоступен для пользователя CommonAPI с ИД, указанным в заголовке X-User-Id

Описание запросов

Запрос-пинг

Для данного запроса не проверяется версия API, секретный ключ и тип запроса GET/POST.

Метод: GET или POST

Название запроса: ping

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример:

Запрос:
GET https://ip:port/common_api/1.0/ping 
Ответ:
{
"code":0,
"descr":"OK",
"data":{}
}

Запрос списка групп экипажей

Метод: GET

Название запроса: get_crew_groups_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
crew_groups Массив Список групп экипажей
• id Целое ИД группы экипажей
• name Строка Название группы экипажей

Пример:

Запрос:

GET https://ip:port/common_api/1.0/get_crew_groups_list 
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "crew_groups":[
     {
       "id":1,
       "name":"CREW_GROUP1"
     },
     {
       "id":2,
       "name":"CREW_GROUP2"
     }
    ]
  }
}

Запрос списка групп клиентов

Метод: GET

Название запроса: get_client_groups_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
client_groups Массив Список групп клиентов
• id Целое ИД группы клиентов
• name Строка Название группы клиентов

Пример:

Запрос:
GET https://ip:port/common_api/1.0/get_client_groups_list 
Signature: <...>
Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{
    "client_groups":[
      {
        "id":1,
        "name":"CLIENT_GROUP1"
      },
      {
        "id":2,
        "name":"CLIENT_GROUP2"
      }
    ]
  }
}

Запрос списка служб ЕДС

Метод: GET

Название запроса: get_uds_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
uds Массив Список служб ЕДС
• id Целое ИД службы ЕДС
• name Строка Название службы ЕДС

Пример:

Запрос:

GET https://ip:port/common_api/1.0/get_uds_list 
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "uds":[
      {
        "id":1,
        "name":"UDS1"
      },
      {
        "id":2,
        "name":"UDS2"
      }
    ]
  }
}

Запрос списка тарифов

Метод: GET

Название запроса: get_tariffs_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
tariffs Массив Список тарифов
• id Целое ИД тарифа
• name Строка Название тарифа
• is_active true или false Активный тариф

Пример:

Запрос:

GET https://ip:port/common_api/1.0/get_tariffs_list 
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "tariffs":[
      {
        "id":1,
        "name":"TARIFF1"
        "is_active":true 
      },
      {
         "id":2,
         "name":"TARIFF2"
         "is_active":true
      }
    ]
  }
}

Запрос списка услуг

Запрос устарел. Рекомендуется использовать Запрос списка атрибутов

Метод: GET

Название запроса: get_services_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
services Массив Список услуг
• id Целое ИД услуги
• name Строка Название услуги
• sum Дробное Абсолютная сумма услуги, руб
• percent Дробное Процент услуги от стоимости заказа, %

Пример:

Запрос:

GET https://ip:port/common_api/1.0/get_services_list 
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "services":[
      {
        "id":1,
        "name":"SERVICE1",
        "sum":100,
        "percent":0
      },
      {
        "id":2,
        "name":"SERVICE2"
        "sum":0,
        "percent":10
      }
    ]
  }
}

Запрос списка атрибутов

Метод: GET

Название запроса: get_order_params_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
order_params Массив Список параметров заказа
• id Целое ИД параметра
• name Строка Название параметра
• sum Дробное Абсолютная сумма параметра, руб
• percent Дробное Процент параметра от стоимости заказа, %
• order_access_control true или falce Регулирует доступ к заказу

Пример:

Запрос:

GET https://ip:port/common_api/1.0/get_order_params_list 
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "order_params":[
      {
        "id":1,
        "name":"PARAM1",
        "sum":100,
        "percent":0,
        "order_access_control":true
      },
      {
        "id":2,
        "name":"PARAM2",
        "sum":0,
        "percent":10,
        "order_access_control":false
      }
    ]
  }
}

Запрос списка скидок

Метод: GET

Название запроса: get_discounts_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
discounts Массив Список скидок
• id Целое ИД скидки
• name Строка Название скидки
• sum Дробное Абсолютная сумма скидки, руб
• percent Дробное Процент скидки от стоимости заказа, %

Пример:

Запрос:

GET https://ip:port/common_api/1.0/get_discounts_list 
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "discounts":[
      {
        "id":1,
        "name":"DISCOUNT1",
        "sum":100,
        "percent":0
      },
      {
        "id":2,
        "name":"DISCOUNT2"
        "sum":0,
        "percent":10
      }
    ]
  }
}

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

Метод: POST

Название запроса: create_order

Параметры:

Параметр Тип Описание
Обязательные параметры
phone Строка, <= 30 символов Номер телефона
source Строка Адрес подачи
source_time ГГГГММДДччммсс Время подачи
Необязательные параметры
dest Строка Адрес назначения
customer Строка Заказчик
comment Строка Комментарий
crew_group_id Целое ИД группы экипажей
uds_id Целое ИД службы ЕДС
tariff_id Целое ИД тарифа
is_prior true или false Предварительный заказ
source_lon Дробное Долгота адреса подачи
source_lat Дробное Широта адреса подачи
dest_lon Дробное Долгота адреса назначения
dest_lat Дробное Широта адреса назначения

Специальные возвращаемые коды:

Код Описание
100 Заказ с такими параметрами уже создан
101 Тариф не найден
102 Группа экипажа не найдена
103 Служба ЕДС не найдена
110 Клиент заблокирован
111 Не найден клиент, который может использовать собственный счет для оплаты заказов
114 Недостаточно средств на безналичном счете клиента в ТМ
115 Отрицательный баланс на безналичном счете клиента в ТМ
116 Для клиента запрещена оплата заказа наличными. Клиент должен максимально использовать в заказе безналичную оплату (оплату с основного счета)

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
order_id Целое ИД созданного заказа

Пример:

Запрос:

POST https://ip:port/common_api/1.0/create_order 
Signature: <...>
Content-Type: application/x-www-form-urlencoded
Content-Length: 156

phone=89123456789&source=SOURCE&source_time=20120501100000&dest=DEST&customer=CUSTOMER&
comment=COMMENT&crew_group_id=1&uds_id=1&tariff_id=3&is_prior=false&source_lon=53.147836&source_lat
=56.896817&dest_lon=53.226775&dest_lat=56.845452

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "order_id":12345
  }
}

Создание нового заказа 2

Метод: POST

Название запроса: create_order2

Параметры в формате JSON:

Параметр Тип Описание
Обязательные параметры
phone Строка, <= 30 символов Номер телефонам (необязателен, если client_id присутствует).
client_id Целое ИД клиента (необязателен, если phone присутствует).
addresses Массив Массив адресов. Первый элемент — адрес подачи(обязательно), последний — адрес назначения, между ними — остановки.
• address Строка Адрес подачи
• lat Дробное Широта адреса
• lon Дробное Долгота адреса
• zone_id Целое ИД района
• parking_id Целое ИД стоянки
source_time ГГГГММДДччммсс Время подачи
Необязательные параметры
server_time_offset Целое Смещения относительно серверного времени
passenger Строка Пассажир
phone_to_dial Строка, <= 30 символов Телефон для отзвона
customer Строка Заказчик
comment Строка Комментарий
crew_group_id Целое ИД группы экипажей
uds_id Целое ИД службы ЕДС
tariff_id Целое ИД тарифа
is_prior true или false Предварительный заказ
check_duplicate true или false Проверка на дубликат
services Массив Массив услуг. Устарело. Рекомендуется использовать параметр attribute_values.
Целое ИД услуги
crew_props Массив Массив признаков экипажей. Устарело. Рекомендуется использовать параметр attribute_values.
Целое ИД признака экипажа
order_params Массив Массив параметров заказа. Устарело. Рекомендуется использовать параметр attribute_values.
Целое ИД параметра заказа
total_cost Дробное Сумма заказа
use_cashless true или false Оплата по возможности всей суммы заказа с безналичного счета клиента (насколько хватает средств на счете).
use_bonus true или false Оплата по возможности всей суммы заказа с бонусного счета клиента (насколько хватает средств на бонусном счете).
cashless_sum Дробное Фиксированная сумма оплаты заказа с безналичного счета клиента (не используется, если use_cashless = true).
bonus_sum Дробное Фиксированная сумма оплаты заказа с бонусного счета клиента (не используется, если use_bonus = true).
client_employee_id Целое ИД сотрудника клиента (если задан client_id)
email Строка Email для отправки уведомлений
prior_to_current_before_minutes Целое Время перехода из предварительного в текущие заказы, мин
flight_number Строка Номер рейса
need_custom_validate true или false Использовать специальную проверку перед созданием заказа
attribute_values Массив Массив значений атрибутов
• id Целое Идентификатор атрибута
• bool_value true или false Значение, если тип атрибута «Логический»
• num_value Дробное Значение, если тип атрибута:
  • «Число» (непосредственное значение)
  • «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
  • «Перечисляемый» (значение выбранного элемента перечисления)
  • «Дата» и «Дата/время» (Unix-время, всегда целое число)
• str_value Строка Значение, если тип атрибута «Строка»
payment_pay_system Строка Тип платежной системы ("qr", либо пусто, если не используется)

Специальные возвращаемые коды:

Код Описание
100 Заказ с такими параметрами уже создан
101 Тариф не найден
102 Группа экипажа не найдена
103 Служба ЕДС не найдена
104 Клиент не найден
105 Район не найден
106 Стоянка не найдена
107 Сотрудник клиента не найден
108 Параметр заказа не найден
109 Атрибут не может быть привязан к заказу
110 Клиент заблокирован
111 Не найден клиент, который может использовать собственный счет для оплаты заказов
112 Сотрудник клиента заблокирован
113 Ошибка специальной проверки заказа перед созданием. В ответе будет возвращаться:
 "data": {
   "message":"Текст ошибки для пользователя."
 }
114 Недостаточно средств на безналичном счете клиента в ТМ
115 Отрицательный баланс на безналичном счете клиента в ТМ
116 Для клиента запрещена оплата заказа наличными. Клиент должен максимально использовать в заказе безналичную оплату (оплату с основного счета)

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
order_id Целое ИД созданного заказа

Пример:

POST https://ip:port/common_api/1.0/create_order2 HTTP/1.1
Signature: <...>
Content-Type: application/json
Content-Length: <...>

{
  "server_time_offset":2,
  "source_time":"20140415172811",
  "is_prior":false,
  "check_duplicate":true,
  "phone":"123456",
  "phone_to_dial":"654321",
  "client_id":1,  
  "client_employee_id":4,  
  "customer":"CUSTOMER",
  "passenger":"PASSENGER",
  "comment":"COMMENT",
  "crew_group_id":1,
  "uds_id":1,
  "tariff_id":1,
  "addresses": [
      {
          "address": "SOURCE",
          "lat": 56.896817,
          "lon": 53.14783
          "zone_id": 1,
          "parking_id": 1
      },
      {
          "address": "STOP1",
          "lat": 56.845452,
          "lon": 53.226775
          "zone_id": 2,
          "parking_id": 2
      },
      {
          "address": "STOP2"
      },
      {
          "address": "DESTINATION",
          "lat": 56.86123,
          "lon": 53.24187
      }
  ]
  "services":[1,2],
  "crew_props":[1],
  "order_params":[3,4],
  "total_cost":370,
  "client_id":28,
  "use_cashless":false,
  "use_bonus":false,
  "cashless_sum":700,
  "bonus_sum":350,
  "email":"email@gmail.com",
  "prior_to_current_before_minutes":30,
  "flight_number":"130-qwe2",
  "need_custom_validate":false,
  "attribute_values": [
      {
            "id": 1,
            "bool_value": true
      },
      {
            "id": 2,
            "num_value": 1
      },
      {
            "id": 3,
            "num_value": 10
      },
      {
            "id": 4,
            "str_value": "строка"
      }
  ],
  "payment_pay_system": "qr"
}

Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{
    "order_id":1672
  }
}

Расчет суммы заказа

Метод: GET

Название запроса: calc_order_cost

Параметры:
Параметр Тип Описание
Обязательные параметры
tariff_id Целое ИД тарифа
Необязательные параметры
source_time ГГГГММДДччммсс Время подачи
is_prior true или false Предварительный заказ
client_id Целое ИД клиента
client_employee_id Целое ИД сотрудника клиента
discount_id Целое ИД скидки
disc_card_id Целое ИД дисконтной карты
source_zone_id Целое ИД района подачи
dest_zone_id Целое ИД района назначения
distance_city Дробное Километраж по городу
distance_country Дробное Километраж за городом
source_distance_country Дробное Километраж до подачи за городом
is_country true или false Загородный заказ
waiting_minutes Целое Время ожидания посадки клиента в минутах
is_hourly true или false Почасовой заказ
hourly_minutes Целое Длительность почасового заказа в минутах
is_prize true или false Призовой заказ
back_way true или false Обратный путь за городом
services Строка Список ИД услуг через точку с запятой, пример: «1;2;3»

Устарело. Рекомендуется использовать параметр order_params.

order_params Строка Список ИД параметров заказа через точку с запятой, пример: «1;2;3»
cashless true или false Признак безналичного заказа

Специальные возвращаемые коды:

Код Описание
100 Тариф не найден
101 Ошибка при расчете по тарифу
102 Скидка не найдена
103 Клиент не найден
104 Район подачи не найден
105 Район назначения не найден
106 Дисконтная карта не найдена
107 Район остановки не найден
108 Группа экипажа не найдена
109 Служба ЕДС не найдена
110 Дисконтная карта не действительна
111 Не найден сотрудник клиента

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
sum Дробное Рассчитанная общая сумма заказа
info Массив Дополнительная информация по расчету суммы заказа
• comment Строка Описание позиции дополнительной информации по расчету суммы заказа
• sum Строка Сумма позиции дополнительной информации по расчету суммы заказа

Пример:

Запрос: 

GET https://ip:port/common_api/1.0/calc_order_cost?tariff_id=1&source_time=20120501100000&is_prior=false&client_id=1&client_employee_id=11&discount_id=1&disc_card_id=1&
source_zone_id=1&dest_zone_id=2&distance_city=10&distance_country=20&source_distance_country=5&is_country=true&waiting_minutes=10&is_hourly=false&hourly_minutes=60&
is_prize=true&back_way=false&services=1;2;3&order_params=1;2;3 HTTP/1.1
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "sum":1000,
    "info":[
      {
         "comment":"SUM1",
         "sum":"100"
      },
      {
         "comment":"SUM2",
         "sum":"200"
      }
    ]
  }
} 

Расчет суммы заказа 2

Метод: POST

Название запроса: calc_order_cost2

Параметры в формате JSON:

Параметр Тип Описание
Необязательные параметры
order_id Целое ИД заказа
tariff_id Целое ИД тарифа
source_time ГГГГММДДччммсс Время подачи
is_prior true или false Предварительный заказ
client_id Целое ИД клиента
phone Строка Телефон клиента
discount_id Целое ИД скидки
disc_card_id Целое ИД дисконтной карты
source_zone_id Целое ИД района подачи
source_lon Дробное Долгота адреса подачи
source_lat Дробное Широта адреса подачи
dest_zone_id Целое ИД района назначения
dest_lon Дробное Долгота адреса назначения
dest_lat Дробное Широта адреса назначения
distance_city Дробное Километраж по городу
distance_country Дробное Километраж за городом
source_distance_country Дробное Километраж до подачи за городом
is_country true или false Загородный заказ
waiting_minutes Целое Время ожидания посадки клиента в минутах
is_hourly true или false Почасовой заказ
hourly_minutes Целое Длительность почасового заказа в минутах
is_prize true или false Призовой заказ
back_way true или false Обратный путь за городом
order_params Массив Массив параметров заказа. Устарело. Рекомендуется использовать параметр attribute_values.
Целое ИД параметра заказа
cashless true или false Признак безналичного заказа
stops Массив Список остановок
• zone_id Целое ИД района остановки
• lat Дробное Широта адреса остановки
• lon Дробное Долгота адреса остановки
crew_group_id Целое ИД группы экипажа
uds_id Целое ИД службы ЕДС
analyze_route true или false Нужно ли выполнять анализ адресов и маршрута. Если данный флаг установлен (analyze_route=true), то значения параметров: distance_city, distance_country, source_distance_country, переданные в данном запросе будут игнорироваться. Они автоматически будут рассчитаны в ходе выполнения запроса в результате анализа адресов и маршрута. Также перед анализом адресов будут автоматически найдены районы (по справочнику "Районы") для тех адресов, у которых район не указан явно (zone_id=0). Также по результатам анализа адресов автоматически будут определены флаги "Загородный заказ" (is_country) и "Межгород".
attribute_values Массив Массив значений атрибутов
• id Целое Идентификатор атрибута
• bool_value true или false Значение, если тип атрибута «Логический»
• num_value Дробное Значение, если тип атрибута:
  • «Число» (непосредственное значение)
  • «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
  • «Перечисляемый» (значение выбранного элемента перечисления)
  • «Дата» и «Дата/время» (Unix-время, всегда целое число)
• str_value Строка Значение, если тип атрибута «Строка»

Специальные возвращаемые коды:

Код Описание
100 Тариф не найден
101 Ошибка при расчете по тарифу
102 Скидка не найдена
103 Клиент не найден
104 Район подачи не найден
105 Район назначения не найден
106 Дисконтная карта не найдена
107 Район остановки не найден
108 Группа экипажа не найдена
109 Служба ЕДС не найдена
110 Дисконтная карта не действительна
111 Сотрудник клиента не найден
112 Атрибут не найден
113 Атрибут не может быть привязан к заказу
114 Заказ не найден

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
sum Дробное Рассчитанная общая сумма заказа
info Массив Дополнительная информация по расчету суммы заказа
• comment Строка Описание позиции дополнительной информации по расчету суммы заказа
• sum Строка Сумма позиции дополнительной информации по расчету суммы заказа

Пример:

Запрос: 

POST https://ip:port/common_api/1.0/calc_order_cost2 HTTP/1.1
Signature: <...>
Content-Type: application/json
Content-Length: <...>

{
  "tariff_id":1,
  "source_time":"20140415172811",
  "is_prior":false,
  "client_id":1,  
  "discount_id":1,
  "disc_card_id":1,
  "source_zone_id":1,,
  "source_lat":11.111111,
  "source_lon":22.222222,
  "dest_zone_id":2,,
  "dest_lat":33.333333,
  "dest_lon":44.444444,
  "distance_city":10,
  "distance_country":20,
  "source_distance_country":5,
  "is_country":true,
  "waiting_minutes":10,
  "is_hourly":false,
  "hourly_minutes":60,
  "is_prize":true,
  "back_way":false,
  "order_params":[3,4],
  "stops": [
      {
          "zone_id": 1,
          "lat": 11.111111,
          "lon": 22.222222
      },
      { 
          "zone_id": 2,
          "lat": 33.333333,
          "lon": 44.444444
      }
  ],
  "attribute_values": [
      {
            "id": 1,
            "bool_value": true
      },
      {
            "id": 2,
            "num_value": 1
      },
      {
            "id": 3,
            "num_value": 10
      },
      {
            "id": 4,
            "str_value": "строка"
      }
  ]
}

Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{
    "sum":1000,
    "info":[
      {
        "comment":"SUM1",
        "sum":"100"
      },
      {
        "comment":"SUM2",
        "sum":"200"
      }
    ]
  }
}

Изменение состояния заказа

Метод: POST

Название запроса: change_order_state

Параметры:

Параметр Тип Описание
Обязательные параметры
order_id Целое ИД заказа
new_state Целое Новое состояние заказа
Необязательные параметры
cancel_order_penalty_sum Дробное Сумма штрафа клиента за отмену заказа. Если свойство new_state имеет тип "Прекращен" (выполняется отмена заказа) и при отмене заказа должен быть назначен штраф клиенту, то если данное значение штрафа указано (даже если указано значение 0), то оно имеет приоритет. Если данное значение не указано, то сумма штрафа будет определена автоматически по группе клиентов.

Специальные возвращаемые коды:

Код Описание
100 Не найден заказ ИД=ORDER_ID
101 Не найдено состояние заказа ИД=NEW_STATE
102 Изменение состояния не соответствует необходимым условиям.

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
order_id Целое ИД заказа
new_state Целое Новое состояние заказа

Пример:

Запрос: 

POST https://ip:port/common_api/1.0/change_order_state?order_id=6&new_state=4 
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "order_id":6,
    "new_state":4
  }
} 

Запрос информации об экипаже

Метод: GET

Название запроса: get_crew_info

Параметры:

Параметр Тип Описание
Обязательные параметры
crew_id Целое ИД экипажа
Необязательные параметры
fields Строка Список возвращаемых полей через запятую

Специальные возвращаемые коды:

Код Описание
100 Экипаж не найден

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
crew_id Целое ИД экипажа
code Строка Позывной экипажа
name Строка Наименование экипажа
driver_id Целое ИД водителя
car_id Целое ИД автомобиля
crew_group_id Целое ИД группы экипажа
crew_state_id Целое ИД состояния экипажа
online true или false Водитель подключен к серверу «Связи с водителями»
work_shift_sum Дробное Сумма, списываемая за смену
min_balance Дробное Минимальный баланс, при котором можно выйти на смену
common_priority Целое Общий приоритет
static_priority Целое Статический приоритет
dynamic_priority Целое Динамический приоритет
rating_priority Целое Приоритет по рейтингу
order_change_id Целое Индивидуальная сдача с заказа
has_light_house true или false Шашка
has_label true или false Наклейка
use_plan_shifts true или false Запрет работы вне запланированных смен
fuel_level Дробное Уровень топлива в автомобиле
order_params Массив Массив параметров экипажа
Целое ИД параметра заказа
attribute_values Массив Массив значений атрибутов
• id Целое Идентификатор атрибута
• bool_value true или false Значение, если тип атрибута «Логический»
• num_value Дробное Значение, если тип атрибута:
  • «Число» (непосредственное значение)
  • «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
  • «Перечисляемый» (значение выбранного элемента перечисления)
  • «Дата» и «Дата/время» (Unix-время, всегда целое число)
• str_value Строка Значение, если тип атрибута «Строка»

Пример:

Запрос: 

GET https://ip:port/common_api/1.0/get_crew_info?crew_id=1 
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "crew_id":1,
    "code":"123",
    "name":"CREW_NAME",
    "driver_id":1,
    "car_id":1,
    "crew_group_id":1,
    "crew_state_id":3,
    "online":true
    "work_shift_sum":0,
    "min_balance":10,
    "common_priority":0,
    "static_priority":0,
    "dynamic_priority":0,
    "rating_priority":0,
    "order_change_id":218,
    "has_light_house":false,
    "has_label":false,
    "order_params":[
      1,
      2,
    ],
    "attribute_values": [
        {
              "id": 1,
              "bool_value": true
        },
        {
              "id": 2,
              "num_value": 1
        },
        {
              "id": 3,
              "num_value": 10
        },
        {
              "id": 4,
              "str_value": "строка"
        }
    ]
  }
}

Запрос информации об экипажах

Метод: GET

Название запроса: get_crews_info

Параметры:

Параметр Тип Описание
Необязательные параметры
not_working_crews true или false Нужно ли возвращать экипажи не на линии. По умолчанию возвращаются только экипажи на линии
fields Строка Список возвращаемых полей через запятую

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
crews_info Массив Массив экипажей
• crew_id Целое ИД экипажа
• code Строка Позывной экипажа
• name Строка Наименование экипажа
• driver_id Целое ИД водителя
• car_id Целое ИД автомобиля
• crew_group_id Целое ИД группы экипажа
• crew_state_id Целое ИД состояния экипажа
• online true или false Водитель подключен к серверу «Связи с водителями»
• work_shift_sum Дробное Сумма, списываемая за смену
• min_balance Дробное Минимальный баланс, при котором можно выйти на смену
• common_priority Целое Общий приоритет
• static_priority Целое Статический приоритет
• dynamic_priority Целое Динамический приоритет
• rating_priority Целое Приоритет по рейтингу
• order_change_id Целое Индивидуальная сдача с заказа
• has_light_house true или false Шашка
• has_label true или false Наклейка
• use_plan_shifts true или false Запрет работы вне запланированных смен
• fuel_level Дробное Уровень топлива в автомобиле
• order_params Массив Массив параметров заказа экипажа
• • Целое ИД параметра заказа
• attribute_values Массив Массив значений атрибутов
• • id Целое Идентификатор атрибута
• • bool_value true или false Значение, если тип атрибута «Логический»
• • num_value Дробное Значение, если тип атрибута:
  • «Число» (непосредственное значение)
  • «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
  • «Перечисляемый» (значение выбранного элемента перечисления)
  • «Дата» и «Дата/время» (Unix-время, всегда целое число)
• • str_value Строка Значение, если тип атрибута «Строка»

Пример:

Запрос:
GET https://ip:port/common_api/1.0/get_crews_info 
Signature: <...>

Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{
    "crews_info":[
      {
        "crew_id":1,
        "code":"123",
        "name":"CREW_NAME1",
        "driver_id":1,
        "car_id":1,
        "crew_group_id":1,
        "crew_state_id":3
        "online":true,
        "work_shift_sum":0,
        "min_balance":10,
        "common_priority":10,
        "static_priority":10,
        "dynamic_priority":0,
        "rating_priority":0,
        "order_change_id":0,
        "has_light_house":false,
        "has_label":false,
        "use_plan_shifts":false,
        "fuel_level":8.15,
        "order_params":[
          1,
          5,
        ]
      },
      {
        "crew_id":12,
        "code":"777",
        "name":"CREW_NAME2",
        "driver_id":12,
        "car_id":12,
        "crew_group_id":2
        "crew_state_id":1,
        "online":false,
        "work_shift_sum":0,
        "min_balance":10,
        "common_priority":15,
        "static_priority":15,
        "dynamic_priority":0,
        "rating_priority":0,
        "order_change_id":0,
        "has_light_house":false,
        "has_label":true,
        "use_plan_shifts":true,
        "fuel_level":null,
        "order_params":[]
      }
    ]
  }
}

Создание экипажа

Метод: POST

Название запроса: create_crew

Параметры в формате JSON:

Параметр Тип Описание
Обязательные параметры
car_id Целое ИД автомобиля
driver_id Целое ИД водителя
crew_group_id Целое ИД группы экипажа
Необязательные параметры
code Строка Позывной экипажа
work_shift_sum Дробное Сумма, списываемая за смену
min_balance Дробное Минимальный баланс, при котором можно выйти на смену
work_time Строка Время работы, формат: “6.00-10.30, 23:00-00:48”
has_light_house true или false Шашка
has_label true или false Наклейка
use_plan_shifts true или false Запрет работы вне запланированных смен
order_params Массив Массив параметров экипажа. Устарело. Рекомендуется использовать параметр attribute_values.
Целое ИД параметра
attribute_values Массив Массив значений атрибутов
• id Целое Идентификатор атрибута
• bool_value true или false Значение, если тип атрибута «Логический»
• num_value Дробное Значение, если тип атрибута:
  • «Число» (непосредственное значение)
  • «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
  • «Перечисляемый» (значение выбранного элемента перечисления)
  • «Дата» и «Дата/время» (Unix-время, всегда целое число)
• str_value Строка Значение, если тип атрибута «Строка»

Специальные возвращаемые коды:

Код Описание
100 Автомобиль с ИД=ID не найден
101 Водитель с ИД=ID не найден
102 Группа экипажа с ИД=ID не найдена
103 Параметр с ИД=ID не найден или не может быть привязан к экипажу
104 Экипаж с таким водителем и автомобилем уже существует
105 Служба ЕДС автомобиля и водителя не совпадает

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
crew_id Целое ИД созданного экипажа

Пример:

Запрос:
POST https://ip:port/common_api/1.0/create_crew HTTP/1.1
Signature: <...>
Content-Type: application/json
Content-Length: <...>

{
  "car_id":1,
  "driver_id":2,
  "crew_group_id":3,
  "code":"CODE",
  "use_shifts":true,
  "order_params":[3,4],
  "attribute_values": [
      {
            "id": 1,
            "bool_value": true
      },
      {
            "id": 2,
            "num_value": 1
      },
      {
            "id": 3,
            "num_value": 10
      },
      {
            "id": 4,
            "str_value": "строка"
      }
  ]
}

Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{
  "crew_id":1
 }
}

Обновление информации об экипаже

Метод: POST

Название запроса: update_crew_info

Параметры в формате JSON:

Параметр Тип Описание
Обязательные параметры
crew_id Целое ИД экипажа
Необязательные параметры
car_id Целое ИД автомобиля
driver_id Целое ИД водителя
crew_group_id Целое ИД группы экипажа
code Строка Позывной экипажа
work_shift_sum Дробное Сумма, списываемая за смену
min_balance Дробное Минимальный баланс, при котором можно выйти на смену
work_time Строка Время работы, формат: “6.00-10.30, 23:00-00:48”
has_light_house true или false Шашка
has_label true или false Наклейка
crew_gps_id Целое GPS идентификатор экипажа
use_plan_shifts true или false Запрет работы вне запланированных смен
order_params Массив Массив параметров экипажа
Целое ИД параметра
attribute_values Массив Массив значений атрибутов
• id Целое Идентификатор атрибута
• bool_value true или false Значение, если тип атрибута «Логический»
• num_value Дробное Значение, если тип атрибута:
  • «Число» (непосредственное значение)
  • «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
  • «Перечисляемый» (значение выбранного элемента перечисления)
  • «Дата» и «Дата/время» (Unix-время, всегда целое число)
• str_value Строка Значение, если тип атрибута «Строка»

Специальные возвращаемые коды:

Код Описание
100 Автомобиль с ИД=ID не найден
101 Водитель с ИД=ID не найден
102 Группа экипажа с ИД=ID не найдена
103 Параметр с ИД=ID не найден или не может быть привязан к экипажу
104 Экипаж с таким водителем и автомобилем уже существует
105 Служба ЕДС автомобиля и водителя не совпадает
106 Экипаж с ИД=ID не найден
107 Экипаж на линии, запрещено редактирование полей: водитель, автомобиль, позывной, группа экипажа, сумма за смену, минимальный баланс, запрет выхода вне запланированной смены.

Возвращаемые данные в случае успешного выполнения запроса: нет.

Пример:

Запрос:
POST https://ip:port/common_api/1.0/update_crew_info 
Signature: <...>
Content-Type: application/json
Content-Length: 104

{
  "crew_id":1,
  "car_id":1,
  "driver_id":3,
  "crew_group_id":3,
  "code":"CODE",
  "use_plan_shifts":true,
  "order_params":[3,4]
}

Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{}
}

Запрос информации о водителе

Метод: GET

Название запроса: get_driver_info

Параметры:

Параметры Тип Описание
Обязательные параметры
driver_id Целое ИД водителя
Необязательные параметры
need_photo true или false Нужна ли фотография водителя
fields Строка Список возвращаемых полей через запятую

Специальные возвращаемые коды:

Код Описание
100 Водитель не найден

Возвращаемые параметры в случае успешного выполнения запроса:

Параметр Тип Описание
driver_id Целое ИД водителя
name Строка ФИО водителя
balance Дробное Баланс основного счета водителя
birthday ДД.ММ.ГГГГ День рождения водителя
car_id Целое ИД основного автомобиля водителя
driver_license Строка Водительское удостоверение
license Строка Разрешение на перевозку
home_phone Строка Любой неосновной телефон водителя (устаревшее поле)
mobile_phone Строка Основной телефон водителя (устаревшее поле)
is_locked true или false Водитель заблокирован
is_dismissed true или false Водитель уволен
self_employed true или false Водитель самозанятый
inn Строка ИНН водителя
insurance_number Строка СНИЛС водителя
driver_photo Base64 Фото водителя (только если need_photo = true или поле driver_photo указано в списке фильтра полей fields)
order_params Массив Массив параметров водителя. Устарело. Рекомендуется использовать параметр attribute_values.
Целое ИД параметра
phones Массив Массив телефонов водителя
• phone Строка Номер телефона
• is_default true или false Признак основного телефона
• use_for_call true или false Использовать для отзвона
term_account Строка Терминальный аккаунт
name_for_taxophone Строка Имя для TaxoPhone
accounts Массив Массив балансов счетов
•account_kind Целое Тип счета
•balance Дробное Баланс счета
attribute_values Массив Массив значений атрибутов
• id Целое Идентификатор атрибута
• bool_value true или false Значение, если тип атрибута «Логический»
• num_value Дробное Значение, если тип атрибута:
  • «Число» (непосредственное значение)
  • «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
  • «Перечисляемый» (значение выбранного элемента перечисления)
  • «Дата» и «Дата/время» (Unix-время, всегда целое число)
• str_value Строка Значение, если тип атрибута «Строка»
kpi Дробное Показатель эффективности (KPI) водителя

Пример:

Запрос:

GET https://ip:port/common_api/1.0/get_driver_info?driver_id=1&need_photo=false HTTP/1.1
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "driver_id":1,
    "name":"DRIVER_NAME",
    "balance":100,
    "birthday":"01.01.1980",
    "car_id":1,
    "license":"1234567890",
    "home_phone":"79999999999",
    "mobile_phone":"79999999999",
    "is_locked":false,
    "is_dismissed":false,
    "order_params":[3,4],
    "phones":[
      {
        "phone":"79999999999",
        "is_default":true,
        “use_for_call”:true
      },
      {
        "phone":"79999999999",
        "is_default":false,
        “use_for_call”:false
      }
    ],
    "term_account":"00008",
    "name_for_taxophone":"NameForTaxoPhone",
    "accounts":
    [
      {
        "account_kind":0,
        "balance":1000993.00
      },
      {
        "account_kind":1000,
        "balance":600.00
      }
    ],
    "attribute_values": [
        {
              "id": 1,
              "bool_value": true
        },
        {
              "id": 2,
              "num_value": 1
        },
        {
              "id": 3,
              "num_value": 10
        },
        {
              "id": 4,
              "str_value": "строка"
        }
    ],
    "kpi":3.12
  }
}

Запрос списка водителей

Метод: GET

Название запроса: get_drivers_info

Параметры:

Параметр Тип Описание
Небязательные параметры
locked_drivers true или false Включить в ответ запроса заблокированных водителей (по умолчанию false)
dismissed_drivers true или false Включить в ответ запроса уволенных водителей (по умолчанию false)
fields Строка Список возвращаемых полей через запятую


Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
drivers_info Массив Массив не удаленных водителей
• driver_id Целое ИД водителя
• name Строка ФИО водителя
• balance Дробное Баланс водителя
• birthday ДД.ММ.ГГГГ День рождения водителя
• car_id Целое ИД основного автомобиля водителя
• driver_license Строка Водительское удостоверение
• license Строка Разрешение на перевозку
• home_phone Строка Любой неосновной телефон водителя (устаревшее поле)
• mobile_phone Строка Основной телефон водителя (устаревшее поле)
• is_locked true или false Водитель заблокирован
• is_dismissed true или false Водитель уволен
• self_employed true или false Водитель самозанятый
• inn Строка ИНН водителя
• insurance_number Строка СНИЛС водителя
• order_params Массив Массив параметров водителя. Устарело. Рекомендуется использовать параметр attribute_values
• • Целое ИД параметра
• phones Массив Массив телефонов водителя
• • phone Строка Номер телефона
• • is_default true или false Признак основного телефона
• • use_for_call true или false Использовать для отзвона
• term_account Строка Терминальный аккаунт
• attribute_values Массив Массив значений атрибутов
• • id Целое Идентификатор атрибута
• • bool_value true или false Значение, если тип атрибута «Логический»
• • num_value Дробное Значение, если тип атрибута:
  • «Число» (непосредственное значение)
  • «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
  • «Перечисляемый» (значение выбранного элемента перечисления)
  • «Дата» и «Дата/время» (Unix-время, всегда целое число)
• • str_value Строка Значение, если тип атрибута «Строка»
• kpi Дробное Показатель эффективности (KPI) водителя

Пример:


Запрос:

GET https://ip:port/common_api/1.0/get_drivers_info?locked_drivers=true&dismissed_drivers=true HTTP/1.1
Signature: <...>


Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "drivers_info":[
      {
        "driver_id":1,
        "name":"DRIVER_NAME1",
        "balance":100.00,
        "birthday":"01.01.1980",
        "car_id":1,
        "license":"1234567890",
        "home_phone":"79999999999",
        "mobile_phone":"79999999999",
        "is_locked":false,
        "is_dismissed":false,
        "order_params":[3,4],
        "phones":[
          {
            "phone":"79999999999",
            "is_default":true,
            “use_for_call”: true

          },
          {
            "phone":"79999999999",
            "is_default":false,
            “use_for_call”: true

          }
        ],
        "term_account":"00008",
        "attribute_values": [
            {
                  "id": 3,
                  "num_value": 10
            },
            {
                  "id": 4,
                  "str_value": "строка"
            }
        ],
        "kpi":3.12
      },
      {
        "driver_id":2,
        "name":"DRIVER_NAME2",
        "balance":-50.00,
        "birthday":"01.01.1980",
        "car_id":2,
        "license":"1234567899",
        "is_locked":true,
        "is_dismissed":true,
        "order_params":[5,6],
        "phones":[
          {
            "phone":"79999999999",
            "is_default":true,
            “use_for_call”: true
          },
          {
            "phone":"79999999999",
            "is_default":false,
            “use_for_call”: false
          }
        ],
        "term_account":"00009",
        "attribute_values": [
            {
                  "id": 3,
                  "num_value": 10
            },
            {
                  "id": 4,
                  "str_value": "строка"
            }
        ],
        "kpi":3.12
      }
    ]
  }
}

Создание водителя

Метод: POST

Название запроса: create_driver

Параметры в формате JSON:

Параметр Тип Описание
Обязательные параметры
name Строка ФИО водителя
car_id Целое ИД основного автомобиля
password Строка Пароль (обязательное поле, если используется сервер связи с водителями)
uds_id Целое ИД службы ЕДС (обязательное поле, если используется ЕДС, иначе можно не указывать)
Необязательные параметры
home_phone Строка Неосновной телефон водителя (устаревший параметр)
mobile_phone Строка Основной телефон водителя (устаревший параметр)
passport Строка Паспортные данные
driver_license Строка Водительское удостоверение
license Строка Разрешение на перевозку
employee_type Целое Тип работника (0 - работник компании, 1 - частник)
birthday ГГГГММДДччммсс День рождения
number Строка Табельный номер
start_date ГГГГММДДччммсс Дата приема на работу
lic_date ГГГГММДДччммсс Дата окончания договора
term_account Строка Терминальный аккаунт (если не указан, будет сгенерирован автоматически), должен состоять из 5 цифр
self_employed true или false Водитель самозанятый
inn Строка ИНН водителя
insurance_number Строка СНИЛС водителя
comment Строка Описание
order_params Массив Массив параметров водителя. Устарело. Рекомендуется использовать параметр attribute_values
Целое ИД параметра
driver_photo Base64 Фотография водителя
phones Массив Массив телефонов водителя
• phone Строка Номер телефона
• is_default true или false Признак основного телефона
• use_for_call true или false Использовать для отзвона
name_for_taxophone Строка Имя для TaxoPhone
attribute_values Массив Массив значений атрибутов
• id Целое Идентификатор атрибута
• bool_value true или false Значение, если тип атрибута «Логический»
• num_value Дробное Значение, если тип атрибута:
  • «Число» (непосредственное значение)
  • «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
  • «Перечисляемый» (значение выбранного элемента перечисления)
  • «Дата» и «Дата/время» (Unix-время, всегда целое число)
• str_value Строка Значение, если тип атрибута «Строка»

Специальные возвращаемые коды:

Код Описание
100 Автомобиль с ИД=ID не найден
101 Служба ЕДС с ИД=ID не найдена
102 Параметр с ИД=ID не найден или не может быть привязан к водителю
103 Терминальный аккаунт не уникален
104 Некорректный терминальный аккаунт
107 Основной телефон может быть только один
108 Водитель должен иметь основной телефон
109 Пароль водителя не соответствует политике паролей

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
driver_id Целое ИД созданного водителя

Пример:

Запрос:
POST https://ip:port/common_api/1.0/create_driver HTTP/1.1
Signature: <...>
Content-Type: application/json
Content-Length: <...>

{
  "name":"NAME",
  "car_id":140,
  "password":"PASSWORD",
  "birthday":"19930218000000",
  "comment":"COMMENT",
  "order_params":[3,4],
  "name_for_taxophone":"NameForTaxoPhone",
  "phones":[
    {
      "phone":"79999999999",
      "is_default":true,
      “use_for_call”: true
    },
    {
      "phone":"79999999999",
      "is_default":false,
      “use_for_call”: true
    }
  ],
  "attribute_values": [
      {
            "id": 1,
            "bool_value": true
      },
      {
            "id": 2,
            "num_value": 1
      },
      {
            "id": 3,
            "num_value": 10
      },
      {
            "id": 4,
            "str_value": "строка"
      }
  ]
}

Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{
    "driver_id":10
  }
}

Обновление информации о водителе

Метод: POST

Название запроса: update_driver_info

Параметры в формате JSON:

Параметр Тип Описание
Обязательные параметры
driver_id Целое ИД редактируемого водителя
Необязательные параметры
name Строка ФИО водителя
car_id Целое ИД основного автомобиля
password Строка Пароль
uds_id Целое ИД службы ЕДС (обязательное поле, если используется ЕДС, иначе можно не указывать)
home_phone Строка Неосновной телефон водителя (устаревший параметр)
mobile_phone Строка Основной телефон водителя (устаревший параметр)
passport Строка Паспортные данные
driver_license Строка Водительское удостоверение
license Строка Разрешение на перевозку
employee_type Целое Тип работника (0 - работник компании, 1 - частник)
birthday ГГГГММДДччммсс День рождения
number Строка Табельный номер
start_date ГГГГММДДччммсс Дата приема на работу
lic_date ГГГГММДДччммсс Дата окончания договора
term_account Строка Терминальный аккаунт
comment Строка Описание
time_block ГГГГММДДччммсс Временная блокировка до
is_locked true или false Заблокирован
lock_description Строка Причина блокировки
is_dismissed true или false Уволен
dismiss_description Строка Причина увольнения
self_employed true или false Водитель самозанятый
inn Строка ИНН водителя
insurance_number Строка СНИЛС водителя
order_params Массив Массив параметров водителя. Устарело. Рекомендуется использовать параметр attribute_values
Целое ИД параметра
driver_photo Base64 Фотография водителя
phones Массив Массив телефонов водителя
• phone Строка Номер телефона
• is_default true или false Признак основного телефона
• use_for_call true или false Использовать для отзвона
name_for_taxophone Строка Имя для TaxoPhone
attribute_values Массив Массив значений атрибутов
• id Целое Идентификатор атрибута
• bool_value true или false Значение, если тип атрибута «Логический»
• num_value Дробное Значение, если тип атрибута:
  • «Число» (непосредственное значение)
  • «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
  • «Перечисляемый» (значение выбранного элемента перечисления)
  • «Дата» и «Дата/время» (Unix-время, всегда целое число)
• str_value Строка Значение, если тип атрибута «Строка»

Специальные возвращаемые коды:

Код Описание
100 Автомобиль с ИД=ID не найден
101 Служба ЕДС с ИД=ID не найдена
102 Параметр с ИД=ID не найден или не может быть привязан к водителю
103 Терминальный аккаунт не уникален
104 Некорректный терминальный аккаунт
105 Водитель с ИД=ID не найден
106 Экипаж на линии, запрещено редактирование полей: основной автомобиль, тип работника, служба ЕДС
107 Основной телефон может быть только один
108 Водитель должен иметь основной телефон
109 Пароль водителя не соответствует политике паролей

Возвращаемые данные в случае успешного выполнения запроса: нет.

Пример:

Запрос:
POST https://ip:port/common_api/1.0/update_driver_info HTTP/1.1
Signature: <...>
Content-Type: application/json
Content-Length: <...>

{
  "driver_id":10
  "name":"NAME",
  "car_id":140,
  "password":"PASSWORD",
  "birthday":"19930218000000",
  "comment":"COMMENT",
  "order_params":[3,4],
  "name_for_taxophone":"NameForTaxoPhone",
  "phones":[
    {
      "phone":"79999999999",
      "is_default":true,
      “use_for_call”: true
    },
    {
      "phone":"79999999999",
      "is_default":false,
      “use_for_call”: false
    }
  ],
  "attribute_values": [
      {
            "id": 1,
            "bool_value": true
      },
      {
            "id": 2,
            "num_value": 1
      },
      {
            "id": 3,
            "num_value": 10
      },
      {
            "id": 4,
            "str_value": "строка"
      }
  ]
}

Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{}
}

Запрос информации об автомобиле

Метод: GET

Название запроса: get_car_info

Параметры:

Параметры Тип Описание
Обязательные параметры
car_id Целое ИД автомобиля
Необязательные параметры
need_photo true или false Нужна ли фотография автомобиля
fields Строка Список возвращаемых полей через запятую

Специальные возвращаемые коды:

Код Описание
100 Автомобиль не найден

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
car_id Целое ИД автомобиля
code Строка Позывной автомобиля
name Строка Наименование автомобиля
gos_number Строка Государственный номер автомобиля
color Строка Цвет автомобиля
mark Строка Марка автомобиля
model Строка Модель автомобиля
short_name Строка Краткое название автомобиля
production_year Целое Год выпуска автомобиля
is_locked true или false Автомобиль заблокирован
fuel_level Дробное Уровень топлива в автомобиле
order_params Массив Массив параметров автомобиля. Устарело. Рекомендуется использовать параметр attribute_values.
Целое ИД параметра
car_photo Base64 Фото автомобиля (только если need_photo = true или поле driver_photo указано в списке фильтра полей fields)
attribute_values Массив Массив значений атрибутов
• id Целое Идентификатор атрибута
• bool_value true или false Значение, если тип атрибута «Логический»
• num_value Дробное Значение, если тип атрибута:
  • «Число» (непосредственное значение)
  • «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
  • «Перечисляемый» (значение выбранного элемента перечисления)
  • «Дата» и «Дата/время» (Unix-время, всегда целое число)
• str_value Строка Значение, если тип атрибута «Строка»

Пример:

Запрос:

GET https://ip:port/common_api/1.0/get_car_info?car_id=1&need_photo=false 
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "car_id":1,
    "code":"123",
    "name":"CAR_NAME",
    "gos_number":"a123bc",
    "color":"COLOR",
    "mark":"MARK",
    "model":"MODEL",
    "short_name":"SHORT_NAME",
    "production_year":2000,
    "is_locked":false,
    "order_params":[1,2],
    "attribute_values": [
        {
              "id": 1,
              "bool_value": true
        },
        {
              "id": 2,
              "num_value": 1
        },
        {
              "id": 3,
              "num_value": 10
        },
        {
              "id": 4,
              "str_value": "строка"
        }
    ]
  }
}

Запрос списка автомобилей

Метод: GET

Название запроса: get_cars_info

Параметры:

Параметры Тип Описание
Необязательные параметры
locked_cars true или false Включить в ответ заблокированных автомобилей (по умолчанию false)
fields Строка Список возвращаемых полей через запятую


Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

Параметры Тип Описание
crews_info Массив Массив автомобилей
• car_id Целое ИД автомобиля
• code Строка Позывной автомобиля
• name Строка Наименование автомобиля
• gos_number Строка Гос. номер автомобиля
• color Строка Цвет автомобиля
• mark Строка Марка автомобиля
• model Строка Модель автомобиля
• short_name Строка Краткое название автомобиля
• production_year Целое Год выпуска автомобиля
• is_locked true или false Автомобиль заблокирован
• fuel_level Дробное Уровень топлива в автомобиле
• order_params Массив Массив параметров автомобиля. Устарело. Рекомендуется использовать параметр attribute_values.
• • Целое ИД параметра
• attribute_values Массив Массив значений атрибутов
• • id Целое Идентификатор атрибута
• • bool_value true или false Значение, если тип атрибута «Логический»
• • num_value Дробное Значение, если тип атрибута:
  • «Число» (непосредственное значение)
  • «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
  • «Перечисляемый» (значение выбранного элемента перечисления)
  • «Дата» и «Дата/время» (Unix-время, всегда целое число)
• • str_value Строка Значение, если тип атрибута «Строка»

Пример:

Запрос:

GET https://ip:port/common_api/1.0/get_cars_info 
Signature: <...>
locked_cars=true


Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "crews_info":[
      {
        "car_id":1,
        "code":"111",
        "name":"CAR_1",
        "gos_number":"111111",
        "color":"COLOR_1",
        "mark":"MARK_1",
        "model":"MODEL_1",
        "short_name":"SHORT_NAME_1",
        "production_year":2000,
        "is_locked":false,
        "order_params":[1,2],
        "attribute_values": [
            {
                  "id": 1,
                  "bool_value": true
            },
            {
                  "id": 2,
                  "num_value": 1
            }
        ]
      },
      {
        "car_id":2,
        "code":"222",
        "name":"CAR_2",
        "gos_number":"222222",
        "color":"COLOR_2",
        "mark":"MARK_2",
        "model":"MODEL_2",
        "short_name":"SHORT_NAME_2",
        "production_year":2000,
        "is_locked":false,
        "order_params":[3,4],
        "attribute_values": [
            {
                  "id": 3,
                  "num_value": 10
            },
            {
                  "id": 4,
                  "str_value": "строка"
            }
        ]
      }
    ]
  }
}

Создание автомобиля

Метод: POST

Название запроса: create_car

Параметры в формате JSON:

Параметры Тип Описание
Обязательные параметры
code Строка Позывной
mark Строка Марка
color Строка Цвет
gos_number Строка Государственный номер
uds_id Целое ИД службы ЕДС (обязательное поле, если используется ЕДС, иначе можно не указывать)
Необязательные параметры
model Строка Модель
short_name Строка Краткое название
production_year Целое Год выпуска
car_class Строка Класс автомобиля (A, B, C, ...)
vin Строка VIN
body_number Строка Номер кузова
engine_number Строка Номер двигателя
permit Строка Разрешение на перевозку
comment Строка Описание
order_params Массив Массив параметров автомобиля. Устарело. Рекомендуется использовать параметр attribute_values.
Целое ИД параметра
car_photo Base64 Фотография автомобиля
attribute_values Массив Массив значений атрибутов
• id Целое Идентификатор атрибута
• bool_value true или false Значение, если тип атрибута «Логический»
• num_value Дробное Значение, если тип атрибута:
  • «Число» (непосредственное значение)
  • «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
  • «Перечисляемый» (значение выбранного элемента перечисления)
  • «Дата» и «Дата/время» (Unix-время, всегда целое число)
• str_value Строка Значение, если тип атрибута «Строка»

Специальные возвращаемые коды:

Код Описание
100 Автомобиль с ИД=ID имеет такой же позывной=CODE
101 Служба ЕДС не найдена
0 Параметр с ИД=ID не найден или не может быть привязан к автомобилю

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
car_id Целое ИД созданного автомобиля

Пример:

Запрос:
POST https://ip:port/common_api/1.0/create_car HTTP/1.1
Signature: <...>
Content-Type: application/json
Content-Length: <...>

{
  "code":"CODE",
  "mark":"MARK",
  "model":"MODEL",
  "color":"BLACK",
  "gos_number":"NUMBER",
  "production_year":2000,
  "comment":"COMMENT",
  "order_params":[1,2,3,4],
  "attribute_values": [
      {
            "id": 1,
            "bool_value": true
      },
      {
            "id": 2,
            "num_value": 1
      },
      {
            "id": 3,
            "num_value": 10
      },
      {
            "id": 4,
            "str_value": "строка"
      }
  ]
}

Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{
  "car_id":140
 }
}

Обновить информацию об автомобиле

Метод: POST

Название запроса: update_car_info

Параметры в формате JSON:

Параметры Тип Описание
Обязательные параметры
car_id Целое ИД автомобиля
Необязательные параметры
code Строка Позывной
mark Строка Марка
color Строка Цвет
gos_number Строка Государственный номер
model Строка Модель
short_name Строка Краткое название
production_year Целое Год выпуска
car_class Строка Класс автомобиля (A, B, C, ...)
vin Строка VIN
body_number Строка Номер кузова
engine_number Строка Номер двигателя
permit Строка Разрешение на перевозку
comment Строка Описание
order_params Массив Массив параметров автомобиля
Целое ИД параметра
attribute_values Массив Массив значений атрибутов
• id Целое Идентификатор атрибута
• bool_value true или false Значение, если тип атрибута «Логический»
• num_value Дробное Значение, если тип атрибута:
  • «Число» (непосредственное значение)
  • «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
  • «Перечисляемый» (значение выбранного элемента перечисления)
  • «Дата» и «Дата/время» (Unix-время, всегда целое число)
• str_value Строка Значение, если тип атрибута «Строка»
is_locked true или false Автомобиль заблокирован
lock_description Строка Причина блокировки
uds_id Целое ИД службы ЕДС
car_photo Base64 Фотография автомобиля

Специальные возвращаемые коды:

Код Описание
101 Служба ЕДС не найдена
102 Автомобиль с ИД=ID не найден
103 Экипаж на линии, запрещено редактирование полей: марка, модель, краткое наименование, цвет, гос. номер, служба ЕДС.
104 Параметр с ИД=ID не найден или не может быть привязан к автомобилю

Возвращаемые данные в случае успешного выполнения запроса: нет.

Пример:

Запрос:
POST https://ip:port/common_api/1.0/update_car_info HTTP/1.1
Signature: <...>
Content-Type: application/json
Content-Length: <...>

{
  "car_id":1,
  "code":"CODE",
  "mark":"MARK",
  "model":"MODEL",
  "color":"BLACK",
  "gos_number":"NUMBER",
  "production_year":2000,
  "comment":"COMMENT",
  "order_params":[3,4]
}

Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{}
}

Запрос координат экипажей

Метод: GET

Название запроса: get_crews_coords

Параметры:

Параметры Тип Описание
Необязательные параметры
crew_id Целое ИД экипажа, по которому нужно вернуть координаты. Если не задано, то будут возвращены координаты всех экипажей на линии.

Специальные возвращаемые коды:

Код Описание
100 Координаты не найдены

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
crews_coords Массив Список координат экипажей
• crew_id Целое ИД экипажа
• crew_code Строка Позывной экипажа
• coords_time ГГГГММДДччммсс Время получения координат
• lat Дробное Долгота
• lon Дробное Широта
• speed Целое Скорость движения, км/ч
• direction Целое Направление движения (0-Север, 90-Восток, 180-Юг, 270-Запад, -1-не задано)
• state_kind Строка Тип состояния экипажа. Может принимать значения:

• "not_available" — экипаж не на линии

• "waiting" — экипаж свободен, ожидает заказы

• "on_order" — экипаж на заказе

• "on_break" — экипаж на перерыве

Пример:


Запрос:
GET https://ip:port/common_api/1.0/get_crews_coords 
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "crews_coords":[
      {
        "crew_id":1,
        "crew_code":"111",
        "coords_time":"20120101101010",
        "lat":11.111111,
        "lon":22.222222,
        "state_kind":"waiting"
     },
     {
        "crew_id":2,
        "crew_code":"222",
        "coords_time":"20120101101010",
        "lat":33.333333,
        "lon":44.444444,
        "state_kind":"on_order"
      }
    ]
  }
}

Запрос:

GET https://ip:port/common_api/1.0/get_crews_coords?crew_id=1 
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "crews_coords":[
      {
        "crew_id":1,
        "crew_code":"111",
        "coords_time":"20120101101010",
        "lat":11.111111,
        "lon":22.222222,
        "state_kind":"waiting"
      }
    ]
  }
}

Запрос адресов, содержащих нужную строку

Метод: GET

Название запроса: get_addresses_like

Параметры:

Параметры Тип Описание
Обязательные параметры
get_streets true или false Искать улицы
get_points true или false Искать пункты
get_houses true или false Искать дома. Не может быть равно true, если get_streets = true или get_points = true.
street Строка Часть названия улицы или пункта, если идет поиск улиц или пунктов, или полное название улицы, если идет поиск домов
Необязательные параметры
house Строка Часть номера дома. Нужно только если get_houses = true.
city Строка Город, в котором искать адреса
max_addresses_count Целое Максимальное количество адресов в ответе
search_in_tm true или false Искать адреса в ТМ (по умолчанию = true)
search_in_yandex true или false Искать адреса в Яндекс (по умолчанию = false)
search_in_google true или false Искать адреса в Google (по умолчанию = false)
search_in_2gis true или false Искать адреса в 2GIS (по умолчанию = false)
search_in_tmgeoservice true или false Искать адреса в TMGeoService (по умолчанию = false)
search_in_mapmd true или false Искать адреса в Map.md (по умолчанию = false)

Специальные возвращаемые коды:

Код Описание
100 Подходящие адреса не найдены
101 Не указано место для поиска адресов

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
addresses Массив Список подходящих адресов
•address_source Строка Источник адреса. Может принимать значения:

•"tm" — Такси Мастер (адрес из базы данных или из карты)

•"yandex" — Яндекс

•"google" — Google

•"2gis" — 2GIS

•"tmgeoservice" — TMGeoService

•"mapmd" - Map.md

• street Строка Название улицы или пункта
• house Строка Номер дома
• kind Строка Тип адреса. Может принимать значения:

• "street" — улица

• "house" — дом

• "point" — пункт

• comment Строка Комментарий
• coords Массив Координаты дома или пункта
• • lat Дробное Широта
• • lon Дробное Долгота

Пример:


Запрос:

GET https://ip:port/common_api/1.0/get_addresses_like?get_streets=true&get_points=true&
get_houses=false&street=STREE 
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "addresses":[
      {
        "street":"STREET1",
        "house":"",
        "kind":"street",
        "comment":""
        "coords":{
        "lat":0,
        "lon":0
        }
      },
      {
        "street":"STREET2",
        "house":"",
        "kind":"street",
        "comment":""
        "coords":{
        "lat":0,
        "lon":0
        }
      },
      {
        "street":"POINT_STREET1",
        "house":"",
        "kind":"point",
        "comment":"Point at street STREET1"
        "coords":{
        "lat":53.224656,
        "lon":56.842521
        }
      }
    ]
  }
}

Запрос:

GET https://ip:port/common_api/1.0/get_addresses_like?get_streets=false&get_points=false&
get_houses=true&street=STREET1&house=1&max_addresses_count=10 
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "addresses":[
      {
        "street":"STREET1",
        "house":"1",
        "kind":"house",
        "comment":""
      },
      {
        "street":"STREET1",
        "house":"10",
        "kind":"house",
        "comment":""
      },
      {
        "street":"STREET1",
        "house":"11",
        "kind":"house",
        "comment":""
      }
    ]
  }
}

Запрос адресов, содержащих нужную строку 2

Метод: GET

Название запроса: get_addresses_like2

Параметры:

Параметры Тип Описание
Обязательные параметры
get_streets true или false Искать улицы
get_points true или false Искать пункты
get_houses true или false Искать дома
address Строка Строка для поиска адреса
Необязательные параметры
city Строка Города, разделенные запятой, в которых искать адреса
max_addresses_count Целое Максимальное количество адресов в ответе
search_in_tm true или false Искать адреса в ТМ (по умолчанию = true)
search_in_yandex true или false Искать адреса в Яндекс (по умолчанию = false)
search_in_google true или false Искать адреса в Google (по умолчанию = false)
search_in_2gis true или false Искать адреса в 2GIS (по умолчанию = false)
search_in_tmgeoservice true или false Искать адреса в TMGeoService (по умолчанию = false)
search_in_mapmd true или false Искать адреса в Map.md (по умолчанию = false)

Специальные возвращаемые коды:

Код Описание
100 Подходящие адреса не найдены
101 Не указано место для поиска адресов

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
addresses Массив Список подходящих адресов
• address_source Строка Источник адреса. Может принимать значения:

•"tm" — Такси Мастер (адрес из базы данных или из карты)

•"yandex" — Яндекс

•"google" — Google

•"2gis" — 2GIS

•"tmgeoservice" — TMGeoService

•"mapmd" - Map.md

• city Строка Название города
• point Строка Название пункта
• street Строка Название улицы
• house Строка Номер дома
• kind Строка Тип адреса. Может принимать значения:

• "street" — улица

• "house" — дом

• "point" — пункт

• comment Строка Комментарий
• coords Массив Координаты дома или пункта
• • lat Дробное Широта
• • lon Дробное Долгота

Пример:


Запрос:

GET https://ip:port/common_api/1.0/get_addresses_like2?get_streets=true&get_points=true& get_houses=true&address=STR12 
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "addresses":[
      {
        "address_source":"tm",
        "kind":"street",
        "city":"CITY ",
        "point":"",
        "street":"STREET",
        "house":"12",
        "comment":"",
        "coords":{
             "lat":11.11111,
             "lon":22.222222 
        }
      },
      {
         "address_source":"tm",
         "kind":"street",
         "city":"CITY ",
         "point":"",
         "street":"STREET",
         "house":"120",
         "comment":"",
         "coords":{
             "lat":11.11111,
             "lon":22.222222 
        }
      }
    ]
  }
}


Поиск ближайшего адреса

Метод: GET

Название запроса: find_nearest_address

Версия ТМ: 3.12

Параметры:

Параметры Тип Описание
Обязательные параметры
lat Дробное Широта
lon Дробное Долгота
Необязательные параметры
radius Целое Радиус в метрах
search_in_tm true или false Искать адреса в ТМ (по умолчанию = true)
search_in_google true или false Искать адреса в Google (по умолчанию = false)
search_in_tmgeoservice true или false Искать адреса в TMGeoService (по умолчанию = false)
search_in_mapmd true или false Искать адреса в Map.md (по умолчанию = false)
search_in_2gis true или false Искать адреса в 2ГИС (по умолчанию = false)

Специальные возвращаемые коды:

Код Описание
100 Подходящие адреса не найдены
101 Не указано место для поиска адресов

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
address_source Строка Источник адреса. Может принимать значения:
  • "tm" — Такси Мастер (адрес из базы данных или из карты)
  • "google" — Google
  • "tmgeoservice" — TMGeoService
  • "2gis" — 2ГИС
  • "mapmd" — Map.md
city Строка Название города
point Строка Название пункта
street Строка Название улицы
house Строка Номер дома
kind Строка

Тип адреса. Может принимать значения:

  • "street" — улица
  • "house" — дом
  • "point" — пункт
comment Строка Комментарий
coords Массив Координаты дома или пункта
• lat Дробное Широта
• lon Дробное Долгота

Пример:


Запрос:

GET https://ip:port/common_api/1.0/find_nearest_address?lat=56.850926&lon=53.212706&radius=100&search_in_tm=false&search_in_google=false&search_in_tmgeoservice=true HTTP/1.1
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":
  {
    "address_source":"tmgeoservice",
    "kind":"house",
    "city":"Ижевск",
    "point":"",
    "street":"Пушкинская ул.",
    "house":"206",
    "comment":"",
    "coords":
    {
      "lat":56.850951,
      "lon":53.212822
    }
  }
}

Анализ маршрута

Метод: GET

Название запроса: analyze_route

Параметры:

Параметры Тип Описание
Обязательные параметры
source Строка Адрес подачи
dest Строка Адрес назначения
Необязательные параметры
source_lon Дробное Долгота адреса подачи
source_lat Дробное Широта адреса подачи
dest_lon Дробное Долгота адреса назначения
dest_lat Дробное Широта адреса назначения


Параметр source не является обязательным к заполнению, если заданы source_lon и source_lat.

Параметр dest не является обязательным к заполнению, если заданы dest_lon и dest_lat.


Специальные возвращаемые коды:

Код Описание
100 Адрес подачи не распознан
101 Адрес назначения не распознан
102 Маршрут не распознан

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
source_lat Дробное Широта адреса подачи
source_lon Дробное Долгота адреса подачи
source_zone_id Целое ИД района подачи
dest_lat Дробное Широта адреса назначения
dest_lon Дробное Долгота адреса назначения
dest_zone_id Целое ИД района назначения
city_dist Дробное Километраж по городу
country_dist Дробное Километраж за городом
source_country_dist Дробное Километраж до адреса подачи, если адрес подачи за городом

Пример:

Запрос:

GET https://ip:port/common_api/1.0/analyze_route?source=STREET1,1&dest=STREET2,2&source_lon=
53.153044&source_lat=56.893301&dest_lon=53.218103&dest_lat=56.869759 
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "source_lat":11.111111,
    "source_lon":22.222222,
    "source_zone_id":1,
    "dest_lat":33.333333,
    "dest_lon":44.444444,
    "dest_zone_id":2,
    "city_dist":1.1,
    "country_dist":2.2,
    "source_country_dist":3.3
  }
}

Анализ маршрута 2

Метод: POST

Название запроса: analyze_route2

Параметры в формате JSON:

Параметр Тип Описание
Обязательные параметры
addresses Массив Массив адресов. Первый элемент — адрес подачи, последний — адрес назначения, между ними — остановки.
• address Строка Адрес подачи
• lat Дробное Широта адреса
• lon Дробное Долгота адреса
Необязательные параметры
get_full_route_coords true или false Возвращать координаты точек полного маршрута (по умолчанию false)
crew_group_id Целое ИД группы экипажей

Специальные возвращаемые коды:

Код Описание
100 Маршрут не распознан

Возвращаемые данные в случае успешного выполнения запроса:

Параметры Тип Описание
Addresses Массив Массив адресов. Первый элемент — адрес подачи, последний — адрес назначения, между ними — остановки.
• lat Дробное Широта адреса
• lon Дробное Долгота адреса
• zone_id Целое Район адреса
• parking_id Целое Стоянка адреса
city_dist Дробное Километраж по городу
country_dist Дробное Километраж за городом
source_country_dist Дробное Километраж до адреса подачи, если адрес подачи за городом.
full_route_coords Массив Массив координат точек маршрута.
• lat Дробное Широта точки
• lon Дробное Долгота точки

Пример:


Запрос:

POST /common_api/1.0/analyze_route2 
Host: ip:port
Keep-Alive: 300
Connection: keep-alive
Content-Type: application/json
Content-Length: 243
Signature: <...>

{"get_full_route_coords":true,"addresses":[{"address":"STREET1, 1","lat":11.111111,
"lon":22.222222},{"address":"STREET2, 2","lat":33.333333,"lon":44.444444},
{"address":"STREET3, 3","lat":55.555555,"lon":55.555555},{"address":"STREET4,
4","lat":77.777777,"lon":88.888888}]}



Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{
     "addresses":[
       {
        "lat":11.111111,
        "lon":22.222222,
        "zone_id":1,
        "parking_id":1
       },
       {
        "lat":33.333333,
        "lon":44.444444,
        "zone_id":2,
        "parking_id":2
       }
     ],
     "city_dist":0,
     "country_dist":2.647,
     "source_country_dist":3.412,
     "full_route_coords":[
       {
        "lat":55.833603,
        "lon":37.515537
       },
       {
        "lat":55.832855,
        "lon":37.516315
       },
       {
        "lat":55.833405,
        "lon":37.51799
       },
       ...
    ]
  }
}

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

Метод: GET

Название запроса: get_order_state

Параметры:

Параметры Тип Описание
Обязательные параметры
order_id Целое ИД заказа
Необязательные параметры
fields Строка Список возвращаемых полей через запятую

Специальные возвращаемые коды:

Код Описание
100 Заказ не найден

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
order_id Целое ИД заказа
state_id Целое ИД состояния заказа
state_kind Строка Тип состояния заказа. Может принимать значения:

• "new_order" — новый заказ

• "driver_assigned" — водитель назначен

• "car_at_place" — машина подъехала на место

• "client_inside" — клиент в машине

• "finished" — заказ успешно завершен

• "aborted" — заказ прекращен

crew_id Целое ИД экипажа
prior_crew_id Целое ИД предварительного экипажа
driver_id Целое ИД водителя
car_id Целое ИД автомобиля
server_time_offset Целое Смещение относительно серверного времени
start_time ГГГГММДДччммсс Время создания заказа
source_time ГГГГММДДччммсс Время подачи
finish_time ГГГГММДДччммсс Время завершения заказа
source Строка Адрес подачи
source_lat Строка Широта адреса подачи
source_lon Строка Долгота адреса подачи
destination Строка Адрес назначения
destination_lat Строка Широта адреса назначения
destination_lon Строка Долгота адреса назначения
stops Массив Информация по остановкам заказа
• address Строка Адрес остановки
• lat Дробное Широта адреса остановки
• lon Дробное Долгота адреса остановки
trip_distance Дробное Фактический километраж
trip_time Целое Фактическое время в пути
customer Строка Заказчик
passenger Строка Пассажир
phone Строка Номер телефона
phone_to_dial Строка Номер телефона для отзвона
client_id Целое ИД клиента
client_name Строка Имя клиента
client_group_id Целое ИД группы клиента
client_group_name Строка Название группы клиента
client_employee_id Целое ИД сотрудника клиента
order_crew_group_id Целое ИД группы экипажей, которая указана в заказе
tariff_id Целое ИД тарифа
car_mark Строка Марка автомобиля
car_model Строка Модель автомобиля
car_color Строка Цвет автомобиля
car_number Строка Государственный номер автомобиля
confirmed Строка Состояние подтвержденности заказа водителем или оператором.

Может принимать значения:

• "not_confirmed" — не подтверждено

• "confirmed_by_driver" — заказ принят водителем

• "confirmed_by_oper" — заказ подтвержден оператором

crew_coords Массив Координаты экипажа
• lat Дробное Широта
• lon Дробное Долгота
order_params Массив Массив параметров заказа экипажа. Устарело. Рекомендуется использовать параметр attribute_values
Целое ИД параметра заказа
creation_way Строка Способ создания заказа. Может принимать значения:

• "operator" — заказ создан оператором

• "sms" — заказ создан через смс

• "market" — заказ из биржи

• "common_api" — заказ создан через api

• "t_api" — заказ создан через api

• "taxophone" — заказ создан через таксофон с телефона

• "driver" — заказ создан водителем

• "daily_order" — ежедневный заказ

• "taxophone_web" — заказ создан через таксофон с сайта

• "unknown" — неизвестный

is_prior true или false Предварительный заказ
is_really_prior true или false Предварительный заказ на вкладке "Предварительные"
email Строка Email для уведомлений
prior_to_current_before_minutes Целое Время перехода из предварительного в текущие заказы, мин
flight_number Строка Номер рейса
sum Дробное Сумма без скидки
total_sum Дробное Итоговая сумма заказа
cash_sum Дробное Сумма наличными
cashless_sum Дробное Сумма безналичными
bonus_sum Дробное Сумма бонусами
bank_card_sum Дробное Сумма банковской картой
attribute_values Массив Массив значений атрибутов
• id Целое Идентификатор атрибута
• bool_value true или false Значение, если тип атрибута «Логический»
• num_value Дробное Значение, если тип атрибута:
  • «Число» (непосредственное значение)
  • «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
  • «Перечисляемый» (значение выбранного элемента перечисления)
  • «Дата» и «Дата/время» (Unix-время, всегда целое число)
• str_value Строка Значение, если тип атрибута «Строка»
bill Массив Чек TMDriver. Данный узел выводится только, если по заказу есть чек
• code Строка Код элемента расчета
• text Строка Наименование элемента расчета
• value Строка Значение элемента расчета (количество)
• sum Строка Стоимость элемента расчета
fact_route Массив Фактический маршрут по заказу, выводится только если поле fact_route передали в списке фильтра полей fields
• lat Дробное Широта точки маршрута
• lon Дробное Долгота точки маршрута
• time ГГГГММДДччммсс Время данной точки
• speed Целое Скорость в данный момент, км/ч
• direction Целое Направление движения, градусы (0 - север, 90 - восток, 180 - юг, 270 - запад)
is_auction true или false Признак заказа-аукциона
payment_pay_system Строка Тип платежной системы ("card", "gpay", "apple_pay", "qr", "sber_pay", либо пусто, если не используется).

Пример:

Запрос: 

GET https://ip:port/common_api/1.0/get_order_state?order_id=1  
Signature: <...> 

Ответ: 

{
  "code":0,
  "descr":"OK",
  "data":{
    "order_id":1,
    "state_id":12,
    "state_kind":"car_at_place",
    "crew_id":1,
    "prior_crew_id":0,
    "driver_id":2,
    "car_id":3,
    "server_time_offset:0,
    "start_time":"20130117125641",
    "source_time":"20130117132617",
    "finish_time":"20130117130343",
    "source":"30 Лет Победы ул. \/Ижевск\/, 4Б",
    "source_lat":56.863613,
    "source_lon":53.186539,
    "destination":"Кирова ул. \/Ижевск\/, 56",
    "destination_lat":56.862202,
    "destination_lon":53.187485,
    "stops":[
      {
        "address":"30 Лет Победы ул. \/Ижевск\/, 8",
        "lat":56.863388,
        "lon":53.184269
      }
    ],
    "trip_distance":10.5,
    "trip_time":20,
    "customer":"Слепаков",
    "passenger":"Слепаков",
    "phone":"8800",
    "client_id":1,
    "client_employee_id":1,
    "order_crew_group_id":1,
    "tariff_id":1,
    "car_mark":"Ауди",
    "car_model":"Q7",
    "car_color":"черный",
    "car_number":"А777АА",   
    "confirmed":"confirmed_by_oper",
    "crew_coords": {
        "lat": 56.833981,
        "lon": 53.220249
    },
    "order_params":[
      1,
      2,
      5
    ],
    "creation_way":"operator",
    "is_prior":true,
    "is_really_prior":false,
    "email":"mail@mail.ru",
    "prior_to_current_before_minutes":30,
    "flight_number":"A-0501/123",
    "sum":50.5,
    "total_sum":80,
    "cash_sum":20.1,
    "cashless_sum":10,
    "bonus_sum":5.2,
    "bank_card_sum":15,
    "attribute_values": [
        {
              "id": 1,
              "bool_value": true
        },
        {
              "id": 2,
              "num_value": 1
        },
        {
              "id": 3,
              "num_value": 10
        },
        {
              "id": 4,
              "str_value": "строка"
        }
    ],
    "bill":
    [
      {
        "code":"BOARDING",
        "text":"Посадка",
        "value":"",
        "sum":"20,00"
      },
      {
        "code":"TRIP_TIME",
        "text":"Общее время",
        "value":"0:00:00",
        "sum":""
      },
      {
        "code":"TRIP_DIST",
        "text":"Общее расстояние",
        "value":"0,00 км",
        "sum":""
      },
      {
        "code":"BEFORE_DISC",
        "text":"Сумма без скидки",
        "value":"",
        "sum":"20,00"
      },
      {
        "code":"AFTER_DISC",
        "text":"Сумма со скидкой",
        "value":"",
        "sum":"20,00"
      },
      {
        "code":"MINIMUM",
        "text":"Минималка",
        "value":"",
        "sum":"60,00"
      }
    ],
    "fact_route":
    [
      {
        "lat":11.111111,
        "lon":22.222222,
        "time":"20130117132617",
        "speed":123,
        "direction":0
      }
    ],
    "is_auction":false,
    "payment_pay_system": "qr"
  }
}

Создание задачи СМС серверу

Метод: POST

Название запроса: send_sms

Параметры:

Параметры Тип Описание
Обязательные параметры
phone Строка, <= 30 символов Номер телефона
message Строка Текст СМС

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример:

Запрос:

POST /common_api/1.0/send_sms 
Content-Type: application/x-www-form-urlencoded
Content-Length: 33

Signature: <...>

message=SMSText&phone=89050057216

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{}
}

Проверка авторизации

Метод: GET

Название запроса: check_authorization

Параметры:

Параметры Тип Описание
Обязательные параметры
login Строка, <= 60 символов Логин
password Строка, <= 60 символов Пароль

Специальные возвращаемые коды:

Код Описание
100 Не найден клиент с логином LOGIN и/или неверный пароль

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
client_id Целое ИД клиента

Пример:

Запрос:

GET https://ip:port/common_api/1.0/check_authorization?login=LOGIN&password=PASSWORD 

Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "client_id":131
 }
}

Регистрация клиента

Метод: POST

Название запроса: register_client

Параметры:

Параметры Тип Описание
Обязательные параметры
name Строка, <= 60 символов ФИО
login Строка, <= 60 символов Логин
password Строка, <= 60 символов Пароль
phones Строка Номера телефонов (через запятую)
Необязательные параметры
client_group Целое ИД группы клиента
parent_id Целое ИД клиента-родителя
address Строка Домашний адрес
birthday ГГГГММДДччммсс Дата рождения
gender Строка Пол. Может принимать значения:

• "male" - мужской

• "female" - женский

email Строка E-mail
use_email_informing true или false Использовать E-mail для отправки уведомлений по заказу
comment Строка Комментарий
use_own_account true или false Использовать собственный счет для оплаты заказов

Специальные возвращаемые коды:

Код Описание
100 Клиент с ИД=ID имеет такой же номер телефона=PHONE
101 Клиент с логином=LOGIN уже существует
102 Группа клиента с ИД=CLIENT_GROUP не найдена
103 Клиент указанный в качестве родителя с ИД=PARENT_ID не найден
109 Пароль клиента не соответствует политике паролей

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
client_id Целое ИД созданного клиента

Пример:

Запрос:

POST https://ip:port/common_api/1.0/register_client 
Signature: <...>
Content-Type: application/x-www-form-urlencoded
Content-Length: 104
name=NAME&phones=88,99&login=LOGIN&password=PASSWORD&birthday=19930218115517&gender=male&address=ADDRESS&client_group=1&parent_id=10&email=mail%40ya.ru&use_email_informing=true&use_own_account=false


Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "client_id":140
  }
}

Регистрация клиента 2

Метод: POST

Название запроса: register_client2

Версия ТМ: 3.12

Параметры в формате JSON:

Параметры Тип Описание
Обязательные параметры
name Строка, <= 60 символов ФИО
login Строка, <= 60 символов Логин
password Строка, <= 60 символов Пароль
phones Массив Массив телефонов клиента
• phone Строка Номер телефона
• is_default true или false Признак основного телефона
Необязательные параметры
client_group_id Целое ИД группы клиента
parent_id Целое ИД клиента-родителя
address Строка Домашний адрес
birthday ГГГГММДДччммсс Дата рождения
gender Строка Пол. Может принимать значения:

• "male" - мужской

• "female" - женский

email Строка E-mail
use_email_informing true или false Использовать E-mail для отправки уведомлений по заказу
comment Строка Комментарий
use_own_account true или false Использовать собственный счет для оплаты заказов
attribute_values Массив Массив значений атрибутов
• id Целое Идентификатор атрибута
• bool_value true или false Значение, если тип атрибута «Логический»
• num_value Дробное Значение, если тип атрибута:
  • «Число» (непосредственное значение)
  • «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
  • «Перечисляемый» (значение выбранного элемента перечисления)
  • «Дата» и «Дата/время» (Unix-время, всегда целое число)
• str_value Строка Значение, если тип атрибута «Строка»

Специальные возвращаемые коды:

Код Описание
100 Дублирование номера телефона=PHONE в списке
101 Клиент с логином=LOGIN уже существует
102 Группа клиента с ИД=CLIENT_GROUP не найдена
103 Клиент указанный в качестве родителя с ИД=PARENT_ID не найден
105 Основной телефон может быть только один
106 Клиент должен иметь основной телефон
107 Атрибут с ИД=ID не найден
108 Атрибут с ИД=ID не может быть привязан к клиенту
109 Пароль клиента не соответствует политике паролей

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
client_id Целое ИД созданного клиента

Пример:

Запрос:

POST https://ip:port/common_api/1.0/register_client2 HTTP/1.1
Signature: <...>
Content-Type: application/json
Content-Length: <...>

{
  "name":"NAME",
  "login":"LOGIN",
  "password":"PASSWORD",
  "phones":[
    {
      "phone":"88",
      "is_default":true
    },
    {
      "phone":"99",
      "is_default":false
    }
  ],
  "address":"ADDRESS",
  "gender":"male",
  "birthday":"20000101000000",
  "client_group_id":1,
  "parent_id":10,
  "email":"mail@ya.ru",
  "use_email_informing":true,
  "comment":"TEXT",
  "use_own_account":false,
  "attribute_values":[
    {
      "id":5,
      "bool_value":true
    },
    {
      "id":7,
      "num_value":10
    },
    {
      "id":9,
      "str_value":"TEST"
    }
  ]
}

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "client_id":140
  }
}

Запрос информации по клиенту

Метод: GET

Название запроса: get_client_info

Параметры:

Параметры Тип Описание
Обязательные параметры
client_id Целое ИД клиента
Необязательные параметры
fields Строка Список возвращаемых полей через запятую. Для полей списка сотрудников, запрашиваемого клиента, названия начинаются с "employees.", например: "employees.name"

Специальные возвращаемые коды:

Код Описание
100 Не найден клиент ИД=CLIENT_ID

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
client_id Целое ИД клиента
parent_id Целое ИД клиента-родителя
name Строка ФИО
number Строка Номер договора
address Строка Домашний адрес
gender Строка Пол. Может принимать значения:

• "" - не указан

• "male" - мужской

• "female" - женский

birthday ДД.ММ.ГГГГ Дата рождения
phones Массив Массив телефонов клиента
• phone Строка Номер телефона клиента
balance Дробное Баланс
bonus_balance Дробное Бонусный баланс
login Строка Логин
password Строка Пароль
client_group_id Целое ИД группы клиента
tariff_id Целое ИД тарифа клиента или группы клиентов
prize_tariff_id Целое ИД призового тарифа клиента или группы клиентов
tariff_shift_id Целое ИД смены тарифов клиента или группы клиентов
discount_id Целое ИД скидки клиента или группы клиентов
prize_discount_id Целое ИД призовой скидки клиента или группы клиентов
min_balance Дробное Порог, ниже которого не может опускаться баланс
min_balance_for_use_cashless Дробное Минимальный баланс для использования безналичного счета
min_bonus_balance_for_use_bonus Дробное Минимальный баланс для использования бонусного счета
is_locked true или false Клиент заблокирован
lock_description Строка Причина блокировки
use_cashless_account true или false Признак использования безналичного счета
use_cashless true или false Признак использования безналичного расчета по умолчанию. Имеет смысл только при use_cashless_account = true
no_cash_payment true или false Признак запрета использования наличных расчетов. Имеет смысл только при use_cashless_account = true и use_cashless = true
remain_prize Целое Сколько заказов осталось до призового
email Строка E-mail
use_email_informing true или false Использовать E-mail для отправки уведомлений по заказу
default_crew_group Целое Группа экипажей по умолчанию
use_own_account true или false Использовать собственный счет для оплаты заказа
comment Строка Комментарий
employees Массив Массив сотрудников клиента. Поля аналогичны полям основного клиента, только у сотрудников отсутствует поле employees
accounts Массив Массив счетов клиента. Для сотрудников счета возвращаются, только если их явно запросили в фильтре полей "employees.accounts"
• account_kind Целое Тип счета:
  • 0 - Основной счет
  • 1- Бонусный счет
  • Остальные - нестандартные счета
• balance Дробное Баланс счета клиента
• balance_with_children Дробное Баланс счета клиента с учетом вложенных клиентов
attribute_values Массив Массив значений атрибутов. Возвращается, только если явно запросили в фильтре полей "attribute_values" или "employees.attribute_values" для сотрудников
• id Целое Идентификатор атрибута
• bool_value true или false Значение, если тип атрибута «Логический»
• num_value Дробное Значение, если тип атрибута:
  • «Число» (непосредственное значение)
  • «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
  • «Перечисляемый» (значение выбранного элемента перечисления)
  • «Дата» и «Дата/время» (Unix-время, всегда целое число)
• str_value Строка Значение, если тип атрибута «Строка»

Пример:

Запрос:

GET https://ip:port/common_api/1.0/get_client_info?client_id=140 

Signature: <...>

Ответ:

{
  "code": 0,
  "descr": "OK",
  "data": {
    "client_id": 20,
    "parent_id": 0,
    "name": "Юр. лицо1",
    "number": "111",
    "address": "Адрес Юр. лицо1",
    "gender": "",
    "birthday": "22.01.2016",
    "phones": [
      "105",
      "123456789",
      "100"
    ],
    "balance": 10,
    "bonus_balance": 333,
    "login": "111",
    "password": "111",
    "client_group_id": 1,
    "tariff_id": 39,
    "prize_tariff_id": 0,
    "tariff_shift_id": 0,
    "discount_id": 2,
    "prize_discount_id": 0,
    "min_balance": 0,
    "min_balance_for_use_cashless": null,
    "min_bonus_balance_for_use_bonus": null,
    "is_locked": false,
    "lock_description": "",
    "use_cashless_account": true,
    "use_cashless": true,
    "remain_prize": 0,
    "email": "Юр. лицо1@ss.ru",
    "use_email_informing": true,
    "default_crew_group": 6,
    "comment": "Сотрудник СВР. Использовать максимальные скидки",
    "employees": [
      {
        "client_id": 323,
        "parent_id": 20,
        "name": "Сотрудник1",
        "number": "111",
        "address": "Адрес Сотрудник1",
        "gender": "",
        "birthday": null,
        "phones": [
          "11221122112211"
        ],
        "balance": 0,
        "bonus_balance": 0,
        "login": "",
        "password": "",
        "client_group_id": 1,
        "tariff_id": 17,
        "prize_tariff_id": 0,
        "tariff_shift_id": 0,
        "discount_id": 2,
        "prize_discount_id": 0,
        "min_balance": 0,
        "min_balance_for_use_cashless": null,
        "min_bonus_balance_for_use_bonus": null,
        "is_locked": false,
        "lock_description": "",
        "use_cashless": true,
        "remain_prize": 0,
        "email": "Сотрудник1@ss.ru",
        "use_email_informing": true,
        "default_crew_group": 6,
        "accounts": [
          {
            "account_kind": 0,
            "balance": 400.00,
            "balance_with_children": 0.00
          },
          {
            "account_kind": 1,
            "balance": 0.00,
            "balance_with_children": 0.00
          },
          {
            "account_kind": 1003,
            "balance": 100.00,
            "balance_with_children": 0.00
          }
        ],
        "attribute_values": [
          {
            "id": 5,
            "bool_value": true
          },
          {
            "id": 4,
            "bool_value": true
          }
        ]
      }
    ],
    "accounts": [
      {
        "account_kind": 0,
        "balance": 2355.00,
        "balance_with_children": 2755.00
      },
      {
        "account_kind": 1,
        "balance": 0.00,
        "balance_with_children": 0.00
      },
      {
        "account_kind": 1003,
        "balance": -20.00,
        "balance_with_children": 80.00
      }
    ],
    "attribute_values": [
      {
        "id": 4,
        "bool_value": true
      }
    ]
  }
}

Запрос информации по клиентам

Метод: GET

Название запроса: get_clients_info

Версия ТМ: 3.5

Параметры:

Параметры Тип Описание
Необязательные параметры
text Строка Текст для поиска по названию или по номеру договора клиента
max_clients_count Целое Максимальное количество клиентов, которое надо вернуть. Если не указано, то 10.
client_group_id Целое Фильтр по группе клиентов
parent_id Целое Фильтр по вышестоящему подразделению, возвращаются все подчиненные отделы и сотрудники на всю глубину иерархии
fields Строка Список возвращаемых полей через запятую. По умолчанию возвращаются поля "name" и "number". Поле "client_id" возвращается всегда

Специальные возвращаемые коды: Нет

Возвращаемые данные в случае успешного выполнения запроса:

Параметры Тип Описание
client_id Целое ИД клиента
name Строка Наименование
number Строка Номер договора
parent_id Целое ИД клиента-родителя
address Строка Домашний адрес
gender Строка Пол. Может принимать значения:

• "" - не указан

• "male" - мужской

• "female" - женский

birthday ДД.ММ.ГГГГ Дата рождения
phones Массив Массив телефонов клиента
• phone Строка Номер телефона клиента
balance Дробное Баланс
bonus_balance Дробное Бонусный баланс
login Строка Логин
password Строка Пароль
client_group_id Целое ИД группы клиента
tariff_id Целое ИД тарифа клиента или группы клиентов
prize_tariff_id Целое ИД призового тарифа клиента или группы клиентов
tariff_shift_id Целое ИД смены тарифов клиента или группы клиентов
discount_id Целое ИД скидки клиента или группы клиентов
prize_discount_id Целое ИД призовой скидки клиента или группы клиентов
min_balance Дробное Порог, ниже которого не может опускаться баланс
min_balance_for_use_cashless Дробное Минимальный баланс для использования безналичного счета
min_bonus_balance_for_use_bonus Дробное Минимальный баланс для использования бонусного счета
is_locked true или false Клиент заблокирован
lock_description Строка Причина блокировки
use_cashless_account true или false Признак использования безналичного счета
use_cashless true или false Признак использования безналичного расчета по умолчанию. Имеет смысл только при use_cashless_account = true
no_cash_payment true или false Признак запрета использования наличных расчетов. Имеет смысл только при use_cashless_account = true и use_cashless = true
remain_prize Целое Сколько заказов осталось до призового
email Строка E-mail
use_email_informing true или false Использовать E-mail для отправки уведомлений по заказу
default_crew_group Целое Группа экипажей по умолчанию
use_own_account true или false Использовать собственный счет для оплаты заказа
comment Строка Комментарий
accounts Массив Массив счетов клиента
• account_kind Целое Тип счета:
  • 0 - Основной счет
  • 1- Бонусный счет
  • Остальные - нестандартные счета
• balance Дробное Баланс счета клиента
• balance_with_children Дробное Баланс счета клиента с учетом вложенных клиентов
attribute_values Массив Массив значений атрибутов
• id Целое Идентификатор атрибута
• bool_value true или false Значение, если тип атрибута «Логический»
• num_value Дробное Значение, если тип атрибута:
  • «Число» (непосредственное значение)
  • «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
  • «Перечисляемый» (значение выбранного элемента перечисления)
  • «Дата» и «Дата/время» (Unix-время, всегда целое число)
• str_value Строка Значение, если тип атрибута «Строка»

Пример:

Запрос:

GET https://ip:port/common_api/1.0/get_clients_info?text=test&max_clients_count=10&client_group_id=1&parent_id=20&fields=name,number HTTP/1.1
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "clients_info":[
      {
        "client_id":390,
        "name":"tester1",
        "number":"001"
      },
      {
        "client_id":394,
        "name":"tester2",
        "number":"002"
      }
    ]
  }
}

Изменение информации по клиенту

Метод: POST

Название запроса: update_client_info

Параметры:

Параметры Тип Описание
Обязательные параметры
client_id Целое ИД клиента
Необязательные параметры
name Строка, <= 60 символов ФИО
login Строка, <= 60 символов Логин
password Строка, <= 60 символов Пароль
phones Строка Номера телефонов (через запятую)
address Строка Домашний адрес
birthday ГГГГММДДччммсс Дата рождения
gender Строка Пол. Может принимать значения:

• "male" - мужской

• "female" - женский

parent_id Целое ИД клиента-родителя
client_group_id Целое ИД группы клиента
email Строка E-mail
use_email_informing true или false Использовать E-mail для отправки уведомлений по заказу
comment Строка Комментарий
use_own_account true или false Использовать собственный счет для оплаты заказов

Специальные возвращаемые коды:

Код Описание
100 Клиент с номером телефона=PHONE уже существует
101 Клиент с ИД=ID имеет такой же номер телефона=PHONE
102 Клиент с логином=LOGIN уже существует
103 Группа клиента с ИД=CLIENT_GROUP_ID не найдена
104 Клиент указанный в качестве родителя с ИД=PARENT_ID не найден
109 Пароль клиента не соответствует политике паролей

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример:

Запрос:

POST https://ip:port/common_api/1.0/update_client_info 
Signature: <...>
Content-Type: application/x-www-form-urlencoded
Content-Length: <...>

client_id=140&name=NAME&phones=88,99&login=LOGIN&password=PASSWORD&birthday=20140901000000&gender=male&address=ADDRESS&parent_id=10&client_group_id=3&email=mail%40ya.ru&use_email_informing=true

Ответ:

{
 "code":0,
  "descr":"OK",
  "data":{}
}

Изменение информации по клиенту 2

Метод: POST

Название запроса: update_client_info2

Версия ТМ: 3.12

Параметры в формате JSON:

Параметры Тип Описание
Обязательные параметры
client_id Целое ИД клиента
Необязательные параметры
name Строка, <= 60 символов ФИО
login Строка, <= 60 символов Логин
password Строка, <= 60 символов Пароль
phones Массив Массив телефонов клиента
• phone Строка Номер телефона
• is_default true или false Признак основного телефона
client_group_id Целое ИД группы клиента
parent_id Целое ИД клиента-родителя
address Строка Домашний адрес
birthday ГГГГММДДччммсс Дата рождения
gender Строка Пол. Может принимать значения:

• "male" - мужской

• "female" - женский

email Строка E-mail
use_email_informing true или false Использовать E-mail для отправки уведомлений по заказу
comment Строка Комментарий
use_own_account true или false Использовать собственный счет для оплаты заказов
attribute_values Массив Массив значений атрибутов
• id Целое Идентификатор атрибута
• bool_value true или false Значение, если тип атрибута «Логический»
• num_value Дробное Значение, если тип атрибута:
  • «Число» (непосредственное значение)
  • «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
  • «Перечисляемый» (значение выбранного элемента перечисления)
  • «Дата» и «Дата/время» (Unix-время, всегда целое число)
• str_value Строка Значение, если тип атрибута «Строка»

Специальные возвращаемые коды:

Код Описание
100 Клиент с ИД=CLIENT_ID не найден
101 Дублирование номера телефона=PHONE в списке
102 Клиент с логином=LOGIN уже существует
103 Группа клиента с ИД=CLIENT_GROUP_ID не найдена
104 Клиент указанный в качестве родителя с ИД=PARENT_ID не найден
105 Основной телефон может быть только один
106 Клиент должен иметь основной телефон
107 Атрибут с ИД=ID не найден
108 Атрибут с ИД=ID не может быть привязан к клиенту
109 Пароль клиента не соответствует политике паролей

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример:

Запрос:

POST https://ip:port/common_api/1.0/update_client_info2 HTTP/1.1
Signature: <...>
Content-Type: application/json
Content-Length: <...>

{
  "client_id":140,
  "name":"NAME",
  "login":"LOGIN",
  "password":"PASSWORD",
  "phones":[
    {
      "phone":"88",
      "is_default":true
    }
  ],
  "address":"ADDRESS",
  "gender":"male",
  "birthday":"20000101000000",
  "client_group_id":1,
  "parent_id":10,
  "email":"mail@ya.ru",
  "use_email_informing":true,
  "comment":"TEXT",
  "use_own_account":false,
  "attribute_values":[
    {
      "id":7,
      "num_value":5
    },
    {
      "id":9,
      "str_value":null
    }
  ]
}

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{}
}

Запрос текущих заказов

Метод: GET

Название запроса: get_current_orders

Параметры:

Параметры Тип Описание
Необязательные параметры
client_id Целое ИД клиента
client_employee_id Целое ИД сотрудника (только если указан ИД клиента)
phone Строка, <= 30 символов Телефон клиента
crew_id Целое ИД экипажа
driver_id Целое ИД водителя
fields Строка Список возвращаемых полей через запятую

Специальные возвращаемые коды:

Код Описание
100 Не найден клиент ИД=CLIENT_ID
101 Не найден сотрудник клиента ИД=CLIENT_EMPLOYEE_ID

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
id Целое ИД заказа
state_id Целое ИД состояния заказа
state_kind Строка Тип состояния заказа. Может принимать значения:
  • "new_order" — новый заказ
  • "driver_assigned" — водитель назначен
  • "car_at_place" — машина подъехала на место
  • "client_inside" — клиент в машине
  • "finished" — заказ успешно завершен
  • "aborted" — заказ прекращен
crew_id Целое ИД экипажа
prior_crew_id Целое ИД предварительного экипажа
driver_id Целое ИД водителя
car_id Целое ИД автомобиля
server_time_offset Целое Смещение относительно серверного времени
start_time ГГГГММДДччммсс Дата создания заказа
source_time ГГГГММДДччммсс Время подачи
source Строка Адрес подачи
source_lat Строка Широта адреса подачи
source_lon Строка Долгота адреса подачи
destination Строка Адрес назначения
destination_lat Строка Широта адреса назначения
destination_lon Строка Долгота адреса назначения
stops Массив Информация по остановкам заказа
• address Строка Адрес остановки
• lat Дробное Широта адреса остановки
• lon Дробное Долгота адреса остановки
customer Строка Заказчик
passenger Строка Пассажир
phone Строка Номер телефона
phone_to_dial Строка Номер телефона для отзвона
client_id Целое ИД клиента
client_name Строка Имя клиента
client_group_id Целое ИД группы клиента
client_group_name Строка Название группы клиента
client_employee_id Целое ИД сотрудника клиента
order_crew_group_id Целое ИД группы экипажей, которая указана в заказе
tariff_id Целое ИД тарифа
car_mark Строка Марка автомобиля
car_model Строка Модель автомобиля
car_color Строка Цвет автомобиля
car_number Строка Гос.номер автомобиля
confirmed Строка Состояние подтвержденности заказа водителем или оператором. Может принимать значения:
  • "not_confirmed" — не подтверждено
  • "confirmed_by_driver" — заказ принят водителем
  • "confirmed_by_oper" — заказ подтвержден оператором
crew_coords Массив Координаты экипажа
• lat Дробное Широта
• lon Дробное Долгота
order_params Массив Массив параметров заказа экипажа. Устарело. Рекомендуется использовать параметр attribute_values. (Возвращается только если в списке фильтра полей fields запросили поле order_params)
Целое ИД параметра заказа
creation_way Строка Способ создания заказа. Может принимать значения:

• "operator" — заказ создан оператором

• "sms" — заказ создан через смс

• "market" — заказ из биржи

• "common_api" — заказ создан через api

• "t_api" — заказ создан через api

• "taxophone" — заказ создан через таксофон с телефона

• "driver" — заказ создан водителем

• "daily_order" — ежедневный заказ

• "taxophone_web" — заказ создан через таксофон с сайта

• "unknown" — неизвестный

is_prior true или false Предварительный заказ
is_really_prior true или false Предварительный заказ на вкладке "Предварительные"
email Строка Email для уведомлений
prior_to_current_before_minutes Целое Время перехода из предварительного в текущие заказы, мин
flight_number Строка Номер рейса
sum Дробное Сумма без скидки
total_sum Дробное Итоговая сумма заказа
cash_sum Дробное Сумма наличными
cashless_sum Дробное Сумма безналичными
bonus_sum Дробное Сумма бонусами
bank_card_sum Дробное Сумма банковской картой
attribute_values Массив Массив значений атрибутов
• id Целое Идентификатор атрибута
• bool_value true или false Значение, если тип атрибута «Логический»
• num_value Дробное Значение, если тип атрибута:
  • «Число» (непосредственное значение)
  • «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
  • «Перечисляемый» (значение выбранного элемента перечисления)
  • «Дата» и «Дата/время» (Unix-время, всегда целое число)
• str_value Строка Значение, если тип атрибута «Строка»
bill Массив Чек TMDriver. Данный узел выводится только, если по заказу есть чек и если в списке фильтра полей fields запросили поле bill
• code Строка Код элемента расчета
• text Строка Наименование элемента расчета
• value Строка Значение элемента расчета (количество)
• sum Строка Стоимость элемента расчета
is_auction true или false Признак заказа-аукциона
payment_pay_system Строка Тип платежной системы ("card", "gpay", "apple_pay", "qr", "sber_pay", либо пусто, если не используется)

Пример:

Запрос:

GET https://ip:port/common_api/1.0/get_current_orders?client_id=140&phone=18 
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "order_id":1,
    "state_id":12,
    "state_kind":"car_at_place",
    "crew_id":1,
    "prior_crew_id":0,
    "driver_id":2,
    "car_id":3,
    "server_time_offset:0,
    "start_time":"20130117125641",
    "source_time":"20130117132617",
    "source":"30 Лет Победы ул. \/Ижевск\/, 4Б",
    "source_lat":56.863613,
    "source_lon":53.186539,
    "destination":"Кирова ул. \/Ижевск\/, 56",
    "destination_lat":56.862202,
    "destination_lon":53.187485,
    "stops":[
      {
        "address":"30 Лет Победы ул. \/Ижевск\/, 8",
        "lat":56.863388,
        "lon":53.184269
      }
    ],
    "customer":"Слепаков",
    "passenger":"Слепаков",
    "phone":"8800",
    "client_id":1,
    "client_employee_id":1,
    "order_crew_group_id":1,
    "tariff_id":1,
    "car_mark":"Ауди",
    "car_model":"Q7",
    "car_color":"черный",
    "car_number":"А777АА",   
    "confirmed":"confirmed_by_oper",
    "crew_coords": {
        "lat": 56.833981,
        "lon": 53.220249
    },
    "order_params":[
      1,
      2,
      5
    ],
    "creation_way":"operator",
    "is_prior":true,
    "is_really_prior":false,
    "email":"mail@mail.ru",
    "prior_to_current_before_minutes":30,
    "flight_number":"A-0501/123",
    "sum":50.5,
    "total_sum":80,
    "cash_sum":20.1,
    "cashless_sum":10,
    "bonus_sum":5.2,
    "bank_card_sum":15,
    "attribute_values": [
        {
              "id": 1,
              "bool_value": true
        },
        {
              "id": 2,
              "num_value": 1
        },
        {
              "id": 3,
              "num_value": 10
        },
        {
              "id": 4,
              "str_value": "строка"
        }
    ],
    "bill":
    [
      {
        "code":"BOARDING",
        "text":"Посадка",
        "value":"",
        "sum":"20,00"
      },
      {
        "code":"TRIP_TIME",
        "text":"Общее время",
        "value":"0:00:00",
        "sum":""
      },
      {
        "code":"TRIP_DIST",
        "text":"Общее расстояние",
        "value":"0,00 км",
        "sum":""
      },
      {
        "code":"BEFORE_DISC",
        "text":"Сумма без скидки",
        "value":"",
        "sum":"20,00"
      },
      {
        "code":"AFTER_DISC",
        "text":"Сумма со скидкой",
        "value":"",
        "sum":"20,00"
      },
      {
        "code":"MINIMUM",
        "text":"Минималка",
        "value":"",
        "sum":"60,00"
      }
    ]
        "is_auction":false,
        "payment_pay_system":"qr"
  }
}

Запрос выполненных заказов

Метод: GET

Название запроса: get_finished_orders

Параметры:

Параметры Тип Описание
Обязательные параметры
start_time ГГГГММДДччммсс Начало периода
finish_time ГГГГММДДччммсс Конец периода
Необязательные параметры
Примечание: должен присутствовать хотя бы один параметр из client_id, phone, crew_id, driver_id.
client_id Целое ИД клиента
client_employee_id Целое ИД сотрудника (только если указан ИД клиента)
phone Строка, <= 30 символов Телефон клиента
crew_id Целое ИД экипажа
driver_id Целое ИД водителя
state_type Строка Тип состояния заказа. Может принимать значения:

• "all" — все

• "finished" — выполненные

• "aborted" — прекращенные

state_ids Строка Список состояний заказа через точку с запятой, пример: «1;2;3»
fields Строка Список возвращаемых полей через запятую

Примечание: должен присутствовать хотя бы один параметр из client_id, phone, crew_id, driver_id.

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
id Целое ИД заказа
state_id Целое ИД состояния заказа
crew_id Целое ИД экипажа
prior_crew_id Целое ИД предварительного экипажа
driver_id Целое ИД водителя
car_id Целое ИД автомобиля
server_time_offset Целое Смещение относительно серверного времени
start_time ГГГГММДДччммсс Время создания заказа
source_time ГГГГММДДччммсс Время подачи
finish_time ГГГГММДДччммсс Время завершения заказа
source Строка Адрес подачи
source_lat Дробное Широта адреса подачи
source_lon Дробное Долгота адреса подачи
destination Строка Адрес назначения
destination_lat Дробное Широта адреса назначения
destination_lon Дробное Долгота адреса назначения
stops Массив Массив адресов остановок
• address Строка Адрес остановки
• lat Дробное Широта адреса остановки
• lon Дробное Долгота адреса остановки
trip_distance Дробное Фактический километраж
trip_time Целое Фактическое время в пути
customer Строка Заказчик
passenger Строка Пассажир
phone Строка Номер телефона
phone_to_dial Строка Номер телефона для отзвона
client_id Целое ИД клиента
client_name Строка Имя клиента
client_group_id Целое ИД группы клиента
client_group_name Строка Название группы клиента
client_employee_id Целое ИД сотрудника клиента
order_crew_group_id Целое ИД группы экипажей, которая указана в заказе
tariff_id Целое ИД тарифа
car_mark Строка Марка автомобиля
car_model Строка Модель автомобиля
car_color Строка Цвет автомобиля
car_number Строка Гос.номер автомобиля
order_params Массив Массив параметров заказа экипажа. Устарело. Рекомендуется использовать параметр attribute_values. (Возвращается только если в списке фильтра полей fields запросили поле order_params)
Целое ИД параметра заказа
creation_way Строка Способ создания заказа. Может принимать значения:

• "operator" — заказ создан оператором

• "sms" — заказ создан через смс

• "market" — заказ из биржи

• "common_api" — заказ создан через api

• "t_api" — заказ создан через api

• "taxophone" — заказ создан через таксофон с телефона

• "driver" — заказ создан водителем

• "daily_order" — ежедневный заказ

• "taxophone_web" — заказ создан через таксофон с сайта

• "unknown" — неизвестный

is_prior true или false Предварительный заказ
email Строка Email для уведомлений
flight_number Строка Номер рейса
sum Дробное Стоимость заказа без учета скидок (наценок)
total_sum Дробное Итоговая стоимость заказа
cash_sum Дробное Заплачено наличными
cashless_sum Дробное Заплачено с безналичного счета клиента
bonus_sum Дробное Заплачено с бонусного счета клиента
bank_card_sum Дробное Заплачено банковской картой
attribute_values Массив Массив значений атрибутов
• id Целое Идентификатор атрибута
• bool_value true или false Значение, если тип атрибута «Логический»
• num_value Дробное Значение, если тип атрибута:
  • «Число» (непосредственное значение)
  • «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
  • «Перечисляемый» (значение выбранного элемента перечисления)
  • «Дата» и «Дата/время» (Unix-время, всегда целое число)
• str_value Строка Значение, если тип атрибута «Строка»
bill Массив Чек TMDriver. Данный узел выводится только, если по заказу есть чек и если в списке фильтра полей fields запросили поле bill
• code Строка Код элемента расчета
• text Строка Наименование элемента расчета
• value Строка Значение элемента расчета (количество)
• sum Строка Стоимость элемента расчета
is_auction true или false Признак заказа-аукциона
payment_pay_system Строка Тип платежной системы ("card", "gpay", "apple_pay", "qr", "sber_pay", либо пусто, если не используется)

Пример:

Запрос:

GET https://ip:port/common_api/1.0/get_finished_orders?start_time=20220405142210&finish_time=20220405142710&fields=state_id,crew_id,prior_crew_id,driver_id,car_id,server_time_offset,start_time,source_time,finish_time,source,source_lat,source_lon,destination,destination_lat,destination_lon,stops,trip_distance,trip_time,customer,passenger,phone,phone_to_dial,client_id,client_name,client_group_id,client_group_name,client_employee_id,order_crew_group_id,tariff_id,order_params,attribute_values,creation_way,is_prior,email,flight_number,sum,total_sum,cash_sum,cashless_sum,bonus_sum,bank_card_sum,car_mark,car_model,car_color,car_number,bill

Ответ:
{
  "code":0,
  "descr":"OK",
  "data":
  {
    "orders":
    [
      {
        "id":47834,
        "state_id":4,
        "crew_id":17,
        "prior_crew_id":0,
        "driver_id":17,
        "car_id":16,
        "server_time_offset":0,
        "start_time":"20220405142418",
        "source_time":"20220405142418",
        "finish_time":"20220405142708",
        "source":"5-Я ЯМСКОГО ПОЛЯ УЛ., 37",
        "source_lat":56.853062,
        "source_lon":53.20715,
        "destination":"ХОДЫНСКАЯ УЛ., 10А",
        "destination_lat":0,
        "destination_lon":0,
        "stops":
        [],
        "trip_distance":10,
        "trip_time":3600,
        "customer":"Client 89872977005",
        "passenger":"",
        "phone":"89872977005",
        "phone_to_dial":"",
        "client_id":43111,
        "client_name":"Client 89872977005",
        "client_group_id":2,
        "client_group_name":"Физические",
        "client_employee_id":0,
        "order_crew_group_id":0,
        "tariff_id":2,
        "order_params":
        [
          28,
          29,
          30,
          55,
          58,
          59,
          62
        ],
        "attribute_values":
        [
          {
            "id":28,
            "num_value":0
          },
          {
            "id":29,
            "num_value":0
          },
          {
            "id":30,
            "num_value":0
          },
          {
            "id":55,
            "num_value":1
          },
          {
            "id":58,
            "num_value":0
          },
          {
            "id":59,
            "num_value":0
          },
          {
            "id":62,
            "num_value":0
          }
        ],
        "creation_way":"operator",
        "is_prior":false,
        "email":"",
        "flight_number":"",
        "sum":100,
        "total_sum":100,
        "cash_sum":50,
        "cashless_sum":40,
        "bonus_sum":10,
        "bank_card_sum":0,
        "car_mark":"Баф",
        "car_model":"Fenix 3346",
        "car_color":"белая",
        "car_number":"а111аа",
        "is_auction":false,
        "payment_pay_system": "qr"
      }
    ]
  }
}

Проведение операции по клиенту

Метод: POST

Название запроса: create_client_operation

Параметры:

Параметры Тип Описание
Обязательные параметры
client_id Целое ИД клиента
sum Дробное Сумма
oper_type Целое Тип операции:

• "receipt" - приход

• "expense" - расход

Необязательные параметры
oper_time ГГГГММДДччммсс Время создания операции (если не указано, текущее)
comment Строка Комментарий
pay_type Целое Тип оплаты:

• "cash" - наличный

• "nocash" - безналичный

bonus_oper true или false Операция по бонусному счёту. Данный параметр устарел - рекомендуется использовать "account_kind"
account_kind Целое Тип счета:
  • 0 - Основной счет
  • 1- Бонусный счет
  • Остальные - нестандартные счета

Специальные возвращаемые коды:

Код Описание
100 Не найден клиент ИД=CLIENT_ID
101 Не найден тип счета ИД=ACCOUNT_KIND

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
oper_id Целое ИД операции

Пример:

Запрос:

POST https://ip:port/common_api/1.0/create_client_operation 
Signature: <...>
Content-Type: application/x-www-form-urlencoded
Content-Length: <...>

client_id=112&oper_time=20130221100719&oper_sum=300&oper_type=receipt&pay_type=cash&comment=COMMENT&account_kind=0

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "oper_id":31

  }
}

Запрос операций по клиенту

Метод: GET

Название запроса: get_client_operations

Параметры:

Параметры Тип Описание
Обязательные параметры
client_id Целое ИД клиента
start_time ГГГГММДДччммсс Начало периода
finish_time ГГГГММДДччммсс Конец периода
Необязательные параметры
account_kind Целое Тип счета:
  • 0 - Основной счет
  • 1- Бонусный счет
  • Остальные - нестандартные счета

Специальные возвращаемые коды:

Код Описание
100 Не найден клиент ИД=CLIENT_ID
101 Не найден тип счета ИД=ACCOUNT_KIND

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
oper_id Целое ИД операции
oper_time ГГГГММДДччммсс Время создания операции
sum Дробное Сумма
order_id Целое Заказ, связанный с операцией
oper_type Целое Тип операции:

• "receipt" - приход

• "expense" - расход

pay_type Целое Тип оплаты:

• "cash" - наличный

• "nocash" - безналичный

account_kind Целое Тип счета:
  • 0 - Основной счет
  • 1- Бонусный счет
  • Остальные - нестандартные счета
name Строка Наименование
comment Строка Комментарий
cancelled_by_oper_id Целое ИД операции отмены (для отмененной операции)
cancelled_oper_id Целое ИД отмененной операции (для операции отмены)

Пример:

Запрос:

GET https://ip:port/common_api/1.0/get_client_operations?client_id=112&start_time=20130201092112&finish_time=20130221092112&account_kind=0 HTTP/1.1
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "operations":[
      {
        "oper_id":111,
        "oper_time":"20130219091328",
        "sum":"21,8",
        "order_id":11800,
        "oper_type":"receipt",
        "pay_type":"cash",
        "account_kind":0,
        "name":"Пополнение счета",
        "comment":"Комментарий",
        "cancelled_by_oper_id":0,
        "cancelled_oper_id":112
      },
      {
        "oper_id":112,
        "oper_time":"20130220112245",
        "sum":"4500",
        "order_id":11801,
        "oper_type":"receipt",
        "pay_type":"cash",
        "account_kind":0,
        "name":"Пополнение счета",
        "comment":"Комментарий"
        "cancelled_by_oper_id":111,
        "cancelled_oper_id":0
      }
    ]
  }
}

Проведение операции по водителю

Метод: POST

Название запроса: create_driver_operation

Параметры в формате JSON:

Параметр Тип Описание
Обязательные параметры
driver_id Целое ИД водителя
oper_sum Дробное Сумма
oper_type Строка Тип операции:

• receipt - приход

• expense - расход

Необязательные параметры
name Строка Наименование операции
oper_time ГГГГММДДччммсс Время создания операции (если не задано, текущее)  !! Не используется с ТМ 3.7
comment Строка Комментарий
account_kind Целое ИД типа счета (0 - основной счет), по умолчанию 0

Специальные возвращаемые коды:

Код Описание
100 Водитель не найден ИД=DRIVER_ID
101 Не найден тип счета ИД=ACCOUNT_KIND

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
oper_id Целое ИД операции


Пример:


Запрос:

POST https://ip:port/common_api/1.0/create_driver_operation 
Signature: <...>
Content-Type: application/json
Content-Length: 99

{
   "driver_id": 1,
   "oper_sum": 10.00,
   "oper_type": "receipt",
   "name": "Пополнение счета",
   "oper_time": "20141210100719",
   "comment": "Комментарий к операции"
    "account_kind": 1
}

Ответ:

{
   "code":0,
   "descr":"OK",
   "data":{
   "oper_id":31
   }
}

Запрос операций по водителю

Метод: GET

Название запроса: get_driver_operations

Параметры:

Параметр Тип Описание
Обязательные параметры
driver_id Целое ИД водителя
start_time ГГГГММДДччммсс Начало периода
finish_time ГГГГММДДччммсс Конец периода
Необязательные параметры
account_kind Целое ИД типа счета (0 - основной счет), по умолчанию 0


Специальные возвращаемые коды:

Код Описание
100 Не найден водитель ИД=DRIVER_ID
101 Не найден тип счета ИД=ACCOUNT_KIND


Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
oper_id Целое ИД операции
oper_time ГГГГММДДччммсс Время создания операции
sum Дробное Сумма
order_id Целое Заказ, связанный с операцией
oper_type Целое Тип операции:

•"receipt" - приход

•"expense" - расход

name Строка Наименование
comment Строка Комментарий
account_kind Целое ИД типа счета
cancelled_by_oper_id Целое ИД операции отмены (для отмененной операции)
cancelled_oper_id Целое ИД отмененной операции (для операции отмены)

Пример:

Запрос:

GET https://ip:port/common_api/1.0/get_driver_operations?
driver_id=112&start_time=20130201092112&finish_time=20130221092112 
Signature: <...>

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "operations":[
      {
        "oper_id":111,
        "oper_time":"20130219091328",
        "sum":"21,8",
        "order_id":11800,
        "oper_type":"receipt",
        "name":"DRIVER_OPERATION_1",
        "comment":"DRIVER_OPERATION_COMMENT_1",
        "account_kind":0,
        "cancelled_by_oper_id":0,
        "cancelled_oper_id":112
      },
      {
        "oper_id":112,
        "oper_time":"20130220112245",
        "sum":"4500",
        "order_id":11801,
        "oper_type":"receipt",
        "name":"DRIVER_OPERATION_2",
        "comment":"DRIVER_OPERATION_COMMENT_2",
        "account_kind":0,
        "cancelled_by_oper_id":111,
        "cancelled_oper_id":0
      }
    ]
  }
}

Назначение динамического приоритета водителю

Метод: POST

Название запроса: create_driver_dyn_priority

Параметры в формате JSON:

Параметр Тип Описание
Обязательные параметры
driver_id Целое ИД водителя (должно быть что-то одно: либо driver_id, либо crew_id)
crew_id Целое ИД экипажа (должно быть что-то одно: либо driver_id, либо crew_id)
priority Целое Приоритет
start_time ГГГГММДДччммсс Время начала действия приоритета
finish_time ГГГГММДДччммсс Время окончания действия приоритета
name Строка Наименование приоритета

Специальные возвращаемые коды:

Код Описание
100 Водитель не найден ИД=DRIVER_ID
101 Экипаж не найден ИД=CREW_ID
102 Время начала действия приоритета должно быть меньше времени окончания
103 Время действия приоритета уже истекло

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
dyn_priority_id Целое ИД созданного динамического приоритета

Пример:

Запрос:
POST https://ip:port/common_api/1.0/create_driver_dyn_priority 
Signature: <...>
Content-Type: application/json
Content-Length: <...>

{
   "driver_id": 1,
   "priority": 10,
   "start_time": "20150101100000",
   "finish_time": "20150101200000",
   "name": "За выполнение заказа в отдаленный район"
}

Ответ:

{
   "code":0,
   "descr":"OK",
   "data":{
   "dyn_priority_id":123
   }
}

Задание координат экипажей

Метод: POST

Название запроса: set_crews_coords

Параметры в формате JSON:

Параметр Тип Описание
Обязательные параметры
crew_coords Массив Массив координат экипажей
• crew_id Целое ИД экипажа
• gps_id Целое GPS идентификатор (если не задан ИД экипажа). Данный параметр устарел - не применяется, начиная с версии 3.9
• lat Дробное Широта
• lon Дробное Долгота
Необязательные параметры
speed Дробное Скорость
direction Целое Направление движения (0-Север, 90-Восток, 180-Юг, 270-Запад, -1-не задано)


Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса: нет


Пример:

Запрос:

POST https://ip:port/common_api/1.0/set_crews_coords HTTP/1.1
Signature: <...>
Content-Type: application/json
Content-Length: <...>

{
  "crews_coords":[
    {
      "crew_id":1,
      "lat":11.111111,
      "lon":22.222222,
      "speed":66.66,
      "direction":333
    },
    {
      "gps_id":2,
      "lat":33.333333,
      "lon":44.444444
    }
  ]
}

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{}
}

Изменение информации по заказу

Метод: POST

Название запроса: update_order

Параметры в формате JSON:

Параметр Тип Описание
Обязательные параметры
order_id Целое ИД заказа
Необязательные параметры
phone Строка, <= 30 символов Номер телефона
source_time ГГГГММДДччммсс Время подачи
is_prior true или false Предварительный заказ
customer Строка Заказчик
passenger Строка Пассажир
comment Строка Комментарий
crew_group_id Целое ИД группы экипажей
client_id Целое ИД клиента
uds_id Целое ИД службы ЕДС
tariff_id Целое ИД тариф
addresses Массив Массив адресов. Первый элемент — адрес

подачи(обязательно), последний — адрес назначения, между ними — остановки.

• address Строка Адрес подачи
• lat Дробное Широта адреса
• lon Дробное Долгота адреса
order_params Массив Массив параметров заказа. Устарело. Рекомендуется использовать параметр attribute_values.
Целое ИД параметра заказа
attribute_values Массив Массив значений атрибутов
• id Целое Идентификатор атрибута
• bool_value true или false Значение, если тип атрибута «Логический»
• num_value Дробное Значение, если тип атрибута:
  • «Число» (непосредственное значение)
  • «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
  • «Перечисляемый» (значение выбранного элемента перечисления)
  • «Дата» и «Дата/время» (Unix-время, всегда целое число)
• str_value Строка Значение, если тип атрибута «Строка»
cost_order Дробное Сумма заказа
state_id Целое ИД состояния заказа
discount_id Целое ИД скидки
auto_select_discount true или false Автоматически подобрать скидку, если не указана явно
auto_select_tariff true или false Автоматически подобрать тариф, если не указан явно
auto_recalc_cost true или false Автоматически пересчитать сумму заказа
auto_update_order_params true или false Автоматически обновить параметры заказа по клиенту и группе клиента
email Строка Email для уведомлений
prior_to_current_before_minutes Целое Время перехода из предварительного в текущие заказы, мин
flight_number Строка Номер рейса
need_custom_validate true или false Использовать специальную проверку перед изменением заказа
client_employee_id Целое ИД сотрудника, должен быть подчиненным старого ИД клиента в заявке, если не передавали новый ИД клиента, либо подчиненным нового ИД клиента, если передали новый ИД клиента

Специальные возвращаемые коды:

Код Описание
100 Заказ не найден
101 Состояние заказа не найдено
102 Тариф не найден
103 Скидка не найдена
104 Группа экипажа не найдена
105 Служба не найдена
106 Клиент не найден
107 Изменение состояния не соответствует необходимым условиям
108 Параметр заказа не найден
109 Атрибут не может быть привязан к заказу
110 Ошибка специальной проверки заказа перед изменением. В ответе будет возвращаться:
 "data": {
   "message":"Текст ошибки для пользователя."
 }
111 Недостаточно средств на безналичном счете клиента в ТМ
112 Для клиента запрещена оплата заказа наличными. Клиент должен максимально использовать в заказе безналичную оплату (оплату с основного счета)
113 Клиент заблокирован
114 Сотрудник клиента не найден
115 Не найден клиент, который может использовать собственный счет для оплаты заказов
116 Сотрудник клиента заблокирован

Возвращаемые данные в случае успешного выполнения запроса: нет.

Пример:

POST https://ip:port/common_api/1.0/update_order HTTP/1.1
Signature: <...>
Content-Type: application/json
Content-Length: <...>

{
    "order_id": 12105,
    "phone": "555",
    "source_time": "20141216095044",
    "is_prior": true,
    "auto_select_discount": true,
    "auto_select_tariff": true,
    "auto_recalc_cost": true,
    "auto_update_order_params": true,
    "customer": "Заказчик",
    "passenger": "Пассажир",
    "comment": "Комментарий",
    "crew_group_id": 8,
    "client_id": 30,
    "tariff_id": 33,
    "addresses":[
       {"address":"SOURCE","lat":56.896817,"lon":53.147830},       
       {"address":"STOP1","lat":56.845452,"lon":53.226775},
       {"address":"STOP2"}, 
       {"address":"DESTINATION","lat":56.861230,"lon":53.241870}
    ],
    "cost_order": 200,
    "state_id": 55,
    "discount_id": 1,
    "email" : "mail@mail.ru",
    "prior_to_current_before_minutes":30,
    "flight_number":"Number",
    "need_custom_validate":false,
    "attribute_values": [
      {
            "id": 1,
            "bool_value": true
      },
      {
            "id": 2,
            "num_value": 1
      },
      {
            "id": 3,
            "num_value": 10
      },
      {
            "id": 4,
            "str_value": "строка"
      }
  ]
}

Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{}
}

Анализ телефона

Метод: GET

Название запроса: analyze_phone

Параметры:

Параметр Тип Описание
Обязательные параметры
phone Строка Номер телефона
Необязательные параметры
search_in_drivers_mobile true или false Искать среди телефонов водителей
search_in_clients true или false Искать среди телефонов клиентов
search_in_phones true или false Искать в справочнике телефонов


Если параметры search_in_drivers_mobile, search_in_clients, search_in_phones не заданы, то поиск телефона будет происходить во всех справочниках.

Специальные возвращаемые коды:

Код Описание
100 Телефон не найден

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
phone_type Строка Может принимать значения: «driver_mobile», «client», «phone».
id Целое ИД водителя, клиента, телефона из справочника.
client_employee_id Целое ИД сотрудника клиента (если телефон найден среди телефонов клиента)


Пример:

Запрос:

GET /common_api/1.0/analyze_phone?
phone=89501234567&search_in_drivers_mobile=true&search_in_drivers_home=true&search_in_clients=true&
search_in_phones=true 

Host: 127.0.0.1:8089
Keep-Alive: 300
Connection: keep-alive
Signature: 4285286a446064353f4a951b721c54f7

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
  "phone_type":"client",
  "id":1
  "client_employee_id":2
   }
}

Показать сообщение в ТМ

Метод: POST

Название запроса: show_tm_message

Параметры:

Параметр Тип Описание
Обязательные параметры
text Строка Текст сообщения
Необязательные параметры
type Строка Тип сообщения ("warning", "error", "information", "confirmation"), по умолчанию "information"
header Строка Заголовок сообщения
timeout Целое Скрывать сообщение через, сек. (0 — не скрывать)
users Массив Массив пользователей (если не указаны — отправлять всем)
Целое ИД пользователя
color Строка Цвет уведомления в формате RGB: #FFFFFF
order_id Целое ИД заказа для кнопки открытия карточки в уведомлении
car_id Целое ИД автомобиля для кнопки открытия карточки в уведомлении
driver_id Целое ИД водителя для кнопки открытия карточки в уведомлении
crew_id Целое ИД экипажа для кнопки открытия карточки в уведомлении
client_id Целое ИД клиента для кнопки открытия карточки в уведомлении


Специальные возвращаемые коды:

Код Описание
100 Пользователи для отправки сообщения не найдены


Возвращаемые данные в случае успешного выполнения запроса: нет.

Пример:


Запрос:

POST https://ip:port/common_api/1.0/show_tm_message HTTP/1.1
Signature: <...>
Content-Type: application/json
Content-Length: <...>

{
    "text": "Текст сообщения",
    "type": "warning",
    "users": [
        1,
        2,
        3
    ],
    "header": "Заголовок",
    "timeout": 12,
    "color":"#FFFF80",
    "car_id":55
}


Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{}
}

Запрос списка купленных смен водителей

Метод: GET

Название запроса: get_driver_shifts

Параметры:

Параметр Тип Описание
Обязательные параметры
start_time ГГГГММДДччммсс Начало периода
finish_time ГГГГММДДччммсс Конец периода
Необязательные параметры
driver_id Целое ИД водителя
new_shifts true или false Включить в ответ новые смены (по умолчанию true)
in_work_shifts true или false Включить в ответ смены в работе (по умолчанию true)
finished_shifts true или false Включить в ответ выполненные смены (по умолчанию true)
failed_shifts true или false Включить в ответ неуспешно завершенные смены (по умолчанию true)
returned_shifts true или false Включить в ответ возвращенные смены (по умолчанию false)

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
shifts Массив Массив купленных смен
• shift_id Целое ИД купленной смены
• driver_id Целое ИД водителя
•driver_name Строка ФИО водителя
• plan_shift_id Строка ИД запланированной смены
• plan_shift_name Строка Наименование запланированной смены
• plan_shift_cost Дробное Цена смены
• plan_shift_type Строка Тип смены («limited» - срочная, «unlimited» - бессрочная)
• plan_shift_start_time ГГГГММДДччммсс План-начало смены (для срочных)
• plan_shift_finish_time ГГГГММДДччммсс План-конец смены (для срочных)
• plan_shift_length Целое План продолжительность смены, ч. (для бессрочных)
• plan_shift_crew_group_id Целое ИД первой группы экипажей, которая может купить смену
• plan_shift_crew_groups Массив ИД групп экипажей, которые могут купить смену
• shift_state Строка Состояние смены («new» - новая, «in_work» - в работе, «finished» - завершена успешно, «failed» - завершена неуспешно)
• buy_time ГГГГММДДччммсс Время продажи смены водителю
• is_returned true или false Признак возвращенной смены
• return_time ГГГГММДДччммсс Время возврата смены
• orders_count Целое Количество заказов, выполненных водителем за смену
• orders_sum Дробное Сумма заказов, выполненных водителем за смену
• fact_length Дробное Фактическая продолжительность смены, ч.

Пример:

Запрос:

GET https://ip:port/common_api/1.0/get_driver_shifts?start_time=20140101101010&finish_time=20140101202020 
Signature: <...>


Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "shifts":[
      {
        "shift_id":1,
        "driver_id":1,
        "driver_name":"DRIVER_1",
        "plan_shift_id":1,
        "plan_shift_name":"PLAN_SHIFT_1",
        "plan_shift_cost":100,
        "plan_shift_type":"limited",
        "plan_shift_start_time":"20140101101010",
        "plan_shift_finish_time":"20140101101010",
        "plan_shift_length":null,
        "plan_shift_crew_group_id":1,
        "shift_state":new,
        "buy_time":"20140101101010",
        "is_returned":false,
        "return_time":null,
        "orders_count":10,
        "orders_sum":1000,
        "fact_length":1.2
      },
      {
        "shift_id":2,
        "driver_id":2,
        "driver_name":"DRIVER_2",
        "plan_shift_id":2,
        "plan_shift_name":"PLAN_SHIFT_2",
        "plan_shift_cost":200,
        "plan_shift_type":"unlimited",
        "plan_shift_start_time":null,
        "plan_shift_finish_time":null,
        "plan_shift_length":8,
        "plan_shift_crew_group_id":null,
        "shift_state":new,
        "buy_time":"20140101101010",
        "is_returned":true,
        "return_time":"20140101101010",
        "orders_count":0,
        "orders_sum":0,
        "fact_length":0
      }
    ]
  }
}

Запрос списка запланированных смен водителей

Метод: GET

Название запроса: get_driver_plan_shifts

Параметры:

Параметр Тип Описание
Обязательные параметры
start_time ГГГГММДДччммсс Начало периода (если включаем в ответ срочные смены)
finish_time ГГГГММДДччммсс Конец периода (если включаем в ответ срочные смены)
Необязательные параметры
limited_shifts true или false Включить в ответ срочные смены (по умолчанию true)
unlimited_shifts true или false Включить в ответ бессрочные смены (по умолчанию true)

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
plan_shifts Массив Массив запланированных смен
• plan_shift_id Целое ИД запланированной смены
• plan_shift_name Строка Наименование запланированной смены
• plan_shift_comment Строка Комментарий запланированной смены
• plan_shift_cost Дробное Цена смены
• plan_shift_type Строка Тип смены («limited» - срочная, «unlimited» - бессрочная)
• plan_shift_start_time ГГГГММДДччммсс План-начало смены (для срочных)
• plan_shift_finish_time ГГГГММДДччммсс План-конец смены (для срочных)
• plan_shift_length Целое План продолжительность смены, ч. (для бессрочных)
• plan_shift_crew_group_id Целое ИД первой группы экипажей, которая может купить смену
• plan_shift_crew_groups Массив ИД групп экипажей, которые могут купить смену
• max_sell_count Целое Максимальное количество продаж смены
• sold_count Целое Количество продаж смены

Пример:

Запрос:

GET https://ip:port/common_api/1.0/get_driver_plan_shifts?start_time=20140101101010&finish_time=20140101202020 
Signature: <...>


Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{
    "plan_shifts":[
      {
        "plan_shift_id":1,
        "plan_shift_name":"PLAN_SHIFT_1",
        "plan_shift_comment":"PLAN_SHIFT_COMMENT_1",
        "plan_shift_cost":100,
        "plan_shift_type":"limited",
        "plan_shift_start_time":"20140101101010",
        "plan_shift_finish_time":"20140101101010",
        "plan_shift_length":null,
        "plan_shift_crew_group_id":1,
        "max_sell_count":100,
        "sold_count":10
      },
      {
        "plan_shift_id":2,
        "plan_shift_name":"PLAN_SHIFT_2",
        "plan_shift_comment":"PLAN_SHIFT_COMMENT_2",
        "plan_shift_cost":200,
        "plan_shift_type":"unlimited",
        "plan_shift_start_time":null,
        "plan_shift_finish_time":null,
        "plan_shift_length":8,
        "plan_shift_crew_group_id":2,
        "max_sell_count":200,
        "sold_count":20
      }
    ]
  }
}

Продажа смены водителю

Метод: POST

Название запроса: driver_buy_shift

Параметры:

Параметр Тип Описание
Обязательные параметры
crew_id Целое ИД экипажа
plan_shift_id Целое ИД запланированной смены

Специальные возвращаемые коды:

Код Описание
100 Запланированная смена не найдена
101 Экипаж не найден
102 Водитель не найден
103 Недостаточно денег на счете водителя
104 Водитель уволен либо заблокирован
105 Запланированная смена устарела
106 Не подходит группа экипажа
107 Превышено максимальное число покупок смены
108 Повторная покупка смены
109 Экипажу не назначен атрибут для доступа к смене


Возвращаемые данные в случае успешного выполнения запроса: нет.

Пример:

Запрос:

POST https://ip:port/common_api/1.0/driver_buy_shift 
Signature: <...>
Content-Type: application/x-www-form-urlencoded
Content-Length: 25
crew_id=1&plan_shift_id=1


Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{}
}

Сохранение отзыва клиента

Метод: POST

Название запроса: save_client_feed_back

Параметры в формате JSON:

Параметр Тип Описание
Обязательные параметры
phone Строка Телефон
rating Целое Рейтинг (от 1 до 5)
text Строка Текстовый отзыв
Необязательные параметры
order_id Целое ИД заказа
attribute_values Массив Массив значений атрибутов
• id Целое Идентификатор атрибута
• bool_value true или false Значение, если тип атрибута «Логический»
• num_value Дробное Значение, если тип атрибута:
  • «Число» (непосредственное значение)
  • «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
  • «Перечисляемый» (значение выбранного элемента перечисления)
  • «Дата» и «Дата/время» (Unix-время, всегда целое число)
• str_value Строка Значение, если тип атрибута «Строка»

Допускается указывать либо параметр rating либо text, либо оба параметра.

Специальные возвращаемые коды: нет.

Возвращаемые данные в случае успешного выполнения запроса: нет.

Пример:

Запрос:
POST /common_api/1.0/save_client_feed_back 
Host: 127.0.0.1:8090
Keep-Alive: 300
Connection: keep-alive
Content-Type: application/json
Content-Length: 72
Signature: <...>

{
  "phone":"89123456789",
  "rating":4,
  "text":"test feedback",
  "order_id":100
}
Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{}
}

Поиск экипажей по координатам

Метод: GET

Название запроса: find_crews_by_coords

Параметры:

Параметр Тип Описание
Обязательные параметры
lat Дробное Широта точки центра поиска
lon Дробное Долгота точки центра поиска
radius Дробное Радиус поиска, км или мили
Необязательные параметры
crews_without_coords true или false Искать экипажи без реальных координат по координатам стоянок
crews_release_in Целое Допустимое время до освобождения в зоне поиска, если надо возвращать занятые экипажи (если 0, то искать только свободные экипажи), мин
crew_group_id Целое ИД группы экипажей, заказы из которой должны видеть подходящие экипажи
uds_id Целое ИД службы ЕДС, к которой должны принадлежать подходящие экипажи
attributes Строка Список ИД атрибутов заказа, которыми должны обладать подходящие экипажи (через точку с запятой, пример: «1;2;3»). Устарело. Рекомендуется использовать параметр attribute_values.
attribute_values Массив Массив значений атрибутов
• id Целое Идентификатор атрибута
• bool_value true или false Значение, если тип атрибута «Логический»
• num_value Дробное Значение, если тип атрибута:
  • «Число» (непосредственное значение)
  • «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
  • «Перечисляемый» (значение выбранного элемента перечисления)
  • «Дата» и «Дата/время» (Unix-время, всегда целое число)
• str_value Строка Значение, если тип атрибута «Строка»

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
waiting_count Целое Количество свободных экипажей в зоне поиска
on_order_count Целое Количество занятых экипажей, освобождающихся в зоне поиска

Пример:

Запрос:
GET https://ip:port/common_api/1.0/find_crews_by_coords?
lat=11.111111&lon=22.222222&radius=2&crews_release_in=5 
Signature: <...>
Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{
  "waiting_count":5,
  "on_order_count":2
  }
}

Подбор тарифа для заказа

Метод: POST

Название запроса: select_tariff_for_order

Параметры в формате JSON:

Параметр Тип Описание
Необязательные параметры
client_id Целое ИД клиента
crew_group_id Целое ИД группы экипажей
uds_id Целое ИД службы ЕДС
source_time ГГГГММДДччммсс Время подачи
is_prize true или false Призовой заказ
addresses Массив Массив координат адресов. Первый элемент — адрес подачи,

последний — адрес назначения, между ними — остановки. Заполняется если определены координаты всех адресов.

• lon Дробное Долгота адреса
• lat Дробное Широта адреса

Специальные возвращаемые коды:

Код Описание
100 Клиент не найден

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
tariff_id Целое Тариф

Пример:

Запрос:
POST https://ip:port/common_api/1.0/select_tariff_for_order 
Signature: <...>
Content-Type: application/json
Content-Length: <...>
{
  "client_id":1,
  "crew_group_id":2,
  "source_time":"20160101100000",
  "is_prize":true
 "addresses": [
      {
            "lat": 11.111111,
            "lon": 22.222222
      },
      {
            "lat": 33.333333,
            "lon": 44.444444
 }
}
Ответ:
{
  "code":0,
  "descr":"OK",
  "data":{
  "tariff_id":2
 }
}

Импорт марок автомобилей в БД

Метод: POST

Название запроса: import_car_marks

Параметры в формате JSON:

Параметр Тип Описание
Обязательные параметры
marks Массив строк Импортируемые марки автомобилей

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример:

Запрос: 

POST https://ip:port/common_api/1.0/import_car_marks 
Signature: <...> 
Content-Type: application/json 
Content-Length: <...> 
{
  "marks": [
    "Mercedes",
    "BMW"
  ]
 } 

Ответ:

 {
  "code":0,
  "descr":"OK",
  "data":{}
 }

Импорт цветов автомобилей в БД

Метод: POST

Название запроса: import_car_colors

Параметры в формате JSON:

Параметр Тип Описание
Обязательные параметры
colors Массив строк Импортируемые цвета автомобилей

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример:

Запрос: 

POST https://ip:port/common_api/1.0/import_car_colors 
Signature: <...> 
Content-Type: application/json 
Content-Length: <...>

 {
  "colors": [
    "красный",
    "синий"
  ]
 }

 Ответ:

 {
  "code":0,
  "descr":"OK",
  "data":{}
 }

Запрос информации по сотруднику клиента

Метод: GET

Название запроса: get_client_employee_info

Параметры:

Параметр Тип Описание
Обязательные параметры
client_employee_id Целое ИД сотрудника клиента

Специальные возвращаемые коды:

Код Описание
100 Не найден сотрудник клиента ИД=CLIENT_EMPLOYEE_ID

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
client_employee_id Целое ИД сотрудника
client_id Целое ИД клиента
name Строка ФИО сотрудника
is_deleted true или false Признак удаленного сотрудника
email Строка E-mail
use_email_informing true или false Использовать E-mail для отправки уведомлений по заказу
default_crew_group Целое Группа экипажей по умолчанию
phones Массив Массив телефонов сотрудника клиента
• phone Строка Номер телефона сотрудника

Пример:

Запрос:

GET https://ip:port/common_api/1.0/get_client_employee_info?client_employee_id=10 
Signature: <...> 

Ответ:

 {
  "code":0,
  "descr":"OK",
  "data":{
     "client_employee_id":5,
    "client_id":1,
    "name":"Иванов Иван",
    "is_deleted":false,
    "email":"mail@mail.ru",
    "use_email_informing":true,
    "default_crew_group":1,
    "phones":[
      {
        "phone":"88"
      },
      {
        "phone":"99"
      }
    ]
  }
 }

Создание сотрудника клиента

Метод: POST

Название запроса: create_client_employee

Параметры в формате JSON:

Параметр Тип Описание
Обязательные параметры
client_id Целое ИД клиента
name Строка ФИО сотрудника
Необязательные параметры
email Строка E-mail
use_email_informing true или false Использовать E-mail для отправки уведомлений по заказу
phones Массив Массив телефонов сотрудника
• phone Строка Номер телефона

Специальные возвращаемые коды:

Код Описание
100 Клиент с ИД=CLIENT_ID не найден
101 Клиент с ИД=ID имеет такой же номер телефона=PHONE

Возвращаемые данные в случае успешного выполнения запроса: нет.

Пример:

Запрос: 

POST https://ip:port/common_api/1.0/create_client_employee 
Signature: <...> 
Content-Type: application/json 
Content-Length: 104

{
  "client_id":10
  "name":"Иванов Иван",
  "email":"mail@mail.ru",
  "use_email_informing":true,
  "phones":[
    {
      "phone":"79999999999",
    },
    {
      "phone":"79999999999",
    }
  ]
 }

 Ответ:
 {
  "code":0,
  "descr":"OK",
  "data":{}
 }

Обновление информации о сотруднике клиента

Метод: POST

Название запроса: update_client_employee_info

Параметры в формате JSON:

Параметр Тип Описание
Обязательные параметры
client_employee_id Целое ИД редактируемого сотрудника клиента
Необязательные параметры
name Строка ФИО сотрудника
is_deleted true или false Признак удаленного сотрудника
email Строка E-mail
use_email_informing true или false Использовать E-mail для отправки уведомлений по заказу
phones Массив Массив телефонов сотрудника
• phone Строка Номер телефона

Примечание: запрещено редактировать телефоны удаленного сотрудника.


Специальные возвращаемые коды:

Код Описание
100 Сотрудник с ИД=CLIENT_EMPLOYEE_ID не найден
101 Клиент с ИД=ID имеет такой же номер телефона=PHONE
102 Запрещено редактирование телефонов удаленного сотрудника

Возвращаемые данные в случае успешного выполнения запроса: нет.

Пример:

Запрос: 

POST https://ip:port/common_api/1.0/update_client_employee_info 
Signature: <...> 
Content-Type: application/json
Content-Length: 104

{
  "client_employee_id":10
  "name":"Иванов Иван",
  "is_deleted":false,
  "email":"mail@mail.ru",
  "use_email_informing":true,
  "phones":[
    {
      "phone":"79999999999",
    },
    {
      "phone":"79999999999",
    }
  ]
 } 

Ответ:
 {
  "code":0,
  "descr":"OK",
  "data":{}
 }

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

Метод: GET

Название запроса: get_order_states_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
order_params Массив Список параметров заказа
• id Целое ИД параметра
• name Строка Название параметра
• state_type Строка Тип состояния. Может принимать значения:

• "accepted" — заказ принят

• "in_work" — заказ в работе

• "finished" — заказ выполнен

• "aborted" — заказ прекращен

Пример:

Запрос:


GET https://ip:port/common_api/1.0/get_order_states_list 

Signature: <...>

Ответ:


{
 "code":0,
 "descr":"OK",
 "data":{
 "order_params":[
     {
      "id":1,
      "name":"Принят",
      "state_type":"accepted"
     },
     {
      "id":2,
      "name":"В работе",
      "state_type":"in_work"
      },
     ...
                ]
        }
}

Запрос списка состояний экипажа

Метод: GET

Название запроса: get_crew_states_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
order_params Массив Список параметров заказа
• id Целое ИД параметра
• name Строка Название параметра
• state_type Строка Тип состояния. Может принимать значения:

• "waiting" — экипаж свободен

• "not_available" — экипаж не на линии

• "on_order" — экипаж на заказе

• "on_break" — экипаж на перерыве

Пример:

Запрос:
GET https://ip:port/common_api/1.0/get_crew_states_list 
Signature: <...>

Ответ:
{
 "code":0,
 "descr":"OK",
 "data":{
 "order_params":[
         {
          "id":1,
          "name":"Свободен",
          "state_type":"waiting"
         },
         {
          "id":2,
          "name":"Не работает",
          "state_type":"not_available"
         },
         ...
               ]
        }
}


Запрос глобальных атрибутов

Метод: GET

Название запроса: get_global_attributes

Версия ТМ: 3.9

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
global_attributes Массив Массив значений глобальных атрибутов
• id Целое Идентификатор атрибута
• bool_value true или false Значение, если тип атрибута «Логический»
• num_value Дробное Значение, если тип атрибута:
  • «Число» (непосредственное значение)
  • «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
  • «Перечисляемый» (значение выбранного элемента перечисления)
  • «Дата» и «Дата/время» (Unix-время, всегда целое число)
• str_value Строка Значение, если тип атрибута «Строка»

Пример:

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

GET https://ip:port/common_api/1.0/get_global_attributes

Пример ответа:

{
  "code":0,
  "descr":"OK",
  "data":{
    "global_attributes":[
      {
        "id":123,
        "bool_value":true
      },
      {
        "id":124,
        "num_value":314
      },
      {
        "id":125,
        "str_value": "AAA"
      }
    ]
  }
}

Изменение глобального атрибута

Метод: POST

Название запроса: update_global_attribute

Версия ТМ: 3.9

Параметры в формате JSON:

Параметр Тип Описание
Обязательные параметры
id Целое ИД изменяемого атрибута
Необязательные параметры
bool_value true или false Значение, если тип атрибута «Логический»
num_value Дробное Значение, если тип атрибута:
  • «Число» (непосредственное значение)
  • «Число (выбор из списка)» (непосредственное значение выбранного элемента списка)
  • «Перечисляемый» (значение выбранного элемента перечисления)
  • «Дата» и «Дата/время» (Unix-время, всегда целое число)
str_value Строка Значение, если тип атрибута «Строка»

Специальные возвращаемые коды:

Код Описание
100 Атрибут не найден
101 Атрибут не глобальный

Возвращаемые данные в случае успешного выполнения запроса: нет.

Пример:

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

POST https://ip:port/common_api/1.0/update_global_attribute HTTP/1.1
Signature: <...>
Content-Type: application/json
Content-Length: <...>

{
  "id": 12,
  "bool_value": true
}

Пример ответа:

{
  "code":0,
  "descr":"OK",
  "data":{}
}

Создание резервирования автомобиля

Метод: POST

Название запроса: create_car_reservation

Версия ТМ: 3.9.46

Параметры в формате JSON:

Параметр Тип Описание
Обязательные параметры
car_id Целое ИД автомобиля
driver_id Целое ИД водителя
car_reservation_type_id Целое ИД типа резервирования
start_time ГГГГММДД

или

ГГГГММДДччммсс

Дата или дата/время начала.

Если указывается дата без времени, то планируемое время начала резервирования устанавливается исходя из времени начала, указанного в соответствующем типе резервирования

Необязательные параметры
finish_time ГГГГММДДччммсс Время окончания резервирования. Если не указано, рассчитывается на основании времени планируемого начала резервирования и продолжительности резервирования, указанного в соответствующем типе резервирования
comment Строка Комментарий

Специальные возвращаемые коды:

Код Описание
100 Не найден автомобиль
101 Не найден водитель
102 Не найден тип резервирования
103 Время начала резервирования должно быть меньше времени завершения
104 Автомобиль уже зарезервирован в указанный период времени
105 Водитель уже имеет зарезервированный автомобиль в указанный период времени

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
car_reservation_id Целое ИД резервирования
Пример запроса:

POST https://ip:port/common_api/1.0/create_car_reservation HTTP/1.1
Signature: <...>
Content-Type: application/json
Content-Length: <...>

{
  "car_id": 1,
  "driver_id": 1,
  "car_reservation_type_id": 1,
  "start_date": "20201231",
  "comment": "COMMENT" 
}

Пример ответа:

{
  "code": 0,
  "descr": "OK",
  "data": {
    "car_reservation_id": 5
  }
}

Создание недоступности автомобиля

Метод: POST

Название запроса: create_car_inaccessibility

Версия ТМ: 3.9.46

Параметры в формате JSON:

Параметр Тип Описание
Обязательные параметры
car_id Целое ИД автомобиля
car_inaccessibility_type_id Целое ИД типа недоступности
start_time ГГГГММДДччммсс Время начала
Необязательные параметры
finish_time ГГГГММДДччммсс Время завершения
comment Строка Комментарий

Специальные возвращаемые коды:

Код Описание
100 Не найден автомобиль
101 Не найден тип недоступности
102 Время начала недоступности должно быть меньше времени завершения

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
car_inaccessibility_id Целое ИД недоступности
Пример запроса:

POST https://ip:port/common_api/1.0/create_car_inaccessibility HTTP/1.1
Signature: <...>
Content-Type: application/json
Content-Length: <...>

{
  "car_id": 1,
  "car_inaccesibility_type_id": 1,
  "start_time": "20201231235959",
  "finish_time": "20210101050000",
  "comment": "COMMENT" 
}

Пример ответа:

{
  "code": 0,
  "descr": "OK",
  "data": {
    "car_inaccessibility_id": 5
  }
}

Вызвать системное событие

Метод: POST

Название запроса: run_system_event

Версия ТМ: 3.10

Параметры в формате JSON:

Параметр Тип Описание
Обязательные параметры
system_event_id Целое ИД системного события с типом "По запросу CommonAPI"
Необязательные параметры
Произвольный параметр любой В запросе можно передавать дополнительные произвольные параметры с любыми названиями и значениями. Эти параметры могут использоваться в системном событии.

Специальные возвращаемые коды:

Код Описание
100 У системного события тип не "По запросу CommonAPI"
101 Системное событие не найдено
102 Системное событие не активно

Возвращаемые данные в случае успешного выполнения запроса: нет.

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

POST https://ip:port/common_api/1.0/run_system_event HTTP/1.1
Signature: <...>
Content-Type: application/json
Content-Length: <...>

{
  "system_event_id": 123,
  "custom_param_1": true
  "custom_param_2": 123,
  "custom_param_3": 123.45,
  "custom_param_4": "aaa" 
}

Пример ответа:

{
  "code":0,
  "descr":"OK",
  "data":{}
}

Проверить штраф клиента за отмену заказа

Метод: GET

Название запроса: check_cancel_order_penalty

Версия ТМ: 3.11

Параметры в формате JSON:

Параметр Тип Описание
Обязательные параметры
order_id Целое ИД заказа
cancel_order_state_id Целое ИД состояния заказа, в которое переходит заказ при отмене

Специальные возвращаемые коды:

Код Описание
100 Не найден заказ ИД=order_id
101 Не найдено состояние заказа ИД=cancel_order_state_id
102 Состояние заказа не соответствует необходимым условиям

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
cancel_order_penalty_sum Дробное Величина штрафа, которая будет начислена клиенту в случае отмены заказа или 0, если штрафа нет


Пример запроса:
GET https://ip:port/common_api/1.0/check_cancel_order_penalty?order_id=12345&cancel_order_state_id=12 HTTP/1.1
Signature: <...>

Пример ответа:
{
  "code":0,
  "descr":"OK",
  "data":{
    "cancel_order_penalty_sum":350
  }
}


Запрос трека экипажа

Метод: GET

Название запроса: get_crew_track

Версия ТМ: 3.11

Параметры:

Параметр Тип Описание
Обязательные параметры
crew_id Целое ИД экипажа
start_time ГГГГММДДччммсс Начало периода
finish_time ГГГГММДДччммсс Конец периода, должен отличаться о начала периода не более чем на 7 дней

Специальные возвращаемые коды:

Код Описание
100 Не найден экипаж ИД=crew_id
101 Задан период времени более 7 дней

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
track Массив Массив, трек экипажа за период времени
• lat Дробное Широта точки маршрута
• lon Дробное Долгота точки маршрута
• time ГГГГММДДччммсс Время данной точки
• speed Целое Скорость в данный момент, км/ч
• direction Целое Направление движения, градусы (0 - север, 90 - восток, 180 - юг, 270 - запад)


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

GET https://ip:port/common_api/1.0/get_crew_track?crew_id=1&start_time=20210911120000&finish_time=20210911130000 HTTP/1.1
Signature: <...>

Пример ответа:

{
  "code":0,
  "descr":"OK",
  "data":{
    "track": [
      {
        "lat": 11.111111,
        "lon": 22.222222,
        "time": "20210911120000",
        "speed": 123,
        "direction": 0
      }
    ]
  }
}

Создание фиксированной смены водителя

Метод: POST

Название запроса: create_fixed_driver_shift

Версия ТМ: 3.12

Параметры:

Параметр Тип Описание
Обязательные параметры
driver_id Целое ИД водителя
start_time ГГГГММДДччммсс Время начала
finish_time ГГГГММДДччммсс Время завершения

Специальные возвращаемые коды:

Код Описание
100 Не найден водитель
101 Время начала фиксированной смены должно быть меньше времени завершения
102 Создаваемая смена пересекается по времени с уже существующей сменой данного водителя

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
fixed_driver_shift_id Целое ИД фиксированной смены

Пример:

Запрос:

POST https://ip:port/common_api/1.0/create_fixed_driver_shift HTTP/1.1
Signature: <...>
Content-Type: application/json
Content-Length: <...>

{
  "driver_id": 1,
  "start_time": "20201231235959",
  "finish_time": "20210101050000"
}

Ответ:

{
  "code": 0,
  "descr": "OK",
  "data": {
    "fixed_driver_shift_id": 5
  }
}

Удаление фиксированной смены водителя

Метод: POST

Название запроса: delete_fixed_driver_shift

Версия ТМ: 3.12

Параметры:

Параметр Тип Описание
Обязательные параметры
fixed_driver_shift_id Целое ИД фиксированной смены водителя

Специальные возвращаемые коды:

Код Описание
100 Фиксированная смена водителя не найдена

Возвращаемые данные в случае успешного выполнения запроса: нет.

Пример:

Запрос:

POST https://ip:port/common_api/1.0/delete_fixed_driver_shift HTTP/1.1
Signature: <...>
Content-Type: application/x-www-form-urlencoded
Content-Length: <...>

fixed_driver_shift_id=1

Ответ:

{
  "code":0,
  "descr":"OK",
  "data":{}
}


Создание путевого листа

Метод: POST

Название запроса: create_way_bill

Версия ТМ: 3.14

Параметры:

Параметр Тип Описание
Обязательные параметры
start_time ГГГГММДДччммсс Время начала
finish_time ГГГГММДДччммсс Время завершения
driver_id Целое ИД водителя
car_id Целое ИД автомобиля
Необязательные параметры
number Строка Номер путевого листа
comment Строка Комментарий

Специальные возвращаемые коды:

Код Описание
100 Нет лицензии на использование путевых листов
101 Не найден водитель
102 Не найден автомобиль

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
way_bill_id Целое ИД созданного путевого листа

Пример:

Запрос:

POST https://ip:port/common_api/1.0/create_way_bill HTTP/1.1
Signature: <...>
Content-Type: application/json
Content-Length: <...>

{
  "number": "api_123",
  "start_time": "20230508000000",
  "finish_time": "20230509000000",
  "driver_id": 123,
  "car_id": 123,
  "comment": "Комментарий"
}

Ответ:

{
  "code": 0,
  "descr": "OK",
  "data": {
    "way_bill_id": 5
  }
}

Создание осмотра по путевому листу

Метод: POST

Название запроса: create_way_bill_check

Версия ТМ: 3.14

Параметры:

Параметр Тип Описание
Обязательные параметры
way_bill_id Целое ИД путевого листа (должен быть задан либо ИД либо номер)
way_bill_number Строка Номер путевого листа (должен быть задан либо ИД либо номер)
kind Строка Тип осмотра ("med/tech")
user_name Строка Имя пользователя
success true или false Результат осмотра
Необязательные параметры
number Строка Номер осмотра
comment Строка Комментарий

Специальные возвращаемые коды:

Код Описание
100 Нет лицензии на использование путевых листов
101 Не найден путевой лист

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример:

Запрос:

POST https://ip:port/common_api/1.0/create_way_bill_check HTTP/1.1
Signature: <...>
Content-Type: application/json
Content-Length: <...>

{
  "way_bill_id": 123,
  "number": "api_med_123",
  "kind": "med",
  "user_name": "Имя",
  "success": true,
  "comment": "Комментарий"
}

Ответ:

{
  "code": 0,
  "descr": "OK",
  "data": {}
}

Описание протокола TMTAPI Версия 1.0

Общее описание протокола

Формат запроса

TM API принимает входящие запросы по протоколу HTTPS. В URI запроса после ip адреса и порта, который будет слушать TM API, должно идти название API (tm_tapi) и версия API.

Пример:

GET https://ip:port/tm_tapi/1.0/get_info_by_phone 

Для получения данных из БД используются запросы типа GET. Для записи данных в БД используются запросы типа POST. В запросе типа GET параметры запроса передаются в URI.

Пример:

GET https://ip:port/tm_tapi/1.0/get_info_by_phone?phone=89058800565&fields=PHONE_TYPE-PHONE_
TO_DIAL&signature=661ce071eeefcb4f7fc8bc1f17bd520b 

В запросе типа POST параметры передаются в теле запроса в формате application/x-www-form- urlencoded.

Пример:

POST https://ip:port/tm_tapi/1.0/change_order_state 
Content-Type: application/x-www-form-urlencoded
Content-Length: 71

order_id=98798&need_state=12&signature=a204c50c7e48f0c6849a87485fe5e171

В любом запросе обязательно с другими полями должно передаваться поле signature. В нем передается MD5 хэш, рассчитанный для строки, которая получается сцеплением строки параметров запроса с секретным ключом. Секретный ключ задается в настройках модуля TMAPI в Такси-Мастер.

Пример:

Запрос:
GET https://ip:port/tm_tapi/1.0/get_info_by_phone?phone=89058800565&fields=PHONE_TYPE
&signature=ef17ea682d09e452af544a5758dba396 

Секретный ключ:
321

Signature = MD5("phone=89058800565&fields=PHONE_TYPE" + "321") = ef17ea682d09e452af544a5758dba396

Формат ответа

TM API всегда возвращает HTTP код 200 ОК. Результат выполнения запроса содержится в теле ответа в формате XML. Общий вид возвращаемого результата:

<response>
<code>Числовой код результата</code>
<descr>Строковое описание результата</descr>
<data>Дополнительная информация</data>
</response>

Существуют общие для всех запросов коды результатов:

Код Описание
0 Успешное выполнение запроса
1 Неизвестная ошибка
2 Неизвестный тип API
3 API отключено в настройках модуля TM API в Такси-Мастер
4 Не совпадает секретный ключ
5 Неподдерживаемая версия API
6 Неизвестное название запроса
7 Неверный тип запроса GET
8 Не хватает входного параметра (в доп. информации ответа будет название отсутствующего параметра)
9 Некорректный входной параметр (в доп. информации ответа будет название некорректного параметра)
10 Внутренняя ошибка обработки запроса

Описание запросов

Запрос информации по номеру телефона

Метод: GET

Название запроса: get_info_by_phone

Параметры:

Параметр Тип Описание
Обязательные параметры
PHONE Строка, <= 16 символов Номер телефона
FIELDS Строка Список полей, которые необходимо вернуть. Поля перечисляются через символ "-"
signature Строка Поле для проверки секретного ключа.

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса: зависит от того какие поля были переданы в поле fields.

Параметр Тип Описание
PHONE_TYPE Целое Тип телефона звонящего:

1 - если звонит водитель с основного телефона;

2 - если звонит физическое лицо;

3 - если звонит юридическое лицо;

4 - если звонит номер из справочника Телефоны;

5 - если звонит водитель с неосновного телефона;

6 - если звонит ЦОЗ водитель;

0 - неизвестный номер.

PHONE_TO_DIAL Строка, <= 16 символов Номер телефона для отзвона по заказу
CREW_ID Целое ИД экипажа
IS_PRIOR 0 или 1 (false или true) Признак предварительного заказа
IS_PRIZE 0 или 1 (false или true) Признак призового заказа
ORDER_CLIENT_ID Целое ИД клиента из заказа
DRIVER_PHONE Строка, <= 16 символов Номер телефона водителя
CREW_SYSTEMSTATE Целое Состояние экипажа
CLIENT_ID Целое ИД клиента
CLIENT_TYPE Целое Тип клиента
CATEGORYID Целое ИД категории телефона
PHONE_SYSTEM_CATEGORY Целое Системное значение категории телефона (0 - обычный, 1 - черный, 2 - белый, 3 - серый)
ORDER_ID Целое ИД заказа
DRIVER_ID Целое ИД водителя
ORDER_STATE Целое Состояние заказа
DRIVER_REMAINDER Дробное Баланс счета водителя
DISCOUNTEDSUMM Строка Сумма заказа с учетом всех скидок
CREW_GROUP_ID Целое ИД группы экипажа (если в заказе указан экипаж, то берется ИД группы экипажа, если нет — из карты заказа)
FIRST_CREW_GROUP_ID Целое ИД первой группы экипажа
CLIENT_BALANCE Дробное Баланс клиента
DRIVER_TIMECOUNT Целое Время пути водителя до адреса подачи в минутах
SOURCE_TIMECOUNT Целое Время оставшееся до подачи в минутах
GOSNUMBER Строка Государственный номер автомобиля
CAR_COLOR Строка Цвет автомобиля
CAR_MARK Строка Марка автомобиля
CAR_MODEL Строка Модель автомобиля
ORDER_COORDS Строка Координаты места подачи. Порядок координат: долгота адреса, широта адреса.
CREW_COORDS Строка Координаты назначенного экипажа. Порядок координат: долгота адреса, широта адреса.
MARKET_TYPE Целое Тип биржи заказов (2 — Яндекс, 3 — ЦОЗ).
ORDERS_COUNT Целое Для телефона клиента — количество текущих и предварительных заказов по телефону; для телефона водителя — количество текущих заказов, на которые назначен данный водитель
CLIENT_GROUP_ID Целое ИД группы клиента
CLIENT_BONUS_BALANCE Дробное Бонусный баланс клиента
AD_LIGHTHOUSE Строка Признак наличия шашек. Пустая строка – номер клиента или водителя без экипажа. 1 – есть шашки, 0 – нет шашек.
CREW_STATE Целое Состояние экипажа.
SOURCE_TIME ГГГГММДДччммсс Дата и время подачи
DRV_SHIFT_START_TIME ГГГГММДДччммсс Начало фактической смены водителя
START_USER_SIP_ACCOUNTS Строка Список логинов SIP–аккаунтов пользователя, принявшего заказ
CREATION_WAY Строка Способ создания заказа (operator, sms, market, common_api, t_api, taxophone, driver, daily_order, taxophone_web, unknown)
CREATOR_TAXI_PHONE Строка Телефон службы-создателя для заказов, принятых из ЦОЗ
PERFORMER_TAXI_PHONE Строка Телефон службы-исполнителя для заказов, отданных в ЦОЗ
CLIENT_IS_LOCKED 0 или 1 (false или true) Признак блокировки клиента

Пример:

Запрос:
GET https://ip:port/tm_tapi/1.0/get_info_by_phone?phone=89058800565l&fields=PHONE_TYPE-PHONE_
TO_DIAL-CREW_ID-ORDER_ID&signature=d35ab2765f2968d48c096d5f5327db26 

Ответ:

<response>
  <code>0</code>
  <descr>OK</descr>
  <data>
    <PHONE_TYPE>0</PHONE_TYPE>
    <PHONE_TO_DIAL></PHONE_TO_DIAL>
    <CREW_ID>3</CREW_ID>
    <ORDER_ID>6</ORDER_ID>
    <SOURCE_TIME>20140929134911</SOURCE_TIME>
    <DRV_SHIFT_START_TIME>20141007105050</DRV_SHIFT_START_TIME>
  </data>
</response>

Запрос информации по ИД заказа

Метод: GET

Название запроса: get_info_by_order_id

Параметры:

Параметр Тип Описание
Обязательные параметры
ORDER_ID Целое ИД заказа
FIELDS Строка Список полей, которые необходимо вернуть. Поля перечисляются через символ "-"
signature Строка Поле для проверки секретного ключа

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса: зависит от того какие поля были переданы в поле fields.

Параметр Тип Описание
DRIVER_TIMECOUNT Строка, <= 16 символов Время до подачи в минутах, указанное водителем
CAR_MARK Строка Марка автомобиля
CAR_MODEL Строка Модель автомобиля
CAR_COLOR Строка Цвет автомобиля
GOSNUMBER Строка Государственный номер автомобиля
CREW_GROUP_ID Целое ИД группы экипажа (значение из карты заказа)
FIRST_CREW_GROUP_ID Целое ИД первой группы экипажа
IS_PRIOR 0 или 1 (false или true) Признак предварительного заказа
IS_PRIZE 0 или 1 (false или true) Признак призового заказа
DISCOUNTEDSUMM Строка Сумма заказа с учетом всех скидок
DRIVER_PHONE Строка, <= 16 символов Номер телефона водителя
CATEGORYID Целое ИД категории телефона
SOURCE_TIMECOUNT Целое Время до подачи в минутах
ORDER_COORDS Строка Координаты места подачи. Порядок координат: долгота адреса, широта адреса.
CREW_COORDS Строка Координаты назначенного экипажа. Порядок координат: долгота адреса, широта адреса.
ORDER_STATE Целое ИД состояния заказа
MARKET_TYPE Целое Тип биржи заказов (3 — ЦОЗ).
AD_LIGHTHOUSE Строка Признак наличия шашек (1 – шашки есть, 0 – шашек нет).
CREW_STATE Целое Состояние экипажа
SOURCE_TIME ГГГГММДДччммсс Дата и время подачи
START_USER_SIP_ACCOUNTS Строка Список логинов SIP–аккаунтов пользователя, принявшего заказ
ORDER_PARAMS Целое Список ИД параметров заказа
CREATION_WAY Строка Способ создания заказа (operator, sms, market, common_api, t_api, taxophone, driver, daily_order, taxophone_web, unknown)
CREATOR_TAXI_PHONE Строка Телефон службы-создателя для заказов, принятых из ЦОЗ
PERFORMER_TAXI_PHONE Строка Телефон службы-исполнителя для заказов, отданных в ЦОЗ

Пример:

Запрос:

GET https://ip:port/tm_tapi/1.0/get_info_by_order_id?order_id=60&fields=DRIVER_SOURCETIME-MARKCOLOR-
GOSNUMBER-IS_PRIOR-MOBILE_PHONE-SOURCE_TIME&signature=fdcd04e570443b56176b83f44748dc23


Ответ:

<response>
  <code>0</code>
  <descr>OK</descr>
  <data>
    <DRIVER_SOURCETIME></DRIVER_SOURCETIME>
    <MARK></MARK>
    <COLOR></COLOR>
    <GOSNUMBER></GOSNUMBER>
    <IS_PRIOR></IS_PRIOR>
    <MOBILE_PHONE></MOBILE_PHONE>
    <SOURCE_TIME>20140929134911</SOURCE_TIME>
  </data>
</response>

Смена состояния заказа

Метод: POST

Название запроса: change_order_state

Параметры:

Параметр Тип Описание
Обязательные параметры
ORDER_ID Целое ИД заказа
NEED_STATE Целое Новое состояние заказа
signature Строка Поле для проверки секретного ключа

Специальные возвращаемые коды:

Код Описание
100 Заказ с таким ИД не найден
101 Изменение состояния не соответствует необходимым условиям

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
ORDER_ID Целое ИД заказа
NEED_STATE Целое Новое состояние заказа

Пример:

Запрос:

POST https://ip:port/tm_tapi/1.0/change_order_state 
Content-Type: application/x-www-form-urlencoded
Content-Length: 71

order_id=18561&need_state=14&signature=3e8107e0c044e55d983db1fbed82fd8c

Ответ:

<response>
  <code>0</code>
  <descr>OK</descr>
  <data>
    <ORDER_ID>18561</ORDER_ID>
    <NEW_STATE>14</NEW_STATE>
  </data>
</response>

Запись пути к файлу разговора в базу данных

Метод: POST

Название запроса: create_record_link

Параметры:

Параметр Тип Описание
Обязательные параметры
CALL_ID Строка, <= 60 символов ИД звонка (необязателен, если указан PHONE)
PHONE Строка, <= 16 символов Номер телефона (необязателен, если указан CALL_ID)
CALL_TYPE 0 или 1 0 — Исходящий, 1 — Входящий
signature Строка Поле для проверки секретного ключа
Необязательные параметры
RECORD_DATE ДДММГГГГччммсс Дата записи
RECORD_LENGTH Целое Продолжительность записи (в секундах)
FILE_PATH Строка, <=255 символов Путь к файлу записи
USER_LOGIN Строка,<=16 символов Логин оператора (внутренняя линия)
EXTERNAL_LINE Строка,<=16 символов Внешняя линия (на которую пришел входящий звонок)
TRANSFERED_TO Строка,<=30 символов Номер телефона(линии) на который(ую) был переведен звонок (доп. параметр для CALL_RESULT="transfered")
CALL_RESULT Строка Результат звонка, возможны следующие значения:
  • "success" - успешный,
  • "no_answer" - не дозвонились,
  • "answered" - ответили,
  • "missed" - пропущен,
  • "transfered" - переведен,
  • "broke_off" - сброшен,
  • "other_user_answered" - принят другим оператором.
  • Если не задан, то "success"
ORDER_ID Целое ИД заказа

Специальные возвращаемые коды: нет.

Возвращаемые данные в случае успешного выполнения запроса

Параметр Тип Описание
RECORD_ID Целое ИД созданной записи

Пример:

Запрос:

POST https://ip:port/tm_tapi/1.0/create_record_link HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Content-Length: <...>

RECORD_DATE=20130122180949&RECORD_LENGTH=215&CALL_ID=12345&PHONE=8987564&FILE_PATH=d%3A%5Ctemp%5CTM%5Ctrunk%5CSource%5CDevUtils%5CTMAPITest%5C&CALL_TYPE=1&CALL_RESULT=no_answer&signature=<...>

Ответ:
<response>
  <code>0</code>
  <descr>OK</descr>
  <data>
    <RECORD_ID>25</RECORD_ID>
  </data>
</response>

Создать новый заказ

Метод: POST

Название запроса: make_new_order

Параметры:

Параметр Тип Описание
Обязательные параметры
PHONE Строка, <= 16 символов Номер телефона
ORDER_STATE_ID Целое ИД состояния заказа
signature Строка Поле для проверки секретного ключа
Необязательные параметры
CREWGROUPID Целое ИД группы экипажа
TARIF_ID Целое ИД тарифа
DISCOUNTEDSUMM Дробное Фиксированная сумма за заказ
CUSTOMER Строка, <=80 символов Заказчик
SOURCE Строка, <=80 символов Адрес подачи
SOURCE_STREET Целое ИД улицы подачи
SOURCE_HOUSE Строка, <=10 символов Дом подачи
SOURCE_FLAT Строка, <=10 символов Квартира подачи
SOURCE_POINT Целое ИД пункта подачи
DESTINATION Строка, <=80 символов Адрес назначения
DESTINATION_STREET Целое ИД улицы назначения
DESTINATION_HOUSE Строка, <=10 символов Дом назначения
DESTINATION_FLAT Строка, <=10 символов Квартира назначения
DESTINATION_POINT Целое ИД пункта назначения
CREWID Целое ИД экипажа
SUMM Дробное Стоимость заказа без учета скидок (наценок)
STARTUSER Целое Пользователь, создавший заказ
STARTTIME ГГГГММДДччммсс Дата создания заказа
FINISHUSER Целое Пользователь, завершивший заказ
FINISHTIME ГГГГММДДччммсс Дата завершения заказа
SOURCE_ZONE Целое Район подачи
DESTINATION_ZONE Целое Район назначения
SOURCE_PARKING Целое Стоянка подачи
DESTINATION_PARKING Целое Стоянка назначения
SOURCE_TIME ГГГГММДДччммсс Дата подачи
SOURCE_COUNTRY 0 или 1 (false или true) Признак междугороднего заказа
IS_PRIOR 0 или 1 (false или true) Признак предварительного заказа
PRIZE 0 или 1 (false или true) Признак призового заказа
NOTE Строка, <=80 символов Примечание
BONUSPOINT Дробное Бонусные баллы, начисленные водителю за заказ
DISTANCE Дробное Километраж по городу (в километрах)
HOURLY_LEN Целое Длительность исполнения почасового заказа (в минутах)
HOURLY_START ГГГГММДДччммсс Дата начала отсчета при почасовом заказе
HOURLY_PAY 0 или 1 (false или true) Признак почасового заказа
PHONE_TO_DIAL Строка, <=16 символов Номер телефона для отзвона по заказу
FROMBORDER 0 или 1 (false или true) Признак заказа "с бордюра"
WAITING_START ГГГГММДДччммсс Дата начала ожидания заказчика водителем
WAITING_LENGTH Целое Общая длина периода ожидания заказчика водителем (в минутах)
BACKFREE Целое Признак применения скидки в 50% на обратный путь
INPUTTIME ГГГГММДДччммсс Дата принятия заказа (от даты создания заказа отличается тем, что может быть задана пользователем)
MONEY_RECEIVE 0 или 1 (false или true) Подтверждение принятия денег наличными
NOTIFY_BEFORE Целое Период времени, за который пользователь оповещается о наступлении даты подачи
WANTCREWID Целое ИД желаемого экипажа
DISTANCE_COUNTRY Дробное Километраж за границами города (в километрах)
DISTANCE_CHECK 0 или 1 (false или true) Разрешение ручного ввода километража
CLIENTID Целое ИД постоянного клиента
INFRA_STATE Целое Состояние заявки в исходящей компании колцентра INFRA (1 - заявка передана в исходящую компанию, 2 - отзвон успешно произведен, 3 - занято, 4 - не берут трубку)
INFRA_ORDER Целое INFRA-заказ (спец. поле для работы с колцентром компании Инфрател)

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса

Параметр Тип Описание
ORDER_ID Целое ИД созданного заказа

Пример:

Запрос:

POST https://ip:port/tm_tapi/1.0/make_new_order 
Content-Type: application/x-www-form-urlencoded
Content-Length: 206

PHONE=89058770593&ORDER_STATE_ID=10&DISCOUNTED_SUMM=100&signature=afc947f610eba380df6d0e441b03ddad

Ответ:

<response>
  <code>0</code>
  <descr>OK</descr>
  <data>
    <order_id>27</order_id>
  </data>
</response>

Поиск улицы в базе

Метод: POST

Название запроса: street_search

Параметры:

Параметр Тип Описание
Обязательные параметры
PHONE Строка, <= 16 символов Номер телефона
CALL_ID Целое ИД звонка
VOICE_STREET Строка, <= 60 символов Название улицы или пункта, полученное через преобразование голоса в текст
signature Строка Поле для проверки секретного ключа

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
CALL_ID Целое ИД звонка
PHONE Строка, <= 16 символов Номер телефона
STREET_FOUND 0 или 1 (false или true) Признак того, что улица найдена
STREET_NAME Строка, <= 60 символов Наименование улицы или пункта, найденное в базе данных


Пример:

Запрос:
POST https://ip:port/tm_tapi/1.0/street_search 
Content-Type: application/x-www-form-urlencoded
Content-Length: 175

PHONE=89058770593&CALL_ID=56&VOICE_STREET=пушкинск&FIND_STREET=0&API_FIND_STREET=&NUM_HOUSE=&signat
ure=9204a53e0f4842bb623c3a5f7683520a

Ответ:

<response>
  <code>0</code>
  <descr>OK</descr>
  <data>
    <CALL_ID>56</CALL_ID>
    <PHONE>89058770593</PHONE>
    <FIND_STREET>1</FIND_STREET>
    <API_FIND_STREET>Пушкинская</API_FIND_STREET>
  </data>
</response>

Смена состояния заказа по результату автодозвона

Метод: POST

Название запроса: set_request_state

Параметры:

Параметр Тип Описание
Обязательные параметры
STATE_ID Целое Cостояние заказа до отзвона
PHONE_TYPE 0..2 Признак, что звонили 1- клиенту, 0 – водителю, 2 -диспетчеру
ORDER_ID Целое ИД заказа
STATE Целое (0, 1, 2, 3, 4, 5) Состояние отзвона (0 – начальное, 1 — в процессе, 2 — успешно, 3 — занято, 4 — нет ответа, 5 — ошибка)
signature Строка Поле для проверки секретного ключа

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса: нет

Настройки смены состояний заказа с использованием автодозвона задаются в карточке состояний заказа.

Пример:

Запрос:
POST https://ip:port/tm_tapi/1.0/set_request_state 
Content-Type: application/x-www-form-urlencoded
Content-Length: 71

state_id=7&phone_type=1&order_id=50&state=4&signature=0eb50db401d3540e038fde68eb260333

Ответ:

<response>
   <code>0</code>
   <descr>OK</descr>
</response>

Соединить клиента и водителя

Метод: POST

Название запроса: connect_client_and_driver

Параметры:

Параметр Тип Описание
Обязательные параметры
order_id Целое ИД заказа
signature Строка Поле для проверки секретного ключа

Специальные возвращаемые коды:

Код Описание
100 Не найден заказ с таким ИД
103 В заказе нет водителя
104 У водителя не определен телефон

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример:

Запрос:

POST https://ip:port/tm_tapi/1.0/connect_client_and_driver 
Content-Type: application/x-www-form-urlencoded
Content-Length: 53

order_id=13&signature=6a4b16da44a495b67eb7af11d51954d4

Ответ:

<response>
   <code>0</code>
   <descr>OK</descr>
</response>

Количество свободных экипажей на линии

Метод: GET

Название запроса: get_free_crews_count

Параметры:

Параметр Тип Описание
Обязательные параметры
signature Строка Поле для проверки секретного ключа
Необязательные параметры
crew_group_id Целое ИД группы экипажа предполагаемого заказа
uds_id Целое ИД службы ЕДС предполагаемого заказа

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
COUNT Целое Количество свободных экипажей на линии

Пример:

Запрос:
GET https://ip:port/tm_tapi/1.0/get_free_crews_count?
crew_group_id=1&uds_id=1&signature=88ca2091061c3e90123275f2c5df55a6 
Content-Type: application/x-www-form-urlencoded
Ответ:
<response>
<code>0</code>
<descr>OK</descr>
<data>
<COUNT>5</COUNT>
</data>
</response>

Запрос пользователя по логину софтфона

Метод: GET

Название запроса: get_user_by_sip_login

Параметры:

Параметр Тип Описание
Обязательные параметры
signature Строка Поле для проверки секретного ключа
login Строка Логин SIP-аккаунта

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
ID Целое ИД пользователя, который использует указанный логин SIP-аккаунта софтфона в данный момент
NAME Строка Имя пользователя, который использует указанный логин SIP-аккаунта софтфона в данный момент

Пример:

Запрос:
GET https://ip:port/tm_tapi/1.0/get_user_by_sip_login?
login=LOGIN&signature=9b06455cdfe933e7af12a35a70e9b1c6 
Content-Type: application/x-www-form-urlencoded
Ответ:
<response>
<code>0</code>
<descr>OK</descr>
<data>
<ID>1</ID>
<NAME>ADMINISTRATOR</NAME>
</data>
</response>

Установить режим «Перерыв» для линий софтфона

Метод: POST

Название запроса: set_sip_account_dnd_mode

Параметры:

Параметр Тип Описание
Обязательные параметры
dnd Строка 0 или 1
user_login Строка Логин пользователя ТМ
lines Строка Список линий, разделенных символом «|»
signature Строка Поле для проверки секретного ключа

Специальные возвращаемые коды:

Код Описание
100 Пользователь с таким логином или линиями не найден.

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример:

Запрос:

POST https://ip:port/tm_tapi/1.0/set_sip_account_dnd_mode 
Content-Type: application/x-www-form-urlencoded
Content-Length: 66

dnd=1&user_login=USER&lines=101%7C102&signature=3e8107e0c044e55d983db1fbed82fd8c

Ответ:

<response>
  <code>0</code>
  <descr>OK</descr>
</response>

Запрос телефонов водителя по позывному экипажа

Метод: GET

Название запроса: get_driver_phones_by_crew_code

Параметры:

Параметр Тип Описание
Обязательные параметры
crew_code Строка Позывной экипажа


Специальные возвращаемые коды:

Код Описание
100 Водитель не найден

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
mobile_phone Строка Основной телефон водителя
home_phone Строка Неосновной телефон водителя

Пример:

Запрос:

GET https://ip:port/tm_tapi/1.0/get_driver_phones_by_crew_code?
crew_code=CODE&signature=6f03bc45d3aa17f7738672180a3ee5de 
Content-Type: application/x-www-form-urlencoded

Ответ:

<response>
<code>0</code>
<descr>OK</descr>
<data>
<mobile_phone>123456789</mobile_phone>
<home_phone>987654321</home_phone>
</data>
</response>

Запрос информации о ключе защиты

Метод: GET

Название запроса: get_key_info

Параметры: нет.

Специальные возвращаемые коды: нет.

Возвращаемые данные в случае успешного выполнения запроса:

Параметр Тип Описание
company_name Строка Наименование организации
company_id Целое ИД организации
tm_server_license_count Целое Количество лицензий для TMServer
tm_license_count Целое Количество лицензий для TM2
tm_terminal_license_count Целое Количество лицензий для терминала
tm_driver_server_license_count Целое Количество лицензий для TMDriverServer
tm_driver_license_count Целое Количество лицензий для водителей
tm_sms_server_license_count Целое Количество лицензий для TMSMSServer

Пример:

Запрос:
GET https://ip:port/tm_tapi/1.0/get_key_info 
Content-Type: application/x-www-form-urlencoded

signature=6f03bc45d3aa17f7738672180a3ee5de

Ответ:

<response>
<code>0</code>
<descr>OK</descr>
<data>
company_name>ООО БИТ-Мастер</company_name>
<company_id>000</company_id>
<tm_server_license_count>1</tm_server_license_count>
<tm_license_count>10</tm_license_count>
<tm_terminal_license_count>1</tm_terminal_license_count>
<tm_driver_server_license_count>1</tm_driver_server_license_count>
<tm_driver_license_count>30</tm_driver_license_count>
<tm_sms_server_license_count>1</tm_sms_server_license_count>
</data>
</response>

Пример формы для заказа такси

Download.png
Для скачивания Вы можете воспользоваться ссылкой:
http://files.bitmaster.ru/TM/forms/zakaz_taxi.zip

Приведенная форма является примером, на основе которого можно построить собственную форму для принятия интернет-заказов. Форму можно использовать либо в исходном варианте, либо применяя запросы TM API. Для того, чтобы данная форма функционировала, необходимо открыть файл в любом текстовом редакторе и указать корректные IP-адрес сервера Такси-Мастер, порт TM API и секретный ключ. Далее вам следует загрузить файл на хостинг.

Форма, представленная в примере, будет выглядеть следующим образом:

Картинка
Форма для заказа такси.jpg