TaxiMaster - Вклад участника [ru]

История изменений в программе Такси-Мастер

2014-01-20T11:44:47Z

AnnaNikolskih: /* Такси-Мастер. Версия 0.4 от 20.01.2014 */

В данной статье находится список изменений и усовершенствований, производимых в программе [[Такси-Мастер]]. Обратите пристальное внимание на историю изменений для того, чтобы быть в курсе обновления функциональной части программы для более полного и корректного ее использования.
Данный раздел не является статичным, с выпуском каждой новой версии Такси-Мастер в него будет вносится обновленный список модификаций программы, которые разрабатываются и публикуются на протяжении всего месяца.

== Такси-Мастер. Версия 0.4 от 20.01.2014 ==

=== Изменение в программном комплексе Такси-Мастер ===
# Разработано клиентское приложение для вызова такси «Таксофон»
# Произведена работа по увеличению стабильности работы TM DriverServer. Вследствие изменения архитектуры данного приложение на 64-разрядную, теперь он способен корректно работать с объемами ОЗУ свыше 2 Гб.
# Повышена скорость выборки заказов из базы данных.
# Добавлена возможность интеграции с телерациями
# Добавлена возможность подставлять текст с рекламой в исходящие SMS-сообщения клиентам путем использования тега Advt .
# Изменена логика импорта координат по средствам TMMgr для работы с системами Voyager и «Автограф». Теперь работа ведется через API-запросы.
# Изменен принцип работы с модулем SMS-Сервер. Переделена механика получения отчетов от операторов сотовой связи.
# Добавлена возможность просмотра фактического маршрута при бордюрных заказах.
# Возможность интеграции с навигационной системой СитиГИД.
# Изменен принцип блокировки заказа при редактировании его другим оператором.
# Добавлена возможность указания причины отмены Яндекс заказа.
# Добавлен запрет на восстановление удаленных заказов.
# При нажатии «тревога» водителем, окно заказов у диспетчеров теперь по-прежнему остается активным и не перебивается окном «сообщения».
# Добавлено дополнительное окно настроек «горячих клавиш».
# Возвращена возможность создания новых заказов в окне «выполненных».
# Добавлен столбец «количество отправленных смс на номер» в SMS журнал.
# Сообщение при ошибках подключения к TMServer'у больше не отображает в большом количестве экземпляров. Поток прекращается незамедлительно и программа закрывается.
# Добавлены стандартные шаблоны SMS-уведомления клиента для состояний «заказ принял», «на месте» и выполнен.
# В окне «экипажи» добавлены поля «марка автомобиля» и «модель».
# В историю заказов по номеру телефона добавлен столбец «тариф».
# Убран параметр API-ключ для онлайн-карт «Яндекс».
# В ключ защиты добавлена отдельная лицензия для сервера приложений TMServer и локального терминала
# Изменен путь по умолчанию к каталогу для создания резервных копий в утилите резервного копирования на \Backup , а не Utilities как ранее.

=== Изменения в TMDriver ===
# Добавлена возможность печати чека в TMDriver для работы с bluetooth-принтерами .
# Скорректирован принцип передачи маршрута из TMDriver в навигационное приложение «Навител»
# Добавлено визуальное отображение в TMDriver безналичных и предварительных заказов.
# Добавлено звуковое оповещение у водителя при нажатии кнопки «Тревога».

=== Изменения в отчетах Такси-Мастер ===
# Добавлен фильтр для отчетов «Клиенты, завершенные заказы» исключающий заблокированных и удаленных клиентов.

=== Изменения в модуле интеграции с локальными терминалами ===
# Добавлено логирование для операций в локальном терминале.
# При обрыве связи локального терминала с сервером, платежи сохраняются в буфере для последующей обработки при восстановлении связи.

== Такси-Мастер. Версия 0.3 от 16.08.2013 ==

=== Изменение в программном комплексе Такси-Мастер ===
# Добавлена возможность экспортировать [[Окно «Заказы» в Такси-Мастер|заказы]] и [[Справочник «Экипажи»|экипажи]] в отдельный текстовый документ формата .csv
# Настроена система автоматического обновления списков информации в журналах и справочниках. Теперь вы сможете самостоятельно задавать настройки обновления данных с помощью включения\отключения параметра {{checkbox|Автоматически обновлять все списки}} в [[Параметры Такси-Мастер|меню «Настройки»]].
# Создан механизм фильтрации данных по номерам телефонов в [[Справочник «Телефоны»|справочнике «Телефоны»]] и имени водителя в [[Справочник «Водители»|справочнике «Водители»]].
# В название дистрибутива программы [[Такси-Мастер]] возвращена версия [[База данных Такси-Мастер|базы данных]].
# Теперь при [[Установка Такси-Мастер|установке клиентской]] части из дистрибутива, мастер установки не будет спрашивать путь к папке с базой данных. Эта информация будет автоматически передаваться из [[TMServer]].
# Переименованы кнопки отправки сообщений в выпадающем меню списка Окно [[«Экипажи» в Такси-Мастер|«Экипажи на линии»]]. Теперь они значатся как «Отправить СМС водителю» и «Отправить сообщение водителю», а не «Отправить Java-сообщение».
# У каждой [[Справочник «Категории телефона»|категории телефона]] параметр {{checkbox|Использовать призовую статистику}} теперь установлен по умолчанию.
# Добавлено резервное сохранение [[Справочник «Статистика по телефонам»|статистики по телефонам]] в виде текстового файла при сбросе данной статистики в программе Такси-Мастер.
# В списке текущих заказов название столбца {{tab|Сумма со скидкой}} заменено на {{tab|Итоговая сумма}}.
# Исправлена ошибка, при которой в справочнике «Экипажи» у поля «Идентификатор» появлялось пустое всплывающее меню.
# Проведена работа по актуализации текстовых данных в соответствии с обновлениями системы Такси-Мастер: название компонента TMAssistant везде заменено на [[TMServer]].
# Отлажена система работы параметра {{checkbox|Использовать списки улиц и пунктов из справочников, а не карты}}. Теперь при включении данной функции адреса будут определяться только по тем данным, которые присутствуют в справочниках, а не на [[Модуль «Интеграция с картами»|карте]].
# Теперь цвет позывного экипажа на карте будет соответствовать его положению во время работы: на заказе – красный цвет, свободен – зеленый, а если экипаж находится на обеде, то его позывной будет отображаться в желтом цвете.
# Пополнять счета водителей теперь можно и с помощью шаблонов, заданных в [[Справочник «Шаблоны операций»|справочнике «Шаблоны операций»]].
# Теперь [[Модуль интеграции с платежными системами|модуль «Платежные системы»]] добавляется в [[Ключ защиты|ключ]] при любой прошивке по умолчанию.
# Теперь TMGuard будет выполнять автоматический перезапуск сервера ключа защиты в случае неработоспособности TMServer.
# Создана утилита TMGuard, контролирующая и восстанавливающая все серверы после штатного или внештатного завершения работы системы Такси-Мастер.
# Утилита TMGuard теперь запускается как приложение и открывается через трей компьютера, на котором запущена. При этом при наведении курсора на трей во всплывающей подсказке утилиты отображается информация о том, какие серверы находятся под защитой.
# В TMServer добавлена настройка, с помощью которой при минимизации данного сервиса он будет сворачиваться в трей.
# В [[Журнал работы Такси-Мастер|журнале работы Такси-Мастер]] теперь отображается информация об отсутствии необходимости в [[Обновление Такси-Мастер|обновлении системы]].
# В меню импорта [[Отчеты Такси-Мастер|отчетов]] добавлены кнопки «Выделить все» и «Снять выделение».
# Удалена утилита «Сбор информации о системе».
# В мастер установки добавлена возможность самостоятельно создавать ярлыки на файлы и изменять содержимое существующих.
# В TMServer добавлен тест на проверку создания и редактирования заказа.
# Теперь TMServer выполняет функционал утилиты tmom2.exe.
# Теперь при входящем в [[ТМСофтфон]] звонке в карточке заказа автоматически будет прописываться имя заказчика, если его номер телефона занесен в базу данных.
# Добавлено извлечение служебной информации из SIP-пакетов [[Call-центр Oktell|call-центра Oktell]] с целью грамотного составления журнала звонков.

=== Изменения в демо-версии программы Такси-Мастер ===

# При начале работы с дистрибутивом [[Демо-версия Такси-Мастер|демо-версии Такси-Мастер]] автоматически будет открываться офлайн-страница с инструкцией по установке.
# При деинсталляции дистрибутива демо-версии Такси-Мастер в папке с удаленными файлами будет оставаться только накопленная база данных.
# При установке демо-версии программы Такси-Мастер вам будет необходимо только задать путь к [[База данных Такси-Мастер|базе данных]], остальные настройки будут прописаны автоматически.
# После установки демо-версии программы Такси-Мастер и перезагрузки компьютера, TMServer запустится автоматически.
# В демо-версии Такси-Мастер TMServer будет автоматически запускаться при открытии tme.exe в том случае, если не был запущен до этого момента.
# В мастере установки демо-версии программе Такси-Мастер добавлена регулируемая настройка «Запустить Такси-Мастер» сразу же после окончания его установки.
# При установке демо-версии на форме лицензионного соглашения курсор автоматически фиксируется на кнопке «Да».
# При повторной установке демо-версии программы Такси-Мастер все запущенные процессы программы будут закрываться автоматически.
# В демо-версии программы Такси-Мастер в окне входа был удален индикатор доступности ключа защиты, а также кнопка [[Вход в Такси-Мастер|настроек входа]].
# При установке демо-версии программы Такси-Мастер теперь появляется оповещение об автоматическом обновлении [[Firebird]], который находится внутри дистрибутива демо-версии.

=== Изменения в модуле интеграции с картами ===

# Изменены цвета [[Карта в польском формате|карты в польском формате]]. Теперь работать с основной картой стало куда проще и приятнее, так как теперь в ее оформлении отсутствуют цвета, вызывающие напряжение.

=== Изменение в TM API\TMTAPI ===

# В запрос get_client_info добавлено поле "Баланс клиента"
# В TMCommonAPI в запрос тарифов get_client_info добавлено поле "Баланс клиента"
# В [[TM API|TMTAPI]] в запрос get_info_by_order_id добавлена переменная, возвращающая ID состояния заказа.
# В TMCommonAPI добавлены методы работы с личными данными клиентов

=== Изменения в TMDriver ===

# В [[TMDriver]] улучшена система уведомления водителей о новых заказах: теперь при поступлении нового заказа на стоянку, она будет мигать определенным цветом.
# В [[TMDriver для Android]] добавлен учет районов и проездов между районами.

=== Изменения в сервере связи с водителями ===

# Теперь в [[Сервер связи с водителями|сервере связи с водителями]] отображается не количество подключений, а количество занятых на текущей момент лицензий.
# Добавлены запросы-пинги в API для центра обмена заказами и Яндекса.

=== Изменения в модуле интеграции с локальными терминалами ===
# Интерфейс модуля [[Модуль интеграции с локальными терминалами|интеграции с локальными терминалами]] был доработан и модифицирован. Также были отлажены все процессы при работе данного модуля и доведены до полного автоматизма.
# Изменен механизм системы проверки [[Ключ защиты|ключа защиты]] для локальных терминалов.

== Такси-Мастер. Версия 0.3 от 16.05.2013 ==

=== Изменения с модуле интеграции с телефонией Oktell ===
# Воспроизведение записи разговора с клиентом теперь будет производиться с помощью виртуальной звуковой карты с любого рабочего места, то есть аудиофайл будет проигрываться через плеер, который по умолчанию установлен в ОС Windows.
# Реализована функция перемотки записи разговора в карточке заказа на любую позицию и сохранение записи на жесткий диск.
# Полностью изменен [[Журнал звонков (модуль «Средства связи»)|журнал звонков]]: теперь ведется единый журнал для сбора статистики, изменен интерфейс, а также доработан фильтр задания периода.

=== Изменение в программном комплексе Такси-Мастер ===
# Устранены грамматические и орфографические ошибки.
# У каждой [[Справочник «Категории телефона»|категории телефона]] теперь по умолчанию установлен флажок {{checkbox|Использовать призовую статистику}}.
# Добавлена проверка на наличие одинаковых номеров в [[Справочник «Телефоны»|справочнике «Телефоны»]] с целью избежания повторения одного телефонного номера у нескольких клиентов.
# Добавлено резервное сохранение в текстовый файл [[Справочник «Статистика по телефонам»|статистики по телефонам]] при ее обнулении.
# Изменена система сохранения статистики по [[Призовой заказ|призовым заказам]]: создан абсолютно новый счетчик, с помощью которого призовая статистика будет начисляться для всех клиентов (даже для тех, номеров которых нет в [[Справочник «Телефоны»|справочнике «Телефоны»]]) за исключением случаев, когда ведение статистики запрещено системой.
# Вся история работы с сервером Guardant теперь ведется в файлах с расширением .log.
# В карточке [[Справочник «Сдачи с заказов»|справочника «Сдачи с заказов»]] добавлен флажок {{checkbox|Депремировать за невыполнение смены}}.
# Исправлена ошибка, из-за которой было невозможно в карточке заказа использовать списки улиц из [[Справочник «Улицы»|одноименного справочника]].
# Введена возможность отмены подготовки списка [[Справочник «Дисконтные карты»|дисконтных карт]].
# Теперь водитель будет автоматически регистрироваться на [[Окно «Стоянки» в Такси-Мастер|стоянке]] адреса подачи в случае, если в карточке заказа установлен флажок {{checkbox|Обратно}}.
# Теперь в [[Справочник «Автомобили»|карточку нового автомобиля]] можно добавлять информацию по номеру кузова машины, номеру двигателя и VIN.
# Теперь в [[Справочник «Водители»|карточку нового водителя]] можно добавлять информацию по паспортным данным водителя и номеру водительского удостоверения.
# Раскраска позывных экипажей на карте совпадает с раскраской, заданной в [[Окно «Экипажи» в Такси-Мастер|окне «Экипажи» в Такси-Мастер]].
# Добавлен функционал для обработки платежей с использованием банковских карт.
# Возвращена возможность увольнять водителей по причине их долгого отсутствия на линии.
# Улучшена работоспособность системы в [[Модуль расчетов с водителями в Такси-Мастер|окне операций]] при переходе между водителями.
# В [[окно «Заказы» в Такси-Мастер]] добавлен столбец {{tab|Дисконтная карта}}, в котором будет отображаться информация по дисконтной карте клиента.
# Теперь в [[Вход в Такси-Мастер|окне входа Такси-Мастер]] отсутствует настройка пути для подключения к базе данных. Данный путь программа будет получать от [[TMServer]].
# В [[Такси-Мастер Start]] добавлен [[справочник «Группы экипажей»]].
# Если при вводе нового телефона в программу вы не определите его категорию, то по умолчанию он будет автоматически попадать в группу {{tab|Обычные}}.
# В [[Справочник «Шаблоны операций»|справочнике «Шаблоны операций»]] теперь все поля являются обязательными к заполнению, кроме поля {{поле|Примечания}}.
# В [[справочник «Автомобили»]] добавлены новые модели машин: "Лада Ларгус" и "Шкода Октавиа"
# В [[Справочник «Признаки экипажей»|справочнике «Признаки экипажей»]] поле {{поле|Тип}} заменено на общую настройку, которая имеет название {{поле|Признак экипажа, разрешающий работу с заказами, в которых указан клиент}}.
# В окно {{окно|Водители - Пополнить счет}} добавлена возможность использовать [[Справочник «Шаблоны операций»|шаблоны операций]].
# Во всей программе Такси-Мастер кнопка {{button|Период}}, с помощью которой задавались рамки временного отрезка, за который необходимо просмотреть информацию, изменена на два поля с указанием даты и времени непосредственно в списках.
# Теперь в [[TMDriver]] не передаются тарифы не активных на данный момент [[Центр обмена заказами|бирж]].
# Создана система мониторинга и оповещения клиентов о поломках в диспетчерских, реализуемая с помощью запросов-пингов в [[центр обмена заказами]] и Яндекс.Биржи.
# В [[Справочник «Тарифы»|тарифы]] добавлена информация из матрицы [[Справочник «Районы»|районов]].
# Произведен рефакторинг [[Сервер связи с водителями|сервера связи с водителями]].
# Упрощена система работы с заказами и стоянками в [[Сервер связи с водителями|сервере связи с водителями]]. Теперь можно отправлять уведомления о новых свободных заказах в разное время для разных групп экипажей\экипажей.
# В [[TMServer]] единовременное автоматическое [[Снятие средств по расписанию|списание средств]] по всем водителям заменено на выстраивание очереди списаний с целью разгрузки базы данных.
# При автоназначении экипажа на заказ, тариф будет сразу же прописываться в карточке заказа и передаваться водителю. Данная функция реализована для того, чтобы предварительно оповещать клиента о стоимости грядущего заказа.
# Все директивы [[TMServer]], при помощи которых происходит подключение [[Ключ защиты|ключа защиты]], перенесены в модуль TKeyDM.
# Настройки базы данных в TMServer теперь разделены на два поля: адрес базы данных и путь к ней. Это сделано для того, чтобы было возможно организовать файловый диалог при настройке пути, а не прописывать его вручную.
# Проверку [[Ключ защиты|ключа защиты]] теперь осуществляет [[TMServer]], а не [[Такси-Мастер]].
# Реализована система тегов для [[Сервер связи с водителями|сервера связи с водителями]] (аналогично [[Тег|СМС-тегам]]) для возможности создания документjd-выписjr для каждого водителя, автомобиля или экипажа. В последующем через данные теги в карточке водителя вы сможете экспортировать в Word-файл любую информацию.
# В окно [[ТМСофтфон]]а добавлен новый столбец {{tab|Линия}}, в котором будет отображаться информация о том, какая именно линия принимает данный звонок.
# В окно [[ТМСофтфон]]е добавлена возможность устанавливать состояние {{tab|Перерыв}} для каждой отдельной линии.
# В [[TMAdmin]] добавлена очистка таблиц контроля пользователей и ошибок
# В контекстное меню [[Окно «Стоянки» в Такси-Мастер|окна «Стоянки» в Такси-Мастер]] добавлен пункт {{tab|Показать экипаж на карте}}
# В [[TMServer]] удален третий порт.
# Теперь перед [[Обновление Такси-Мастер|обновлением Такси-Мастер]] будет происходить резервное сохранение папки с программой с целью избежания потери данных.
# В установщик программы Такси-Мастер добавлена возможность создавать ярлыки на рабочие файлы.
# Изменилась реализация заполнения полей карточки заказа в [[Демо-версия Такси-Мастер|демо-версии программы Такси-Мастер]].
# Оптимизирован подбор экипажей на заказ с учетом их времени освобождения в требуемом районе: разрешена регистрация водителя на любой стоянке даже в момент выполнения заказа, во время которой он сможет указать планируемое время освобождения.
# В карточку автомобиля добавлено поле {{поле|Заблокирован}}, которое будет запрещать водителям выходить на смену.
# В историю заказа добавлено поле {{поле|Звонить на}}.
# Теперь в TMStart вся информация, введенная при предыдущих установках дистрибутива, будет автоматически удаляться.
# Теперь водитель сможет получать уведомления о том, доставлено или недоставлено СМС-сообщение клиенту.

=== Изменения в модуле интеграции с платежными системами и локальными терминалами ===
# Обновлена проверка ключа в [[Модуль интеграции с платежными системами|модуле интеграции с платежными системами]].
# Создано оповещение о том, что [[Модуль интеграции с платежными системами|модуль интеграции с платежными системами]] не может найти подключение к [[TMServer]].
# В [[Модуль интеграции с локальными терминалами|локальном терминале]] заменены настройки для подключения к базе данных на подключение к [[TMServer]].
# Теперь платежи водителей через [[Модуль интеграции с локальными терминалами|локальный терминал]] зачисляются с помощью их терминальных аккаунтов.

=== Изменения в модуле интеграции с картами ===
# Добавлены горячие клавиши для задания адресов в [[Модуль «Интеграция с картами»|карту]] в карточке заказа.
# В карту карточки заказа добавлен расчёт времени проезда от адреса подачи до адреса назначения с помощью сервиса Яндекс.Карты.

=== Изменение в TM API\TMTAPI ===
# В [[TM API]] в [[TM API#Запрос информации по ИД заказа|запрос информации по ИД заказа (get_info_by_order_id)]] добавлена переменная, которая возвращает ИД состояния заказа, а также выходные параметры координат назначенного на заказ экипажа и место подачи.
# В [[TM API]] в [[TM API#Запрос информации по номеру телефона|запрос информации по номеру телефона (get_info_by_phone)]] добавлены выходные параметры (координаты) назначенного на заказ экипажа и место подачи. Также в данный запрос добавлен выходной параметр "На смене" и контроль за выводом информации по водителям, находящимся в данный момент не на линии.
# Создана утилита для проверки TMPayTermAPI
# Добавлен автоматический перерасчет стоимости поездки в карточке заказа при создании заказа с помощью TM API.

=== Изменения в отчетах Такси-Мастер ===
# Доработан отчет [[Отчеты Такси-Мастер#Заказы, завершенные (графики, таблицы)|Заказы, завершенные (графики, таблицы)]]
# Создан новый отчет [[Отчеты Такси-Мастер#Водители, итоговые суммы по выполненным заказам|Водители, итоговые суммы по выполненным заказам]]
# Создан новый отчет [[Отчеты Такси-Мастер#Заказы (по водителям-экипажам-автомобилям), завершенные|Заказы (по водителям-экипажам-автомобилям), завершенные]]
# Создан новый отчет [[Отчеты Такси-Мастер#Реестр перевозок по клиентам|Реестр перевозок по клиентам]]
# В отчет [[Отчеты Такси-Мастер#Терминалы, поступление средств|Терминалы, поступление средств]] добавлен выбор периода отчета по значению полей {{поле|Время внесения средств на счет через терминал}} или {{поле|Дата совершения операции}}.
# В отчет [[Отчеты Такси-Мастер#Водители, заказы с возможностью фильтрации по службам|Водители, заказы с возможностью фильтрации по службам]] в итоговую строку добавлена общая стоимость обычных и бордюрных заказов.
# В отчет [[Отчеты Такси-Мастер#Заказы, распределение по часам и дням недели|Заказы, распределение по часам и дням недели]] добавлен фильтр для прекращенных заказов.
# В отчеты встроен компонент TMEdit и актуализирован в соответствии с логикой работы.

=== Изменения в TMDriver ===
# Теперь отображение кнопки {{button|Пауза}} в таксометре настраивается с помощью соответствующего параметра в меню [[TMDriver]] всех версий.
# Теперь водителю в [[TMDriver]] всех версий запрещено вводить суммы заказа, превышающие максимально допустимую стоимость заказа, установленную в [[База данных Такси-Мастер|базе данных]].
# Теперь при изменении оператором стоимости заказа в карточке, обновленная сумма будет автоматически передаваться в таксометр водителю.
# В [[TMDriver для Android]] встроены Яндекс.Карты, Google Maps и OpenStreetMap.
# Проведена работа над улучшением интерфейса [[TMDriver для Android]], также добавлена ночная тема оформления.
# [[TMDriver для Android]] может работать и без интернета: реализована работа приложения в оффлайн-режиме, которая поддерживает сохранение текущих данных о заказе.
# В [[TMDriverWinCE]] и [[TMDriverWM]] добавлена возможность выбирать величину шрифта на экране информации о заказе и чате.
# В [[TMDriverWinCE]] в форму стоянок добавлены кнопки {{button|Без стоянок}} и {{button|Свободные предварительные}}.
# В [[TMDriverWM]] улучшено отображение кнопок для устройств с маленьким разрешением экрана.

== Изменения за период от 17.09.2012 до 15.10.2012 ==
# К полю «Остаток» в [[Справочник «Водители»|карточке операции с водителями]] добавлена подсказка и убрана возможность поставить в него курсор
# Изменился фон Модуль [[Модуль «Интеграция с картами»#Интеграция с онлайн-картами|онлайн-карт]]
# Теперь Такси-Мастер умеет работать с [[Карта в польском формате|картами польского формата]] в кодировке UTF-8.
# В списках заказов и [[Справочник «Экипажи»|экипажей]] на линии добавлен пункт меню «Показать экипаж на карте». Теперь вы сможете сразу увидеть местоположение экипажа, не обращаясь к отдельному меню.
# Изменилась иконка [[Журнал звонков (модуль «Средства связи»)|«Журнала звонков»]]
# Добавлена возможность смены параметра «Время перерегистрации» в [[Окно «Софтфон»|софтфоне]]
# Отображение очереди звонков в софтфоне теперь регулируется в параметрах софтфона в меню «Настройки»
# Улучшен интерфейс софтфона. Теперь задавать его режим можно не с помощью атрибутов «П», «АО» и «АОК», а с помощью специальных инструментов с всплывающими подсказками на панели управления софтфона.
# Добавлена возможность указывать, за сколько минут до времени подачи водители могут увидеть в [[TMDriver]] предварительные заказы. Это значение регулируется в справочнике [[Справочник «Группы экипажей»|«Группы экипажей»]] во вкладке «Модуль «Связь с водителями».
# Кнопка подбора экипажа для заказа в [[Карточка заказа в Такси-Мастер|карточке заказа]] теперь доступна всегда. То есть даже если экипаж был назначен на заказ автоматически, кнопка все равно будет активной, и вы сможете самостоятельно изменить назначенный экипаж.
# В [[TMAPI]] добавлен метод для создания задачи [[сервер сообщений|серверу сообщений]]. Теперь можно с помощью TMAPI отправлять СМС.
# В TMAPI в метод создания заказа добавлен новый параметр «ИД тарифа». Теперь вы сможете выбирать тариф непосредственно через сайт, по которому будет рассчитываться стоимость заказа.
# В окно [[Окно «Выполненные заказы»|«Выполненные заказы»]] добавлены поля «Фактический километраж» и «Фактическое время поездки». Теперь статистическая информация по выполнению заказов будет более подробной.
# Утилиты [[TMServer]] и [[TMBackup]] теперь разрешено запускать только в одном экземпляре на одном рабочем месте для всех пользователей
# [[TMAdmin]] при полной очистке удаляет и таблицу контроля действий оператора
# Заменен ярлык, расположенный на рабочем столе, с [[Удаленный доступ к рабочему столу#Удалённый доступ посредством AMMYY Admin|AMMYY Admin v2]] на AMMYY Admin v3
# TMServer теперь синхронизирует время с [[База данных Такси-Мастер|базой данных]]. Если раньше он работал по локальным часам на конкретном рабочем месте, то теперь он работает по значению часов компьютера-сервера.
# Добавлена возможность в карточке заказа вручную искать адрес в онлайн-картах
# Из [[TMDriverWM]]/[[TMDriverWinCE]] передается в программу общий километраж поездки и общее время выполнения заказа
# В [[TMDriver для Android]] расширены кнопки на экране для принятия заказа. Это нововведение будет полезно для телефонов с низким разрешением
# Из TMDriver в программу [[Такси-Мастер]] передается фактический километраж и фактическое время поездки. Эта информация заносится в отдельные поля базы данных и в дальнейшем используется в отчетах.

== Изменения за период от 10.07.2012 до 17.09.2012 ==

# Исправлена ошибка в редакторе [[Справочник «Тарифы»|тарифа]], отключающая поиск по тексту тарифа до перезапуска программы
# Исправлена ошибка задания приоритета в [[Окно «Водители: Планирование смен»|карточке планирования смен]], приводящая к установке введенного значения сразу на все смены.
# В [[TMDriver для Android]] исправлена ошибка, приводящая к зависанию программы на Android 4.х.х
# В TMDriver для Android исправлена ошибка, приводящая к зависанию программы на Samsung Galaxy SIII
# Исправлена ошибка, блокирующая возможность [[Модуль расчетов с водителями в Такси-Мастер|провести денежную операцию по нескольким водителям]] за раз. Таким образом, вы теперь сможете без лишних затрат времени проводить однотипные операции сразу по нескольким выбранным водителям.
# Исправлена ошибка, блокирующая возможность указать звуковой файл в общих настройках [[Модуль «Связь с водителями»|модуля «Связь с водителем»]] о поступлении нового сообщения или сигнала «тревога» от водителей. То есть теперь оператор сможет оперативно реагировать на поступившую в диспетчерскую информацию по звуковому оповещению.
# В [[сервер связи с водителями|сервере связи с водителями]] исправлена ошибка, из-за которой не отображалось максимальное время соединения водителя
# Теперь можно запускать только один [[TMServer]] на конкретном рабочем месте.
# Исправлена ошибка в работе [[Сервер сообщений|сервера сообщений]]а, когда при быстрой смене одного состояния на другое, сервер не успевал отправить сообщение по первому состоянию, и отправлял СМС клиенту сразу по второму.
# Добавлена группа настроек в [[Снятие средств по расписанию|снятие денежных средств с водителя по расписанию]]
# Из модуля «Связь с водителями» убрана настройка «На сколько изменять загородную часть стоимости поездки с обратным путем при расчете в таксометре, %»
# В [[Модуль интеграции с локальными терминалами|локальные терминалы]] добавлена возможность самостоятельно формировать внешний вид чека. Теперь в настройках программы присутствует набор тегов, с помощью которых вы сможете самостоятельно регулировать выводимую в чеке информацию
# Добавлена возможность при расчете по [[Справочник «Тарифы»|тарифу]] в [[таксометр]]е получить сумму, указанную оператором в заказе. То есть если по ходу заказа оператор будет изменять сумму в карточке заказа, то текущая информация будет сразу приходить в таксометр.
# В Такси-Мастер добавлены права на группу, так называемых, [[Отчеты Такси-Мастер#Специальные отчеты|«Специальных отчетов»]].
# В модуле Связь с водителями теперь необязательно использование состояний «На месте» и «В машине». Таким образом, если в настройках Такси-Мастер не установлены данные состояния, то в [[TMDriver]] эти формы (т.е. «На месте» и «В машине») будут исключены. Соответственно, отпадет необходимость водителю каждый раз подтверждать вышеуказанные состояния.
# В [[Справочник «Автомобили»|карточку автомобиля]] добавлено новое поле «Модель». Теперь вы сможете конкретизировать модель определенной марки автомобиля и оповещать клиентов о ней (например, марка машины «Форд» модели «Фокус»)
# В [[Карточка заказа в Такси-Мастер|карточку заказа]] добавлена подсветка состояния водителя. Цвет выделения соответствует раскраске данного экипажа в [[Окно «Стоянки» в Такси-Мастер|окне «Стоянки»]]. Таким образом, оператор сможет более тщательно контролировать процесс назначения экипажа на заказ, избегая таких ошибок, как назначение автомобиля, который в данный момент находится в состоянии оффлайн.
# В отчет [[Отчеты Такси-Мастер#Водители, статистика состояний|«Водители, статистика состояний»]] добавлено отображение информации в часах. Теперь вы сможете отслеживать изменение состояния водителя во время работы не только по минутам, но и по часам.
# Теперь вы можете звонить на домашний номер водителя непосредственно из [[Окно «Экипажи» в Такси-Мастер|списка «Экипажи на линии»]], избегая открытия карточки данного водителя.
# Добавлена возможность менять [[Справочник «Сдачи с заказов»|сдачу с заказа]] для бордюрного заказа. Т.е. если экипаж берет [[Заказ «с бордюра»|бордюрный заказ]], то ему будет соответствовать установленная в программе Такси-Мастер сдача непосредственно для данного вида заказа.
# Добавлено копирование [[Снятие средств по расписанию|расписания]] от одного водителя другим. Т.е. если вы создали расписание для одного водителя, то сможете его распространить и на других, не создавая каждый раз новое.
# В [[Справочник «Группы экипажей»|группу экипажа]] добавлены новые настройки «Переводить текущий заказ из данной группы в группу…, если на заказ еще не назначен экипаж» и «Переводить предварительный заказ из данной группы в группу…, если на заказ еще не назначен предварительный экипаж». Если из экипажей группы, которая первоначально установлена на заказ, не было подобрано автомобиля, то будет осуществлен автоматический переход на поиск машины для клиента, включенной в другую группу.
# Теперь [[Журнал контроля действий пользователей|«Журнал контроля действий пользователя»]] выведен в отдельное подменю, которое вы сможете открыть через меню «Доступ» на панели управления программой Такси-Мастер.
# Создан отчет [[Отчеты Такси-Мастер#Водители, табель учета премий|«Водители, табель учета премий»]], который позволяет рассчитывать премию на основе суммы заказов за сутки и введенного порога премии.
# По всей программе и отчетам обновлен интерфейс указания периода времени. Теперь под формой указания периода присутствует расшифровка указанного временного отрезка.
# В коротких сообщениях [[тег]] %ClientName%, отвечающий за переменное значение имени клиента в СМС, заменен тегом Client.
# Создан новый тег %CarModel%, который при отправке сообщений клиентам с указанием названия экипажа, принявшего их заказ, будет заменяться значением из поля «Модель» в карточке автомобиля.
# Оптимизирована работа сервера связи с водителями и сообщений, сокращено количество их обращений в базу данных
# В CommonAPI добавлен запрос ping. Функция «ping» позволяет вам определить работоспособность сервера.
# TMWeb API переименовано в [[TM API]]. Если раньше API охватывало исключительно web-составляющую программного комплекса, то в перспективе и прочие приложения будут приведены к единому интерфейсу.
# В [[TMDriverWM|TMDriver для КПК]] и [[TMDriverNavi|навигаторов]] был исключен экспорт маршрута в программное обеспечение Navitel в формате DataRoute.01.bin, в связи с неудобством его эксплуатации в реальных условиях.
# В [[TMDriver для Android]] добавлена возможность бронирования водителем заказа аналогично КПК/навигаторам. Таким образом, водители, использующие TMDriver для Android, теперь могут бронировать новый заказ во время исполнения текущего.
# В TMDriver для Android добавлена функция запрета на взятие бордюрных заказов, если водитель ни разу не подключался к серверу связи с водителями в текущей сессии.
# Теперь TMDriver для Android оптимизирован для устройств с низким разрешением.
# В TMDriver добавлена возможность отображать заказы по мере их удаленности от местоположения экипажа. Для этого в модуле «Связь с водителями» создан ряд настроек, которые отвечают за способ подсчета расстояния экипажа до клиента.
# Для [[Call-центр Oktell|call-центра Oktell]] добавлены иконки и раскраски, отображающие статус звонка по каждому заказу. Теперь в окне «Текущие заказы», добавив необходимую графу, вы сможете наблюдать иконки, соответствующие статусу работы call-центра Oktell по данному заказу.
# В менеджер исходящих кампаний для call-центра Oktell в параметры кампании добавлены новые поля: «Звонить на», «Номер телефона водителя» и «Шашки»
# В менеджер исходящих кампаний для call-центра Oktell из параметров кампании удален идентификатор кампании

== Версия (61.x) ==

# Исправлена ошибка, приводящая к невозможности использования [[Модуль «Интеграция с картами»#Интеграция с онлайн-картами|онлайн-карт]] в некоторых случаях. Устранены технические проблемы, связанные с многообразием серверов, на которых базируются онлайн-карты, и теперь их функционал полностью доступен.
# Исправлена ошибка, блокирующая возможность проведения одной [[Модуль расчетов с водителями в Такси-Мастер|платежной операции]] по нескольким водителям единовременно. Если раньше при выделении нескольких водителей для проведения одной платежной операции денежные средства переводились только одному водителю, то сейчас это возможно сделать сразу с рядом субъектов.
# Исправлена ошибка интерфейса Такси-Мастер, приводящая к отображению некоторых флажков в сером цвете при работе с различными карточками
# В менеджер исходящих кампаний для [[Call-центр Oktell|call-центра Oktell]] добавлена возможность выбирать параметры заказа, передаваемые в call-центра. Если раньше настройки сценария задавались со статичными параметрами, то теперь вы можете выбирать переменные из выпадающего списка при передаче заявки на запуск определенного сценария из менеджера исходящих компаний.
# В [[Справочник «Автомобили»|карточку автомобиля]] для более удобной работы call-центра Oktell внесена база наименований марок автомобилей. Т.е. теперь вы сможете из выпадающего списка выбирать необходимую марку машины, наименование которой будет впоследствии использовано для оповещения клиентов роботом автоотзвона.
# В [[Окно «Софтфон»|окно «Софтфон»]] программы Такси-Мастер для call-центра Oktell добавлена очередь ожидания. Т.е. оператор видит полный список звонков, которые поступают в данный момент времени. Из них он может самостоятельно выбирать те звонки, которые являются более приоритетными для организации (например, звонки от vip-клиентов).
# Модуль работы с call-центром Oktell может менять состояния заказа после неуспешного/успешного звонка клиенту. В данном случае будет изменяться не статус совершения звонка в столбце «Oktell-состояние», а непосредственно значение состояния, которые задаются вами в TMOM самостоятельно.
# Появилась группа новых [[Отчеты Такси-Мастер#Специальные отчеты|отчетов «Специальные»]], которые необходимы для вывода водителей на смену. Они объединены в одну группу по принципу их открытия в программе Такси-Мастер: они доступны не в специализированном меню «Отчеты», а в карточках тех элементов системы Такси-Мастер, к которым они относятся.
# В отчетах, связанных с водителями, появились новые возможности выбора водителей. В карточки данных отчетов добавлены новые фильтры, позволяющие совершать выборку водителей как по конкретным персоналиям, так и по определенной категории.
# В отчет [[Отчеты Такси-Мастер#Контроль|«Контроль»]] добавлена фиксация заполняемых диспетчером полей в момент создания заказа. Приведем простой пример. Руководитель службы такси хочет знать, кто назначил экипаж на предварительный заказ: оператор или непосредственно водитель вызвался его принять. Теперь с помощью отчета «Контроль» руководитель сможет увидеть то количество полей, которое заполнил оператор во время принятия заявки, и, соответственно, будет знать, кто назначил на заказ экипаж.
# В отчет [[Отчеты Такси-Мастер#Операторы, завершенные заказы с расчетом зарплаты|«Операторы, завершенные заказы с расчетом зарплаты»]] добавлен флажок «Без уволенных», который позволяет просматривать статистическую информацию по данному критерию без учета уволенных водителей за заданный период времени.
# В [[TMDriver]] теперь передается пункт с адресом, указанный в полях Адрес подачи/назначения. Т.е. в случае, когда в данных полях определен не конкретный адрес, а пункт, то информация о его месторасположении, определенная в карточке заказа, передается в TMDriver.
# В [[TMDriver для Android]] улучшено оформление таксометра и интерфейс программы оптимизирован под большие экраны.
# В [[TMDriverWM]] и [[TMDriverWinCE]] изменена функция автостарта таксометра. Автостарт срабатывает, если скорость больше 5 км/ч в течение 3 секунд. Данный инструмент очень удобен в момент простоя экипажа в пробке при выполнении им заказа.
# В TMDriver добавлена возможность сортировать список заказов в зависимости от удаленности до места подачи для водителей. Водитель теперь будет знать, по адресу какого заказа он прибудет раньше всего. Это значительно ускорит процесс приема и выполнения заказа водителями.
# В Такси-Мастер добавлена настройка «Водитель может поставить себе в очередь n текущих заказов» для TMDriver. Как работает данная функция? Водитель при просмотре списка не принятых текущих заказов будет иметь возможность набирать заказы, т.е. теперь он сможет брать не один заказ для выполнения, а сразу несколько.
# В TMDriver для Android встроена функция печати чеков через bluetooth-принтеры. Теперь в экипаже вы сможете установить любой беспроводной bluetooth-принтер и выдавать клиентам чеки по завершению заказа.
# В настройки [[Окно «Столбцы»|списка столбцов]] добавлена технология drag-and-drop, т.е. теперь вы можете перемещать информационные столбцы в окнах простым передвижением их по экрану, не используя дополнительные инструменты. В том числе по перечню столбцов вы сможете осуществлять поиск. Его идея заключается в том, что теперь в меню «Настройка колонок списка» встроен фильтр, который позволит осуществлять быструю выборку.
# В компилятор [[Справочник «Тарифы»|тарифа]] добавлен поиск и список функций, служащие для более удобного и понятного создания нового тарифа.
# В стандартный и расширенный тарифы добавлен новый параметр - цена остановки. С его помощью можно определить конкретную стоимость остановки экипажа при исполнении заказа.
# В список [[тег]]ов, используемых в программе Такси-Мастер, добавлен тег «Краткое название автомобиля». Т.е. теперь вы можете оповещать клиента о назначенном на заказ автомобиле, не указывая его полное название, а лишь определив краткое наименование с помощью тега. Эта функция служит для сокращения количества символов в СМС-сообщении.
# За счет оптимизации работы с [[Справочник «Признаки экипажей»|признаками экипажей]] ускорен процесс обработки заказов. Таким образом, при достаточно обширном перечне текущих заказов, работа оператора будет быстрее и продуктивнее.
# В Такси-Мастер добавлена интеграция с картами 2GIS-Online аналогично картам Яндекс.Карты и Google Maps. Вы можете теперь пользоваться данной картой для отображения как маршрута экипажа при выполнении им заказа, так и для поиска автомобилей вашей службы такси с помощью gps-координат.
# [[Утилита администрирования базы данных|TMAdmin]] научился автоматически создавать новую базу данных при переносе данных из рабочей базы данных. Теперь, когда вы захотите создать новую базу данных с некоторыми элементами, которые включенны в вашу старую, то их не придется переносить отдельно. TMAdmin предлагает вам выбрать ту информацию, которую вы хотите перенести из старой базы данных в новую.
# Расширен API [[Установка и настройка модуля «Интернет-заказы»|модуля «Интернет-заказы»]]. Теперь в нем существуют такие позиции как координаты экипажей, предварительный расчет стоимости заказа, его текущий статус, а также информация об автомобиле и водителе.
# Теперь при выгрузке улиц из карт 2GIS вместе с ними будут выгружаться наименования населенных пунктов, к которым они относятся.
# Сдачи с заказов для [[Заказ «с бордюра»|бордюрных заказов]] теперь настраиваются под отдельные группы экипажей.
# Во вкладке «Расширенные настройки» в [[Справочник «Физические лица»|карточке клиента]] разрешено задавать отрицательные значения денежных средств. Т.о. вы можете имитировать скидки для отдельных клиентов.
# В Такси-Мастер в [[Карточка заказа в Такси-Мастер|карточку заказа]] добавлена предиктивная система подбора экипажей, основанная на Яндекс картах, указывающая через сколько автомобиль будет на месте подачи. Теперь оператор сможет при назначении экипажа на заказ ориентироваться по точному количеству времени, которое затратит автомобиль для подъезда к адресу подачи.
# В случае приобретения вами программы на тестовый период, каждый раз при входе в программу вы сможете узнать остаток времени использования данной тестовой версии.

== Версия (58.x) Стабильная ==

{{youtube|http://youtu.be/fY8S1_AYs6s|заголовок=Основные нововведения в Такси-Мастер версии 2.0.58.0}}

# В программу введен новый тип [[Справочник «Сдачи с заказов»#Работа с накопительным типом сдачи с заказов|сдачи с заказа «Накопительная»]] взамен старым двум, позволяющий вести учет сразу как по количеству, так и по сумме заказов. То есть теперь вы можете задавать сдачи с заказов, учитывая не только сумму или количество заказов, выполненных экипажем, но и действие данных критериев оценки в совокупности в течение всего рабочего дня водителя.
# В программу вновь был введен и усовершенствован такой инструмент, как [[Справочник «Смены тарифов»|смены тарифов]]. Справочник стал более удобный и понятный для использования: теперь в нем есть вкладки, повторяющие все возможные критерии изменения [[Справочник «Тарифы»|тарифа]] в течение дня. Также в нем присутствует функция копирования информации о смене тарифа, что позволяет переносить данные с одного дня недели на другой без лишних затрат времени.
# Полностью изменен блок программы, отвечающий за [[Модуль интеграции с платежными системами|проведение платежей с городских терминалов]]. Произошло перемещение [[Справочник «Платежные системы»|справочника «Платежные системы»]] из панели управления непосредственно в меню «Справочники», однако своего функционала и интерфейса он не поменял. Также теперь [[TMWeb]] не существует в качестве самостоятельного сервера — сейчас его функции выполняет [[TMServer]], а параметры задаются через [[Параметры Такси-Мастер#TMWeb|меню «Настройки»]].
# Улучшен интерфейс таксометра в [[TMDriver]]:
## В зависимости от того, в каком состоянии в момент выполнения заказа находится экипаж, число, отражающее стоимость поездки на спутниковом таксометре, будет принимать следующие цвета:
##* желтый — временная остановка [[Справочник «Экипажи»|экипажа]]
##* зеленый — экипаж в движении
##* красный — остановка таксометра в любой момент поездки
## Теперь кнопки [[TMDriver]] срабатывают не моментально, а с задержкой. Эта функция осуществлена во избежание ошибок при нажатии на какие-либо кнопки в TMDriver. Сейчас для активации действия необходимо удерживать кнопку в течение нескольких секунд, пока она полностью заполнится зеленым цветом. Только после этого в TMDriver произойдет выбранное действие.
# В демо-версии программы теперь есть [[Справочник «Тарифы»|тарифы]] по умолчанию. То есть при использовании демо-версии можно полностью прочувствовать работу данного компонента системы.
# В наши дистрибутивы теперь включается обновленная версия программы для оказания удаленной технической поддержки [[Удаленный доступ к рабочему столу#Удалённый доступ посредством AMMYY Admin|AMMYY Admin v3]]. Сейчас вы можете не скачивать программу вручную — она автоматически установится на ваш ПК одновременно с [[Обновление Такси-Мастер|обновлением Такси-Мастер]].
# Обновлен интерфейс [[Конфигуратор сервера связи с водителями|конфигуратора сервера связи с водителями]]. Все настройки расположены теперь в одном окне, что позволяет совершать минимум действий при установке параметров сервера связи с водителями.
# Исправлена ошибка, из-за которой не отображался цвет [[Справочник «Категории телефона»|категории телефона]] при использовании телефонных масок. Если в работе диспетчерской вы используйте такой инструмент, как телефонные маски, то вы могли наблюдать, что при отображении номера в [[Карточка заказа в Такси-Мастер|карточке заказа]] не происходило его соотнесение к какой-либо категории телефонов, то есть отсутствовало цветовое определение. Недочет был устранен, и теперь все телефоны, которые присутствуют в [[База данных Такси-Мастер|базе данных]], автоматически распознаются и выделяются тем цветом, который соответствует их категории.
# [[Справочник «Состояния заказа»|Состояния]] «Клиент в машине», «Клиент не вышел», «Водитель подъехал на место» для [[TMDriver]] теперь используются всегда.
# Переделаны СМС-уведомления в накопительной системе расчетов. Если раньше клиентам приходили сообщения, содержащие промежуточный баланс, то теперь они отражают действительную конечную сумму состояния их расчетного счета.
# В случае отсутствия привязки домов к улицам на [[Модуль «Интеграция с картами»|карте]], программа выдаст уведомление «В карте отсутствуют адреса». Вам потребуется либо привязать дома, которые имеются на карте, к улицам, которые хранятся в [[справочник «Улицы»|справочнике «Улицы»]], либо действовать без этого, имея небольшой риск потерять часть статистики.
# При копировании [[Текущий заказ|текущего заказа]] пользователь получит уведомление, если время подачи заказа оказывается меньше текущего.
# Добавлены два новых [[Права доступа пользователя в Такси-Мастер|права]] в группу «Телефония», такие как [[Права доступа пользователя в Такси-Мастер#Состояние линий|«Состояние линий»]] и [[Права доступа пользователя в Такси-Мастер#Очередь звонков Asterisk|«Очередь звонков Asterisk»]], а, следовательно, вы теперь сможете управлять доступом операторов к данным окнам.
# [[Справочник «Смены тарифов»|Смены тарифов]] теперь действуют и для [[Заказ «с бордюра»|бордюрных заказов]], то есть независимо от вида заказа: бордюрный или обычный, смены тарифов будут работать в одинаковом режиме.
# В карточке заказа в выпадающий список экипажей добавлена сортировка по удаленности от адреса подачи, которая работает, если ваши водители работают с TMDriver для устройств с GPS-датчиками (это коммуникаторы под управлением [[TMDriverWM|Windows Mobile]], [[TMDriverNavi|навигаторы]] под управлением Windows CE и [[TMDriver для Android|Android-смартфоны]]). Для этого введен новый столбец информации «Километраж», который отображает удаленность экипажа от адреса подачи. То есть оператор при назначении автомобиля на заказ сможет ориентироваться по расстоянию, которое должен будет пройти экипаж до адреса подачи.
# В таксометр добавлена новая кнопка «Остановка», позволяющая водителям продолжать рассчитывать стоимость поездки во время простоя.
# В стандартный и расширенный [[Справочник «Тарифы»|тарифы]] добавлен расчет обратного пути. Таким образом, получается, что если клиент хочет совершить повторную поездку в обратном направлении, тариф будет рассчитываться в соответствии с заданным значением стоимости обратного пути.
# Из Такси-Мастер убраны настройки для экипажей без группы, теперь они реализованы в виде отдельной [[Справочник «Группы экипажей»|группы экипажей]]. Все экипажи, которые не были ранее определены в какую-либо группу, теперь будут сформированы в одну, которая называется «Без группы» и, соответственно, все параметры будут задаваться в ее карточке.
# В группы экипажей добавлена настройка «Водитель может взять не более […] предварительных заказов», что помогает контролировать распределение подобных заказов среди водителей службы такси.
# В «Купленные смены» добавлены поля «Заказов за смену», «Призовых за смену» и «Сумма за смену».
# Улучшен механизм подбора экипажей на заказ. Параметры, связанные с этим, расположены в настройках программы [[Параметры Такси-Мастер#Ветка «Подбор на заказ»|«Экипажи → Подбор на заказ»]].
# Значительно улучшен и расширен инструментарий для прорисовки городов, районов и стоянок.
# В [[История заказов|истории по заказу]] теперь вместо стандартного пользователя «Администратор», от имени которого выполняются автоматические действия, явно отображается «GPRS», «SMS» или «TMServer» (соответствует тому компоненту системы, который совершил данное действие).
# Изменен внешний вид статистики по заказу в карточке заказа. Теперь информация о клиенте отображается в виде таблицы, что делает работу с данными более удобной для оператора.
# Для [[Карта в польском формате|карт в польском формате]] изменена раскраска трека водителя на более яркую. Если раньше маршрут поездки отображался черной линией, которая сливалась с картой, то теперь ее цвет изменен на красный, который является более контрастным по отношению к цветовой палитре карты.

== Версия (56.х) Стабильная ==
#Введен так называемый Журнал ошибок. Он расположен в меню {{окно|Помощь}}. Сам журнал хранит в себе часть информации из файла [[Журнал работы Такси-Мастер|TMErrors.log]] в удобном табличном виде.
#Для карт [[Модуль интеграции с бесплатными картами|2GIS]] в карточке заказа добавлены подсказки к полям {{поле|Адрес подачи}} и {{поле|Адрес назначения}} при поиске улиц.
#[[Вход в Такси-Мастер|Вход в программу]] стал более информативным.
#При входе в программу добавлены настройки, позволяющие быстро подключить/отключить [[Модули Такси-Мастер|модули]] для работы оператора.
#Реализована смена настроек интерфейса (окон, раскрасок и столбцов) на лету, т.е. Вашему системному администратору достаточно задать настройки у себя и все готово.
#Практически с нуля переделана система [[Справочник «Дисконтные карты»|дисконтных карт]] с учетом многих Ваших пожеланий.
#Добавлена возможность запретить водителям с координатами, т.е. с GPS-устройствами, регистрацию на стоянках, если от водителей поступают актуальные координаты.
#Началась переработка системы уведомлений. Теперь сообщения аккуратно всплывают в углу экрана на манер ICQ, QIP и т.п., позволяя сконцентрироваться на работе.
#С нуля переделана система [[Права доступа пользователя в Такси-Мастер|прав пользователей]]. Она стала наглядной, удобной в использовании, а любые изменения в правах вступают в силу на лету для каждого оператора.
#Добавлена настройка "Использовать списки улиц и пунктов" из справочников, а не карты при использовании карты.
#Улучшена система блокировки заказов от совместного редактирования.
#На страницу настроек "Заказы - Состояния заказа" добавлены настройки "При переходе из предварительных в текущие перевести в состояние с экипажем и без".
#Оптимизирована работа с памятью при большом числе текущих заказов, за счет чего повысилась общая стабильность системы.
#Плагин для карт 2GIS автоматически устанавливается в папку с картами, если они уже установлены в Windows.
#В [[TMDriver]] добавлена новая информация о заказе: тип клиента (физическое / юридическое лицо) и тип оплаты (наличный / безналичный)
#С нуля переписана система [[Справочник «Тарифы»|тарифов]].

== Версия (54.х) Стабильная ==
#Исправлена ошибка, приводящая к установке последнего в очереди [[Справочник «Экипажи»|экипажа]] при подборе по соседним [[Окно «Стоянки» в Такси-Мастер|стоянкам]].
#Исправлена ошибка, блокирующая возможность быстрого добавления клиента из [[Карточка заказа в Такси-Мастер|карточки заказа]].
#Исправлена ошибка, блокирующая работу оператора сообщениями при включенной настройке {{field|Автоматически удалять телефон из неотвеченных по истечении N минут (0 - не удалять)}}.
#Исправлена ошибка, блокирующая воспроизведение звуковых уведомлений при смене [[Справочник «Состояния заказа»|состояния]] в завершенных заказах
#Исправлена ошибка, приводящая к появлению в [[TMDriver]] сообщения о тревоге два раза подряд.
#Правила из таблицы {{tab|Видимость заказов и машин чужих групп}} теперь применяются при назначении экипажа на заказ [[Горячие клавиши Такси-Мастер|горячими клавишами]].
#В программе Такси-Мастер введены ограничения и автоматические проверки на правильность ввода, т.е. программа всегда подскажет Вам что и где вводить.
#Добавлена поддержка самой новой версии ГИС [[Модуль интеграции с картами Мосмап|MosMap]] Integrator.
#Добавлены в карточку [[Ежедневный заказ|ежедневных заказов]] неучтенные ранее возможности из карточки обычных заказов.
#Расширены настройки отчета "Журнала звонков для колцентра Asterisk", что позволит обходить различные ограничения на ОС семейства Windows.
#Настройки пользователя теперь всегда путешествуют вместе с ним, т.е. за каким бы компьютером в офисе ни находился пользователь, для него всегда будет его удобный Такси-Мастер.
#В карточке постоянного клиента в список улиц добавлена информация о городе, где эта улица расположена.
#В список заказов добавлен столбец "Указанное водителем время подачи (мин)", отображающий сколько минут указал в [[TMDriver]] водитель
#Полностью переосмыслена и переработана система [[Справочник «Сдачи с заказов»|сдач с заказов]] водителями, чтобы соответствовать современным нормам ведения бизнеса.
#Переоформлен личный кабинет на сайте сервиса [[Программа для рассылки сообщений с использованием протокола SMPP|SMS-рассылок]].
#Реализовано автоматическое переподключение устройств [[SpRecord]], позволяющее при проблемах с оборудованием продолжить работу в нашем программном комплексе.
#Интерфейс [[TMDriver]] для КПК оптимизирован под любые разрешения экрана.
#Программа [[TMWeb]] с этого момента высылается в составе [[Дистрибутив Такси-Мастер|дистрибутива Такси-Мастер]].

Более подробно об изменениях и разработке новых функций программы читайте на [http://www.taxidev.ru/ www.taxidev.ru]

Системные требования

2013-12-11T10:41:23Z

AnnaNikolskih: 1

{{вопросы приветствуются}}
'''{{PAGENAME}}''' для [[{{TM}}]] к аппаратному обеспечению определить довольно сложно, многое зависит от количества рабочих мест и от набора модулей.
Тем не менее, существует рекомендуемый набор параметров, которого следует придерживаться.

== Минимальные системные требования к рабочим местам и серверу Такси-Мастер ==

{|
|-
! {{table/th|9ACD32}} | '''Компонент'''
! {{table/th|9ACD32}} | '''Характеристика'''
|-
!colspan="2"|Минимальные требования к рабочим местам операторов
|-
| Процессор
| Intel. Тактовая частота не менее 1,8 ГГц. Многоядерный процессор.
|-
| Оперативная память
| Не менее 1 Гбайт (рекомендуется иметь запас — в пределах 2 ГБайт)
|-
| Объем дискового пространства
| Не менее 80 Гбайт
|-
| Источник бесперебойного питания
| Обязательно наличие источника бесперебойного питания
|-
| Операционная система
| Только оригинальная копия операционной системы Windows XP Proffesional, Windows 7 Proffesional либо Windows 8 Proffesional.
|-
!colspan="2"|Минимальные требования к серверу Такси-Мастер и Oktell (Минимальная конфигурация допустима для небольших диспетчерских и обработки не более 1000 заказов в сутки).
|-
|Процессор
|Процессор Intel Core i3 с тактовой частотой не менее 3.0.
|-
|Оперативная память
|DDR3 2048 Mb
|-
|Привод
|Обязательное наличие DVD+/-RW привода
|-
|Жесткий диск
|HDD SATA-III 500Gb (7200rpm) (с учетом регулярного [[TMBackup|резервного копирования]] и при условии хранения копий [[База данных {{TM}}|базы данных]] за последние 90 дней)
|-
|Операционная система
|Лицензионная операционная система Windows Pro 7 32-bit/64-bit SP 1 Russian
|}

С ростом количества заказов в сутки (от 1500) может потребоваться улучшение компьютера, на котором работает [[сервер Firebird]].
Рекомендуется заранее расширить объем оперативной памяти, если вы замечаете легкое увеличение задержки при открытии карточки заказа.

{{важно|Ни в коем случае}} нельзя использовать «авторские сборки» (ZverCD, ZverDVD и прочие) — практика {{коммент|неоднократно|И не одной тысячей потерянных заказов}} показала, что на этих операционных системах компоненты Такси-Мастер и third-party-приложения могут работать со сбоями или не работать вообще.
Также обратите внимание, что не подходят для работы версии для домашней работы (Home Edition) и, тем более, Starter Edition (есть у Windows 7).

{{info|Обратите внимание, что вы можете приобрести сервера в нужной комплектации с учетом функционала, который будет необходим вашей службе такси, на сайте [http://www.taxometer.ru/price/computers/servers/ taxometer.ru.]}}

== Оптимальные системные требования к рабочим местам и серверу Такси-Мастер ==
Сервер с нижеперечисленным набором параметров полностью прошел все необходимые функциональные и нагрузочные тесты и способен обрабатывать несколько тысяч заказов (не менее 3000) круглосуточно без снижения производительности.

{|
|-
! {{table/th|9ACD32}} | '''Компонент'''
! {{table/th|9ACD32}} | '''Характеристика'''
|-
|Процессор
|Intel LGA1155 Core i5-3570 (3.4/6Mb) OEM
|-
|Материнская плата
|Intel Original DH77KC Soc-1155 iH77 DDR3 ATX Audio 10ch DP+HDMI+DVI-I LAN RAID (bulk)
|-
|Оперативная память
|DDR3 4096Mb 1600MHz Kingston KVR16N11/4 CL11
|-
|Привод
|DVD+/-RW Lite-On [IHAS122]-18 SATA, Black
|-
|Блок питания
|FSP [450PNF] 450W, active PFC, ATX 2.2, Fan 120mm
|-
|SSD диск
|Intel SSD 120Gb 520 серия (SSDSC2CW120A310) (SATAIII, MLC, 2.5») - 2 шт. (в RAID 1)
|-
|Жесткий диск
|Seagate SATA-III 500Gb ST500DM002 (7200rpm) 16Mb 3.5
|-
|Операционная система
|Лицензионная Windows Pro 7 64-bit SP 1 Russian
|}

== Рекомендуемая конфигурация для сервера Такси-Мастер для крупных таксопарков ==
Рекомендуемая конфигурация для сервера Такси-Мастер (при правильной настройке) способна удовлетворить требования крупных таксопарков и без каких либо проблем обрабатывать до 10000 заказов в сутки.

{|
|-
! {{table/th|9ACD32}} | '''Компонент'''
! {{table/th|9ACD32}} | '''Характеристика'''
|-
|Процессор
|Intel® Xeon® E5-2609 (Sandy Bridge-EP) либо 2.40GHz, 4-Core, 6.4GT/s QPI, 10MB L3 cache
|-
|Чипсет
|Intel® C602J (Patsburg) PCH
|-
|Память
|4GB (1 DIMM x 4Gb DDR-III PC3-10600 ECC Registered Single Rank (up to 24 DIMMs PC3-12800, upgreadable to 768GB mab
|-
|Контроллер
|RAID-контроллер IBM ServeRAID M5110 8-internal channel SAS 6G RAID (0,1,10,5,50) controller 512MB cache (upgreadable to RAID6,60 with 1GB FBWC)
|-
|Дисковая подсистема
|Дисковая подсистема up to 32TB (32 x 1Tb Hot Plug SATA/SAS SFF 2.5» HDD/SSD System (8 upgreadable to 32 HDD bays)
|-
|Жесткий диск
|Жесткие диски 2 (up to 32) x 2.5 300GB hot-plug SFF SAS HDD
|-
|Сетевой адаптер
|4-channel Intel® i350 PCI-E Gigabit LAN Network Interface Controller with VMDq, SR-IOV
|-
|Оптический привод
|DVD-RW MultiBurner optical drive
|-
|Блоки питания
|750W Hot Plug (upgreadable to 1+1 Redundant 750W Power Supply System)
|-
|Корпус
|Miditower (upgreadable to 4U Rackmount, depth - 750mm)
|-
|Управление
|IBM Integrated Management Module II Standard (upgreadable to Advanced)
|-
|Операционная система
|Лицензионная операционная система Windows Server 2003 R2
|}

== Требования к условиям установки ==
Требования к условиям установки программного комплекса Такси-Мастер не менее важны, чем системные требования к оборудованию. Без соблюдения данных условия, сотрудник [[Отдел технической поддержки|технической поддержки]] нашей организации не сможет оказать вам помощь во внедрении программного комплекса в полной мере.

# Наличие квалифицированного системного администратора.
# Обеспечение полного административного доступа к компьютерному оборудованию, предназначенного для установки программы.
# Получение удаленного доступа к каждому рабочему месту, на которое будет произведена установка компонентов системы Такси-Мастер.
# Получение возможности доступа к коммутационному оборудованию.
# Установка дополнительного программного обеспечения, кроме программного комплекса Такси-Мастер, допускается только после процесса внедрения и с согласия [[Внедрение Такси-Мастер|отдела внедрения]].

== Телекоммуникационные средства связи ==

Быстродействие компонентов программы, а также действий, производимых в ней, зависят не только от жесткого диска, но и от связи с сетью Интернет. Так как практически все модули программы работают через сеть, то нужно предъявлять к ней четкие требования:

# Стабильное подключение к сети интернет путем подключения выделенной линии с статическим IP адресом либо оптоволоконное подключение.
# Скорость подключения должна составлять не менее 4 мб/сек для работы до 50 экипажей без IP телефонии.
# Следует учитывать, что для ПО Такси-Мастер критично качество интернет канала, перед установкой должны быть исключены дефекты, как потеря пакетов, разрывы связи, высокая задержка(более 200 м/сек).
# Отсутствие фильтрации трафика по портам и протоколам со стороны провайдера.
# Городская АТС должна поддерживать функции Евро АОН,Caller ID.

== Требования к call-центру Oktell ==

Одной из основных функций такси является прием заказов при помощи [[call-центр Oktell|call-центра Oktell]]. Чтобы сделать прием заказов стабильным, качественным, бесперебойным, то нужно обеспечить грамотную работу каналу телефонной связи. Что вам для этого потребуется?

# Рекомендуется использование IP телефонии.
# Необходимо уточнить возможность использования регистрации на сервере.
# В случае, если вы подключаете облачный Oktell, то вам будет необходима поддержка регистрации через Public-интернет.
# Городская АТС должна поддерживать функции Евро АОН,Caller ID.

== Локальная вычислительная система (ЛВС) ==

В ЛВС входит группа компьютеров и периферийное оборудование, которые числятся на балансе вашей организации, объединенные одним или несколькими автономными высокоскоростными каналами передачи цифровых данных. ЛВС должна строится на базе оборудования с минимальной пропускной способностью 100 мбит/сек по протоколу TCP/IP без внутреннего DHCP сервера с четким и едино читаемым распределением сетевых адресов. Задержка передаваемых IP-пакетов не должна превышать 50 миллисекунд, а также все адреса должны иметь одну маску подсети и общую базу (192.168.0.1, 192.168.0.2 и так далее).

== Коммутационное оборудование ==

Целесообразным является использование коммутационного оборудования следующих фирм производителя: Nateks, D-Link, Portech. Полноценная и корректная работа с непротестированным оборудованием не гарантируется.

== Ссылки ==
* {{code/url|http://www.taxometer.ru/price/computers/servers/}} - сервера для программного комплекса Такси-Мастер в нужной комплектации.
* {{code/url|http://bit.ly/4Q7ySS}} — источники бесперебойного питания на Яндекс.Маркете.
* {{code/url|http://ru.wikipedia.org/wiki/RAID}} — о технологии RAID на Википедии.

Обратите внимание, что вы можете приобрести сервера в нужной комплектации с учетом функционала, который будет необходим вашей службе такси, на сайте [http://www.taxometer.ru/price/computers/servers/ taxometer.ru.

[[Категория:Организационная информация]]
[[Категория:ТМ2]]
[[Категория:AUO]]

Черновик

2013-12-03T10:25:18Z

AnnaNikolskih:

'''TaxoPhone''' – это современное и удобное мобильное приложение, позволяющее заказать такси без звонка в диспетчерскую. Приложение будет работать на телефонах под управлением операционных систем iOS//тут будет ссылка на документацию для iOS// и Android.

Для того чтобы служба такси могла принимать заказы, поступающие из приложения, необходима интеграция TaxoPhone и программы [[Такси-Мастер]]. Об этом вы можете прочитать в статье [[Настройка приложения TaxoPhone|"Настройка приложения TaxoPhone"]].

== Как получить приложение? ==
Службы такси, желающие получить приложение, обращаются в отдел продаж компании БИТ "Мастер", отправив запрос на {{ящик ОП}}, либо же просто связавшись с менеджером по телефону. Далее БИТ "Мастер" адаптирует детали интерфейса TaxoPhone под конкретные пожелания службы такси. Согласно техническому заданию, разработчики могут снабдить приложение элементами фирменного стиля компании (уникальная заставка при запуске приложения, логотип, корпоративные цвета).

Приложению присваивается индивидуальное название, под которым оно будет доступно в интернет-магазине (возможно название службы). Индивидуальное приложение службы такси будет загружено для скачивания в интернет-магазины Google Play и App Store. В итоге у службы такси появится персональное брендированное мобильное приложение, с помощью которого клиенты смогут воспользоваться только ее услугами.

== Работа в приложении TaxoPhone ==
После установки запустите приложение. Появится окно нового [[заказ]]а, которое выглядит следующим образом:

[[Файл:Окно нового заказа.jpg|300px|thumb|center|Окно нового заказа]]

По возможности определяется текущее местоположение (используются GPS, сотовая сеть и Wi-Fi). При наличии доступа к сети Интернет определяется адрес текущего местоположения. При отсутствии - указываются координаты (широта и долгота).

Чтобы сформировать заказ, нажмите на кнопку {{button|Заказать}}.

Сразу после этого появится форма пожеланий к заказу. В можно уточнить информацию по заявке:

# Уточнение [[Адрес подачи|места подачи]]: квартира, подъезд или произвольный комментарий.
# Остановки.
# Место назначения ("Куда").
# Время поездки (по умолчанию предлагается ехать прямо сейчас).
# Дополнительные параметры: [[группа экипажей]] и требования к заказу.

После заполнения данной формы необходимо нажать на кнопку {{button|Готово}} для создания нового заказа.

[[Файл:Форма пожеланий.jpg|300px|thumb|center|Пожелания к заказу]]

Если заказ создавался с помощью данной копии приложения в первый раз, то далее будет необходимо пройти процедуру авторизации.

{{info|
Обратите внимание, что следующие элементы формы пожеланий к заказу доступны для настройки в TaxiMaster (то есть диспетчерской службой):
*Поле для ввода номера квартиры;
*Блок «Остановки»;
*Блок «Куда»;
*Блок «Дополнительно».
Это означает, что отображение любого из данных элементов может быть отключено. Причем блок «Дополнительно» может быть отключен как полностью, так и частично, то есть может присутствовать только возможность выбора экипажа или же только возможность задать дополнительные требования (например, наличие детского кресла).
}}

=== Заполнение профиля и авторизация приложения ===
Пользователю будет необходимо внести информацию о себе и пройти процедуру авторизации. Для этого в открывшейся форме {{tab|Регистрация}} необходимо заполнить поля {{поле|Имя}} и {{поле|Номер телефона}}.

[[Файл:Регистрация.jpg|300px|thumb|center|Регистрация]]

Для завершения авторизации в открывшемся окне {{tab|Подтверждение}} введите уникальный код, который придет в виде СМС-сообщения. Укажите данные цифры в поле {{поле|Код}}. В случае, если возникли проблемы с получением кода, нажмите на кнопку {{кнопка|Получить код повторно}}, после чего сообщение будет выслано на указанный номер телефона еще раз. Обратите внимание на то, что повторное сообщение может быть отправлено не более одного раза в течение трех минут.

[[Файл:Окно подтверждения.jpg|300px|thumb|center|Окно подтверждения]]

После успешной авторизации можно продолжить работу с приложением.

=== Назначение автомобиля на заказ в приложении TaxoPhone ===
После того, как процедура авторизации пройдена, система начнет поиски [[экипаж]]а на ваш заказ. Следить за процессом поиска можно на форме приложения {{tab|Состояние заказа}}.

Состояние меняется в зависимости от действий водителя экипажа и может принимать следующие значения:

# '''Поиск автомобиля''' - автомобиль на ваш заказ пока не найден.
# '''К вам подъезжает''' - на форме появится информация об экипаже, который будет выполнять ваш заказ. Также эти данные придут клиенту в виде уведомления.
# '''Вас ожидает''' - экипаж подъехал по адресу подачи и вы можете выходить к нему.
# '''В пути''' - вы совершаете поездку в такси.
# '''Заказ успешно завершен''' - клиент успешно добрался до пункта назначения и рассчитался с водителем.
# '''Заказ отменен''' - клиент или диспетчерская по каким-либо причинам отменили заказ. В приложении причина отмены неизвестна.

Время от начала поиска автомобиля и до его момента его подачи отображается на таймере.

Клиент может отказаться от заказа в любой момент до того, как он сел в машину. Для этого необходимо нажать на кнопку {{кнопка|Отказаться}}.

После того, как автомобиль назначен, пользователь может позвонить водителю для уточнения каких-либо данных. Для этого необходимо нажать на кнопку {{кнопка|Позвонить}}.

Обратите внимание, что все передвижения экипажа пользователь может отследить на встроенной в приложении карте. Таким образом клиент всегда будет знать местоположение экипажа как до момента прибытия его к месту подачи, так и во время исполнения заказа.

===Завершение поездки и оценка заказа===
После завершения поездки на экран приложения выводится следующая информация:
#Стоимость поездки;
#Ее продолжительность;
#Пройденное расстояние.

Помимо этого, пользователь всегда сможет оценить качество поездки. Он сможет это сделать с помощью "смайликов", выражающих различные эмоции.

[[Файл:Оценка поездки.jpg|300px|thumb|center|Оценка поездки]]

== Уведомления ==
Как уже упоминалось, что при смене состояния заказа, приложение отправляет уведомления клиенту. Данные уведомления могут появиться в следующих ситуациях:

# Назначен автомобиль на заказ;
# Водитель подъехал по адресу подачи;
# Заказ успешно завершен;
# Заказ отменен;
# Пропала связь с сервером (при возобновлении связи отслеживание заказа будет продолжено).

При нажатии на уведомление будет открыт соответствующий заказ.

{{info|В приложении под Android отслеживание заказа и поступление уведомлений происходит даже в том случае, если пользователь свернул или закрыл приложение.}}

[[Файл:Уведомление.jpg|300px|thumb|center|Пример уведомления]]

== История заказов ==
Все введенные пользователем адреса (место подачи, место назначения, остановки) попадают в историю поездок.
В истории хранится не более 10 адресов, приоритет отдается последним и популярным адресам.
При оформлении последующих заказов во всех полях ввода будет предлагаться подстановка адресов из истории. Данные подсказки из истории поездки в устройствах под управлением Android появляются при вводе не менее двух символов адреса в необходимую строку.

[[Файл:История заказов.jpg|300px|thumb|center|История заказов]]

Как настроить рабочее место Такси-Мастер?

2013-12-03T09:38:59Z

AnnaNikolskih: Актуализировано

__TOC__

== Установка ==

1. Запустите установочный файл. Откроется окно «Установка – Такси-Мастер». Нажмите кнопку «Далее».

{{картинка|Начало установки.png}}

2. Прочитав лицензионное соглашение, выберите пункт «Я принимаю условия лицензионного соглашения» и нажмите «Далее».

{{картинка|Лицензионное соглашение.png}}

3. В следующем окне, при необходимости, можно изменить путь установки. Для этого нужно нажать кнопку «Обзор…» и выбрать новый путь. Нажмите кнопку «Далее».

{{картинка|Папка установки.png}}

4. Затем следует из всплывающего меню выбрать компонент «Клиент» и нажать «Далее».

{{картинка|Выбор компонентов.png}}

5. Теперь необходимо ввести IP адрес компьютера, на котором была установлена серверная часть. После этого нажмите «Далее».

{{картинка|IP сервера.png}}

6. Все готово к установке. В появившемся окне проверьте параметры установки и, если все верно, нажмите кнопку «Далее». При необходимости что-либо изменить, вернитесь к нужному шагу нажатием кнопки «Назад».

{{картинка|Параметры установки.png}}

7. После нажатия кнопки «Установить» появится окно, отображающее состояние установки.

{{картинка|Установка.png}}

8. После завершения установки Вы увидите окно, сообщающее об успешной установке программы. Чтобы закрыть это окно, нажмите кнопку «Завершить».

{{картинка|Завершение установки.png}}

9. Для запуска программы используйте ярлык, появившийся на Вашем рабочем столе.

{{картинка|Лого.png}}

==Настройка рабочего места==

1. При первом запуске необходимо настроить рабочее место. Для этого нажмите кнопку «Настройки…».

{{картинка|Настройка.png}}

2. В открывшемся окне проверьте IP-адрес, Порт 1 и Порт 2. Значения должны были заполниться автоматически. Если этого не произошло, задайте параметры вручную.

В правой части окна, при необходимости, настройте интеграцию с картами и телефонией. Для этого установите переключатели напротив нужных Вам пунктов. В нашем примере это карты 2ГИС и телефония Oktell.

После того, как были сделаны все необходимые настройки, нажмите кнопку «ОК».

{{info|
Обратите внимание, что при смене портов на сервере, также необходимо изменить их на клиентских местах.
}}

{{картинка|Окно настроек.png}}

== Вход в систему ==

Для входа в систему введите имя пользователя и пароль, убедитесь, что индикаторы внизу окна имеют зеленый цвет (это говорит об успешной загрузке базы данных, ТМ Server и ключа) и нажмите кнопку «Вход».

{{картинка|Вход в систему.png}}

Черновик

2013-12-02T13:29:42Z

AnnaNikolskih:

'''TaxoPhone''' – это современное и удобное мобильное приложение, позволяющее заказать такси без звонка в диспетчерскую. Приложение будет работать на телефонах под управлением операционных систем iOS//тут будет ссылка на документацию для iOS// и Android.

Для того чтобы служба такси могла принимать заказы, поступающие из приложения, необходима интеграция TaxoPhone и программы [[Такси-Мастер]]. Об этом вы можете прочитать в статье [[Настройка приложения TaxoPhone|"Настройка приложения TaxoPhone"]].

== Как получить приложение? ==
Службы такси, желающие получить приложение, обращаются в отдел продаж компании БИТ "Мастер", отправив запрос на {{ящик ОП}}, либо же просто связавшись с менеджером по телефону. Далее БИТ "Мастер" адаптирует детали интерфейса TaxoPhone под конкретные пожелания службы такси. Согласно техническому заданию, разработчики могут снабдить приложение элементами фирменного стиля компании (уникальная заставка при запуске приложения, логотип, корпоративные цвета).

Приложению присваивается индивидуальное название, под которым оно будет доступно в интернет-магазине (возможно название службы). Индивидуальное приложение службы такси будет загружено для скачивания в интернет-магазины Google Play и App Store. В итоге у службы такси появится персональное брендированное мобильное приложение, с помощью которого клиенты смогут воспользоваться только ее услугами.

== Работа в приложении TaxoPhone ==
После установки запустите приложение. Появится окно нового [[заказ]]а, которое выглядит следующим образом.

[[Файл:Окно нового заказа.jpg|300px]]

По возможности определяется текущее местоположение (используются GPS, сотовая сеть и Wi-Fi). При наличии доступа к сети Интернет определяется адрес текущего местоположения. При отсутствии - указываются координаты (широта и долгота).

Чтобы сформировать заказ, нажмите на кнопку {{button|Заказать}}.

Сразу после этого появится форма пожеланий к заказу. В можно уточнить информацию по заявке:

# Уточнение [[Адрес подачи|места подачи]]: квартира, подъезд или произвольный комментарий.
# Остановки.
# Место назначения ("Куда").
# Время поездки (по умолчанию предлагается ехать прямо сейчас).
# Дополнительные параметры: [[группа экипажей]] и требования к заказу.

[[Файл:Форма пожеланий.jpg|300px]]

После заполнения данной формы необходимо нажать на кнопку {{button|Готово}} для создания нового заказа.

Если заказ создавался с помощью данной копии приложения в первый раз, то далее будет необходимо пройти процедуру авторизации.

{{info|
Обратите внимание, что следующие элементы формы пожеланий к заказу доступны для настройки в TaxiMaster (то есть диспетчерской службой):
*Поле для ввода номера квартиры;
*Блок «Остановки»;
*Блок «Куда»;
*Блок «Дополнительно».
Это означает, что отображение любого из данных элементов может быть отключено. Причем блок «Дополнительно» может быть отключен как полностью, так и частично, то есть может присутствовать только возможность выбора экипажа или же только возможность задать дополнительные требования (например, наличие детского кресла).
}}

=== Заполнение профиля и авторизация приложения ===
Пользователю будет необходимо внести информацию о себе и пройти процедуру авторизации. Для этого в открывшейся форме {{tab|Регистрация}} необходимо заполнить поля {{поле|Имя}} и {{поле|Номер телефона}}.

[[Файл:Регистрация.jpg|300px]]

Для завершения авторизации в открывшемся окне {{tab|Подтверждение}} введите уникальный код, который придет в виде СМС-сообщения. Укажите данные цифры в поле {{поле|Код}}. В случае, если возникли проблемы с получением кода, нажмите на кнопку {{кнопка|Получить код повторно}}, после чего сообщение будет выслано на указанный номер телефона еще раз. Обратите внимание на то, что повторное сообщение может быть отправлено не более одного раза в течение трех минут.

[[Файл:Окно подтверждения.jpg|300px]]

После успешной авторизации можно продолжить работу с приложением.

=== Назначение автомобиля на заказ в приложении TaxoPhone ===
После того, как процедура авторизации пройдена, система начнет поиски [[экипаж]]а на ваш заказ. Следить за процессом поиска можно на форме приложения {{tab|Состояние заказа}}.

Состояние меняется в зависимости от действий водителя экипажа и может принимать следующие значения:

# '''Поиск автомобиля''' - автомобиль на ваш заказ пока не найден.
# '''К вам подъезжает''' - на форме появится информация об экипаже, который будет выполнять ваш заказ. Также эти данные придут клиенту в виде уведомления.
# '''Вас ожидает''' - экипаж подъехал по адресу подачи и вы можете выходить к нему.
# '''В пути''' - вы совершаете поездку в такси.
# '''Заказ успешно завершен''' - клиент успешно добрался до пункта назначения и рассчитался с водителем.
# '''Заказ отменен''' - клиент или диспетчерская по каким-либо причинам отменили заказ. В приложении причина отмены неизвестна.

Время от начала поиска автомобиля и до его момента его подачи отображается на таймере.

Клиент может отказаться от заказа в любой момент до того, как он сел в машину. Для этого необходимо нажать на кнопку {{кнопка|Отказаться}}.

После того, как автомобиль назначен, пользователь может позвонить водителю для уточнения каких-либо данных. Для этого необходимо нажать на кнопку {{кнопка|Позвонить}}.

Обратите внимание, что все передвижения экипажа пользователь может отследить на встроенной в приложении карте. Таким образом клиент всегда будет знать местоположение экипажа как до момента прибытия его к месту подачи, так и во время исполнения заказа.

Черновик

2013-12-02T12:23:53Z

AnnaNikolskih: Создание

Черновик

2013-12-02T11:19:55Z

AnnaNikolskih: Новая страница: «bgwrqeg»

bgwrqeg

Файл:Выбор компонентов.png

2013-12-02T06:36:25Z

AnnaNikolskih: AnnaNikolskih загружена новая версия «Файл:Выбор компонентов.png»

Заглавная страница

2013-11-29T09:31:40Z

AnnaNikolskih: 1

__NOTOC__
Здравствуйте. Вы находитесь на странице, содержащей документацию по программе Такси-Мастер. Здесь вы найдете советы и рекомендации по грамотной работе и обслуживанию программы и ее компонентов. Данная информация необходима не только начинающим, но и тем, кто пользуется Такси-Мастер продолжительное время. Возникающие вопросы по документации, а также по функционированию программы, вы можете задать технической поддержке по адресу {{ящик ОТП}}.

{{Внимание|[[Отдел технической поддержки|Как обратиться в техническую поддержку?]]

[[История изменений в программе Такси-Мастер]]

[[:Категория:Видео|Видеообзоры и справочные видеоматериалы по программе Такси-Мастер]]

[[Перед обновлением Такси-Мастер]]

[[Удаленная прошивка ключа Guardant|Удаленная прошивка ключа защиты]]}}

{|class="clean"
|width="33%" valign="top"|
== Интересующимся ==
В данном разделе представлена документация, в которой отражена информация, предназначенная для потенциальных пользователей программы Такси-Мастер.
:*[[Системные требования]]
:*[[Удаленная прошивка ключа Guardant]]
:*[[Удаленная прошивка NET III#Регистрационная информация|Форма для прошивки]]
:*[[Дистрибутив Такси-Мастер|Дистрибутив]]
:*[[Сервер {{TM}}|Серверная часть {{TM}}]]
:*[[Клиент {{TM}}|Клиентская часть {{TM}}]]
:*[[База данных {{TM}}|База данных]]
:*[[Карточка заказа в {{TM}}|Карточка заказа]]
:*[[Анкета на техническое задание на внедрение модуля «Расширенная телефония»]]
|width="33%" valign="top"|

== Пользователям ==
Данный раздел содержит информацию, которая необходима для корректного взаимодействия пользователей с программой Такси-Мастер.
:* [[С чего начать?|С чего начать работу с программой?]]
:* [[Вход в {{TM}}]]
:* [[Запуск {{TM}}]]
:* [[Главное окно {{TM}}]]
:* [[Окно «Заказы» в {{TM}}|Список заказов в {{TM}}]]
:* [[Справочники|Заполнение справочников]]
:* [[Окно «Экипажи» в {{TM}}|Вывод водителя на линию в {{TM}}]]
:* [[Установка водителя на стоянку|Перемещение водителей по стоянкам]]
:* [[Карточка заказа в {{TM}}#Процедура обработки заказа|Принятие заказа]]
:* [[Окно «Экипажи» в Такси-Мастер|Экипажи]]
:* [[Установка нового отчета в ТМ2|Вывод отчета]]
:* [[Карта в польском формате|Карта в польском формате (скачать)]]
|width="33%" valign="top"|

== Бухгалтерам ==
Данный раздел содержит информацию, которая предназначена для бухгалтеров фирмы, поскольку связана с осуществлением операций с денежными средствами.
:* [[Модуль расчетов с водителями в {{TM}}|Расчеты с водителями]]
:* [[Отчеты Такси-Мастер]]

== Видеоуроки ==
В данном разделе находятся видеоматериалы по Такси-Мастер, а также полные инструкции для пользователей программы: оператора, водителя, руководителя, бухгалтера, системного администратора.
:* [[Руководство по программе Такси-Мастер для оператора]]
:** [[Видеоурок по отправке СМС]]
:* Руководство для водителей по TMDriver
:** [[Руководство водителя по работе с TMDriver для Android]]
:** [[Руководство водителя по работе с TMDriver для КПК]]
:** [[Руководство водителя по работе с TMDriver для навигатора]]
:* [[Руководство по программе Такси-Мастер для бухгалтера]]
:* [[Руководство по программе Такси-Мастер для руководителя]]
:* Руководство для системных администраторов
:** [[Вводная информация для системных администраторов]]
:** [[Установка Такси-Мастер и ее компонентов]]
:** [[Видеоурок по настройке модуля СМС]]
:** [[Видеоурок по модулю «Интеграция с картами»]]
:** [[Видеоурок по модулю «Телефония»]]
:** [[Интеграция с платежными системами и локальными терминалами]]
:** Заполнение справочников Такси-Мастер
:*** [[Видеоурок по заполнению справочников, часть 1|Автомобили, Водители, Экипажи, Группы экипажей, Тарифы, Смены тарифов.]]
:*** [[Видеоурок по заполнению справочников, часть 2|Состояния заказы, Варианты изменения состояний заказа, Сдачи с заказов, Смены сдач с заказов]]
:*** [[Видеоурок по заполнению справочников, часть 3|Города, Улицы, Районы, Проезды между районами, Пункты и стоянки]]
:*** [[Видеоурок по заполнению справочников, часть 4|Категории телефонов, Телефоны, Правила изменения категорий телефона, Статистика по телефонам]]
:*** [[Видеоурок по заполнению справочников, часть 5|Скидки, Скидки\наценки, Диск. карты: типы, Диск. карты, Услуги, Штрафы, Шаблоны операций]]
:** [[Видеоурок по утилитам Такси-Мастер]]
:** [[Видеоурок по настройке TM API]]
:** [[Видеоурок по работе с ключом защиты]]
|width="25%" valign="top"|
|-
|width="33%" valign="top"|

== Водителям ==
Данный раздел содержит информацию, которая предназначена для водителей вашей службы такси.
:* [[Мобильное приложение TMDriver|TMDriver]]
:* [[TMDriver для Android]]
:* [[TMDriverNavi|TMDriver для навигаторов]]
:* [[TMDriverPDA|TMDriver для КПК]]
:* [[TMDriverJava|TMDriver для мобильных телефонов под управлением Java]]
|width="33%" valign="top"|

== Системным администраторам ==
Этот раздел несет в себе информацию, связанную с технической частью программы Такси-Мастер.
:* [[Установка {{TM}}]]
:* Настройка
:** [[База данных Такси-Мастер#Доступ по сети|Указание доступа к базе данных на клиентском рабочем месте]]
:** [[Переключение на другую базу данных]]
:** [[Файл настройки доступа к NET III|Указание доступа к серверу Guardant на клиентском рабочем месте]]
:** [[Запуск {{TM}}|Запуск клиентской части Такси-Мастер]]
:** [[Настройка Такси-Мастер|Настройка параметров]]
:* Обновление
:** [[Тест новой версии {{TM}}|Тест новой версии]]
:** [[Обновление {{TM}}]]
:* Дополнение
:** [[Модули {{TM}}|Список существующих модулей]]
:** [[Установка модуля Такси-Мастер]]
:** [[Установка нового отчета в Такси-Мастер]]
:* Резервирование и безопасность
:** [[Утилита резервного копирования#Резервные копии|Настройка резервного копирования базы данных]]
:** [[Утилита резервного копирования#Восстановление из резервной копии|Восстановление базы данных из резервной копии]]
:** [[Резервирование заказов]]
:** [[Перенос базы данных|Перенос базы данных на другой компьютер]]
:** [[Резервное рабочее место]]
:* Журналирование и устранение ошибок
:** [[Журнал работы Такси-Мастер#{{TM}}|Журнал работы {{TM}}]]
:** [[Журнал обновления базы данных]]
:** [[Журнал работы сервера сообщений]]
:** [[Журнал работы сервера связи с водителями]]
|width="33%" valign="top"|

== ==
:* [[Модуль «Интеграция с картами»]]
:* [[Интеграция с Яндекс.Такси]]
:* [[TM API]]
:* [[Модуль интеграции с платежными системами]]
:* [[Модуль интеграции с локальными терминалами]]
:* [[Модуль «Единая диспетчерская служба»]]
:* Утилиты Такси-Мастер
:** Утилиты для работы с [[База данных {{TM}}|базой данных]]
:*** [[Утилита администрирования базы данных]]
:*** [[Утилита резервного копирования]]
:*** [[TMDBConverter|Утилита конвертирования базы данных]]
:** Утилиты для работы с [[Guardant NET III|ключом защиты]]
:*** [[Утилита удаленной прошивки NET III|Утилита удаленной прошивки]]
:*** [[Утилита диагностики Guardant|Утилита диагностики ключа защиты]]
:** Утилиты для работы с картой
:*** [[TMSI|Утилита импорта улиц из карты в базу данных]]
:*** [[RemakeAddress|Утилита переопределения адреса на карте]]
:* COM-объекты
:** Компоненты COM для работы модулей
:*** [[Spsdksvr]] [[Модуль интеграции с устройствами записи SpRecord|(Модуль SpRecord)]]
:*** [[RanCom|RanderCom]] [[Модуль интеграции с программным обеспечением Rander|(Модуль Rander)]]
:*** [[GWX]] [[Модуль интеграции с картами Ингит]]
:*** [[TMManager]] (объект для интеграции внешнего ПО с [[{{TM}}]])
:** Настройка COM
:*** [[Регистрация COM-объекта]]
:* Архитектура компонентов
:** [[Сервер Firebird]]
:** [[Клиент Firebird]]
:** [[Сервер Guardant]]
:** [[Клиент Guardant]]
:* [[Модуль «Интернет-заказы»]]
|width="33%" valign="top"|
|}

{|
|rowspan = "3" {{table/th|FFFF99}}|Техническая поддержка
|[[Отдел технической поддержки]]
|-
|[[Удаленный доступ к рабочему столу|Удаленное администрирование]]
|-
|[[Внедрение Такси-Мастер|Услуга «Внедрение»]]
|}

{{внимание|Ссылки для скачивания}}
<div align="center">
{|
![[Сервер связи с водителями]]
|[[Компоненты модуля «Связь с водителями»]]
|-
![[Сервер сообщений]]
|[[СМС-сервер|Компоненты модуля СМС]]
|}
</div>

<div style="margin: 16px auto 6px; border: 1px solid #F2C50D; padding: 7px; -moz-border-radius: 5px; background-color: #FFF4CC; text-align: justify; width: 650px;">
* Если у вас есть вопросы по содержимому документации, отправляйте их на {{ящик ОТП}}.
* Если вы не можете найти интересующую вас информацию штатными средствами, [http://www.google.ru/cse/home?cx=partner-pub-0851829766593846:pvfmiog6qk6 воспользуйтесь поиском Google].
* Вы можете просмотреть список всех имеющихся страниц документации [[:Служебная:AllPages|на спецстранице «Все страницы»]].</div>

Заглавная страница

2013-11-29T09:30:46Z

AnnaNikolskih: 1

__NOTOC__
Здравствуйте. Вы находитесь на странице, содержащей документацию по программе Такси-Мастер. Здесь вы найдете советы и рекомендации по грамотной работе и обслуживанию программы и ее компонентов. Данная информация необходима не только начинающим, но и тем, кто пользуется Такси-Мастер продолжительное время. Возникающие вопросы по документации, а также по функционированию программы, вы можете задать технической поддержке по адресу {{ящик ОТП}}.

{{Внимание|[[Отдел технической поддержки|Как обратиться в техническую поддержку?]]

[[История изменений в программе Такси-Мастер]]

[[:Категория:Видео|Видеообзоры и справочные видеоматериалы по программе Такси-Мастер]]

[[Перед обновлением Такси-Мастер]]

[[Удаленная прошивка ключа Guardant|Удаленная прошивка ключа защиты]]}}

{|class="clean"
|width="33%" valign="top"|
== Интересующимся ==
В данном разделе представлена документация, в которой отражена информация, предназначенная для потенциальных пользователей программы Такси-Мастер.
:*[[Системные требования]]
:*[[Удаленная прошивка ключа Guardant]]
:*[[Удаленная прошивка NET III#Регистрационная информация|Форма для прошивки]]
:*[[Дистрибутив Такси-Мастер|Дистрибутив]]
:*[[Сервер {{TM}}|Серверная часть {{TM}}]]
:*[[Клиент {{TM}}|Клиентская часть {{TM}}]]
:*[[База данных {{TM}}|База данных]]
:*[[Карточка заказа в {{TM}}|Карточка заказа]]
:*[[Анкета на техническое задание на внедрение модуля «Расширенная телефония»]]
:*[[Редактирование]]
|width="33%" valign="top"|

== Пользователям ==
Данный раздел содержит информацию, которая необходима для корректного взаимодействия пользователей с программой Такси-Мастер.
:* [[С чего начать?|С чего начать работу с программой?]]
:* [[Вход в {{TM}}]]
:* [[Запуск {{TM}}]]
:* [[Главное окно {{TM}}]]
:* [[Окно «Заказы» в {{TM}}|Список заказов в {{TM}}]]
:* [[Справочники|Заполнение справочников]]
:* [[Окно «Экипажи» в {{TM}}|Вывод водителя на линию в {{TM}}]]
:* [[Установка водителя на стоянку|Перемещение водителей по стоянкам]]
:* [[Карточка заказа в {{TM}}#Процедура обработки заказа|Принятие заказа]]
:* [[Окно «Экипажи» в Такси-Мастер|Экипажи]]
:* [[Установка нового отчета в ТМ2|Вывод отчета]]
:* [[Карта в польском формате|Карта в польском формате (скачать)]]
|width="33%" valign="top"|

== Бухгалтерам ==
Данный раздел содержит информацию, которая предназначена для бухгалтеров фирмы, поскольку связана с осуществлением операций с денежными средствами.
:* [[Модуль расчетов с водителями в {{TM}}|Расчеты с водителями]]
:* [[Отчеты Такси-Мастер]]

== Видеоуроки ==
В данном разделе находятся видеоматериалы по Такси-Мастер, а также полные инструкции для пользователей программы: оператора, водителя, руководителя, бухгалтера, системного администратора.
:* [[Руководство по программе Такси-Мастер для оператора]]
:** [[Видеоурок по отправке СМС]]
:* Руководство для водителей по TMDriver
:** [[Руководство водителя по работе с TMDriver для Android]]
:** [[Руководство водителя по работе с TMDriver для КПК]]
:** [[Руководство водителя по работе с TMDriver для навигатора]]
:* [[Руководство по программе Такси-Мастер для бухгалтера]]
:* [[Руководство по программе Такси-Мастер для руководителя]]
:* Руководство для системных администраторов
:** [[Вводная информация для системных администраторов]]
:** [[Установка Такси-Мастер и ее компонентов]]
:** [[Видеоурок по настройке модуля СМС]]
:** [[Видеоурок по модулю «Интеграция с картами»]]
:** [[Видеоурок по модулю «Телефония»]]
:** [[Интеграция с платежными системами и локальными терминалами]]
:** Заполнение справочников Такси-Мастер
:*** [[Видеоурок по заполнению справочников, часть 1|Автомобили, Водители, Экипажи, Группы экипажей, Тарифы, Смены тарифов.]]
:*** [[Видеоурок по заполнению справочников, часть 2|Состояния заказы, Варианты изменения состояний заказа, Сдачи с заказов, Смены сдач с заказов]]
:*** [[Видеоурок по заполнению справочников, часть 3|Города, Улицы, Районы, Проезды между районами, Пункты и стоянки]]
:*** [[Видеоурок по заполнению справочников, часть 4|Категории телефонов, Телефоны, Правила изменения категорий телефона, Статистика по телефонам]]
:*** [[Видеоурок по заполнению справочников, часть 5|Скидки, Скидки\наценки, Диск. карты: типы, Диск. карты, Услуги, Штрафы, Шаблоны операций]]
:** [[Видеоурок по утилитам Такси-Мастер]]
:** [[Видеоурок по настройке TM API]]
:** [[Видеоурок по работе с ключом защиты]]
|width="25%" valign="top"|
|-
|width="33%" valign="top"|

== Водителям ==
Данный раздел содержит информацию, которая предназначена для водителей вашей службы такси.
:* [[Мобильное приложение TMDriver|TMDriver]]
:* [[TMDriver для Android]]
:* [[TMDriverNavi|TMDriver для навигаторов]]
:* [[TMDriverPDA|TMDriver для КПК]]
:* [[TMDriverJava|TMDriver для мобильных телефонов под управлением Java]]
|width="33%" valign="top"|

== Системным администраторам ==
Этот раздел несет в себе информацию, связанную с технической частью программы Такси-Мастер.
:* [[Установка {{TM}}]]
:* Настройка
:** [[База данных Такси-Мастер#Доступ по сети|Указание доступа к базе данных на клиентском рабочем месте]]
:** [[Переключение на другую базу данных]]
:** [[Файл настройки доступа к NET III|Указание доступа к серверу Guardant на клиентском рабочем месте]]
:** [[Запуск {{TM}}|Запуск клиентской части Такси-Мастер]]
:** [[Настройка Такси-Мастер|Настройка параметров]]
:* Обновление
:** [[Тест новой версии {{TM}}|Тест новой версии]]
:** [[Обновление {{TM}}]]
:* Дополнение
:** [[Модули {{TM}}|Список существующих модулей]]
:** [[Установка модуля Такси-Мастер]]
:** [[Установка нового отчета в Такси-Мастер]]
:* Резервирование и безопасность
:** [[Утилита резервного копирования#Резервные копии|Настройка резервного копирования базы данных]]
:** [[Утилита резервного копирования#Восстановление из резервной копии|Восстановление базы данных из резервной копии]]
:** [[Резервирование заказов]]
:** [[Перенос базы данных|Перенос базы данных на другой компьютер]]
:** [[Резервное рабочее место]]
:* Журналирование и устранение ошибок
:** [[Журнал работы Такси-Мастер#{{TM}}|Журнал работы {{TM}}]]
:** [[Журнал обновления базы данных]]
:** [[Журнал работы сервера сообщений]]
:** [[Журнал работы сервера связи с водителями]]
|width="33%" valign="top"|

== ==
:* [[Модуль «Интеграция с картами»]]
:* [[Интеграция с Яндекс.Такси]]
:* [[TM API]]
:* [[Модуль интеграции с платежными системами]]
:* [[Модуль интеграции с локальными терминалами]]
:* [[Модуль «Единая диспетчерская служба»]]
:* Утилиты Такси-Мастер
:** Утилиты для работы с [[База данных {{TM}}|базой данных]]
:*** [[Утилита администрирования базы данных]]
:*** [[Утилита резервного копирования]]
:*** [[TMDBConverter|Утилита конвертирования базы данных]]
:** Утилиты для работы с [[Guardant NET III|ключом защиты]]
:*** [[Утилита удаленной прошивки NET III|Утилита удаленной прошивки]]
:*** [[Утилита диагностики Guardant|Утилита диагностики ключа защиты]]
:** Утилиты для работы с картой
:*** [[TMSI|Утилита импорта улиц из карты в базу данных]]
:*** [[RemakeAddress|Утилита переопределения адреса на карте]]
:* COM-объекты
:** Компоненты COM для работы модулей
:*** [[Spsdksvr]] [[Модуль интеграции с устройствами записи SpRecord|(Модуль SpRecord)]]
:*** [[RanCom|RanderCom]] [[Модуль интеграции с программным обеспечением Rander|(Модуль Rander)]]
:*** [[GWX]] [[Модуль интеграции с картами Ингит]]
:*** [[TMManager]] (объект для интеграции внешнего ПО с [[{{TM}}]])
:** Настройка COM
:*** [[Регистрация COM-объекта]]
:* Архитектура компонентов
:** [[Сервер Firebird]]
:** [[Клиент Firebird]]
:** [[Сервер Guardant]]
:** [[Клиент Guardant]]
:* [[Модуль «Интернет-заказы»]]
|width="33%" valign="top"|
|}

{|
|rowspan = "3" {{table/th|FFFF99}}|Техническая поддержка
|[[Отдел технической поддержки]]
|-
|[[Удаленный доступ к рабочему столу|Удаленное администрирование]]
|-
|[[Внедрение Такси-Мастер|Услуга «Внедрение»]]
|}

{{внимание|Ссылки для скачивания}}
<div align="center">
{|
![[Сервер связи с водителями]]
|[[Компоненты модуля «Связь с водителями»]]
|-
![[Сервер сообщений]]
|[[СМС-сервер|Компоненты модуля СМС]]
|}
</div>

<div style="margin: 16px auto 6px; border: 1px solid #F2C50D; padding: 7px; -moz-border-radius: 5px; background-color: #FFF4CC; text-align: justify; width: 650px;">
* Если у вас есть вопросы по содержимому документации, отправляйте их на {{ящик ОТП}}.
* Если вы не можете найти интересующую вас информацию штатными средствами, [http://www.google.ru/cse/home?cx=partner-pub-0851829766593846:pvfmiog6qk6 воспользуйтесь поиском Google].
* Вы можете просмотреть список всех имеющихся страниц документации [[:Служебная:AllPages|на спецстранице «Все страницы»]].</div>

Как настроить рабочее место Такси-Мастер?

2013-11-29T09:30:03Z

AnnaNikolskih: 1

'''{{PAGENAME}}''' Ответ на этот вопрос будет изложен ниже.
Полная настройка рабочего места включает в себя несколько этапов:

# [[#Установка|Установка Такси-Мастер]].
# [[#Подключение к базе данных|Настройка подключения к серверу Такси-Мастер]] (к базе данных).
# [[#Подключение к серверу Guardant|Настройка подключения к серверу Guardant]].

На первом рабочем месте, которое будет вашим [[Сервер Такси-Мастер|сервером]], необходимо также проделать ряд важных действий:

# [[#Подключение ключа защиты|Подключить ключ защиты]].
# [[#Установка ПО для ключа|Установить для ключа необходимое программное обеспечение]].
# [[#Установка Firebird|Установить СУБД Firebird]], под управлением которой будет работать база данных.

== Подключение ключа защиты ==
{{also|[[NET III]]|подпись=Основная статья:}}
'''Ключ защиты Guardant NET III''' содержит внутри себя всю лицензионную информацию, необходимую для запуска Такси-Мастер.
Разъем, к которому необходимо подключать ключ защиты, — USB.
Все, что нужно сделать с ключом, — это подключить его к компьютеру.

После подключения операционная система начнет искать подходящий драйвер.
Скорее всего, ей это не удастся.
Драйвер вы установите в дальнейшем вместе с [[#Установка ПО для ключа|остальным программным обеспечением]] для ключа.

Запомните IP-адрес компьютера, к которому подключили ключ защиты.
Подразумевается, что компьютер, к которому подключен ключ, — сервер, поэтому далее в примерах будет использоваться адрес {{code|192.168.0.1}} (см. [[#Установка на сервер|ниже]]).

== Установка ПО для ключа ==
После того, как вы подключили ключ защиты к компьютеру, необходимо установить для ключа программное обеспечение.
Это программное обеспечение включает в себя два компонента:

# Драйвер ключа Guardant NET III.
# [[Сервер Guardant]].

Драйвер устанавливается ''из [[Дистрибутив Такси-Мастер|дистрибутива Такси-Мастер]]''.
После установки драйвера вы сможете заметить, что зеленый светодиод на ключе защиты загорелся (до этого он мог только мигать).

[[Сервер Guardant]] также устанавливается из дистрибутива Такси-Мастер.
Чтобы убедиться в том, что сервер Guardant будет установлен, при установке Такси-Мастер на шаге выбора компонентов убедитесь в том, что флажок {{checkbox|Сервер GuardantNet3}} ''установлен:''

{{картинка/по центру|Флажок Сервер GuardantNet3 при установке ТМ1.png}}

Подробнее об установке Такси-Мастер вы сможете почитать [[#Установка|ниже]].

== Установка ==
{{also|[[Установка Такси-Мастер]]|подпись=Основная статья:}}
Установка Такси-Мастер происходит по-разному на сервер Такси-Мастер и на клиентские рабочие места.
В первом случае необходимо установить дополнительные компоненты: [[Firebird]] и [[сервер Guardant]], но требуется меньше настроек.
Во втором случае эти компоненты устанавливать не нужно, но необходимо выполнить дополнительную настройку (на каждом рабочем месте).

=== Установка на сервер ===
{{also|[[Сервер Такси-Мастер]]|подпись=Основная статья:}}
{{картинка/по центру|Предустановка Установка на сервер ТМ1.png}}
Чтобы установить серверную часть Такси-Мастер, запустите дистрибутив и следуйте инструкциям.
На шаге выбора компонентов, как указано на изображении выше, выберите предустановку «Установка на сервер» — ниже установятся флажки напротив всех необходимых компонентов.
Обратите внимание, что среди таких компонентов присутствуют:

# [[Сервер Firebird]].
# [[Сервер Guardant]].

Это означает, что, во-первых, база данных будет работать на компьютере-сервере (отчасти поэтому он называется сервером); а во-вторых, ключ будет подключен именно к этому компьютеру.
Если вы, [[#Подключение ключа защиты|следуя инструкции по подключению ключа]], выполняли эти действия на данном рабочем месте, то больше ничего делать не нужно.
Продолжайте установку.

После установки вам потребуется узнать IP-адрес данного компьютера, который в дальнейшем пригодится при [[#Установка на клиент|установке Такси-Мастер на клиентские компьютеры]].
Рекомендуем вам выбирать для компьютера-сервера IP-адрес вида {{code|192.168.0.1}}.

=== Установка на клиент ===
{{картинка/по центру|Предустановка Установка на клиент ТМ1.png}}
В отличие от [[#Установка на сервер|установки на сервер]], установка на клиент происходит немного другим образом.
В частности, такие компоненты, как Firebird и сервер Guardant, не устанавливаются (вместо последнего устанавливается компонент «Клиент Guardant»).
Это первый момент — выбрать на шаге выбора компонентов предустановку «Установка клиентской части».

Второй важный момент при установке — указать путь к базе данных, которая работает на компьютере-сервере:

{{картинка/по центру|Путь к серверу и базе данных при установке ТМ1.png}}

Обратите внимание на поле {{field|Имя сервера}}: в это поле необходимо вводить IP-адрес или имя компьютера, на котором находится ваша рабочая база данных.
В данном примере указан IP-адрес {{code|192.168.0.1}}, который принят в качестве примера [[#Установка на сервер|выше]].
Этот IP-адрес необходимо будет вводить ''на всех'' компьютерах-клиентах при установке клиентской части Такси-Мастер.

== Подключение к базе данных ==
{{also|[[Подключение к базе данных]]|подпись=Основная статья:}}
Подключение к базе данных настраивается непосредственно в Такс-Мастер или в [[Taxi.ini|специальном файле настроек]].
Второй вариант гораздо быстрее, поэтому рассмотрим его.

Обратите внимание, что по умолчанию после установки Такси-Мастер в этом файле записан путь к базе данных на ''локальном'' компьютере.
Это значит, что на компьютере-сервере подключение к базе данных можно не настраивать.
Тем не менее, на компьютерах-клиентах подключение настраивать ''необходимо''.

Чтобы настроить подключение к базе данных (второй вариант), выполните следующие действия:
# Откройте папку, в которую установлена клиентская часть Такси-Мастер. По умолчанию это папка {{путь к папке ТМ1}}.
# Найдите файл {{путь|Taxi.ini}} и откройте его в Блокноте.
# Найдите строку {{code/(}}DatabaseName=...{{code/)}}. Она находится практически в самом начале файла и по умолчанию выглядит так: {{code/(}}DatabaseName=LOCALHOST:C:\Program Files\Taxi\Data.gdb{{code/)}}.
# Замените указанное имя компьютера ({{code|LOCALHOST}}) на IP-адрес компьютера-сервера. Например, так: {{code/(}}DatabaseName=192.168.0.1:C:\Program Files\Taxi\Data.gdb{{code/)}}.
# Сохраните файл.

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

== Подключение к серверу Guardant ==
{{also|{{code|[[gnclient.ini]]}}|подпись=Основная статья:}}
Настройка подключения к [[Сервер Guardant|серверу Guardant]] необходима для того, чтобы программа Такси-Мастер на клиентском рабочем месте могла запуститься.
Подключение к серверу Guardant никак не связано с [[#Подключение к базе данных|подключением к базе данных]], и его настрйока происходит в [[gnclient.ini|другом настроечном файле]]:

# Откройте папку, в которую установлена клиентская часть Такси-Мастер. По умолчанию это папка {{путь к папке ТМ1}}.
# Найдите файл {{путь|gnclient.ini}} и откройте его в Блокноте.
# Найдите строку {{code/(}}IP_NAME=...{{code/)}}. Она находится ближе к концу файла и по умолчанию выглядит так: {{code/(}}IP_NAME=LOCALHOST{{code/)}} или {{code/(}}IP_NAME=127.0.0.1{{code/)}}.
# Замените указанное имя компьютера (или IP-адрес) на IP-адрес компьютера, к которому [[#Подключение ключа защиты|подключен ключ защиты]]. Например, как было принято [[#Подключение ключа защиты|выше]], укажите адрес {{code|192.168.0.1}}: {{code/(}}IP_NAME=192.168.0.1{{code/)}}.
# Сохраните файл.

Эти действия, как и в случае с [[#Подключение к базе данных|настройкой подключения к базе данных]], необходимо выполнить на всех-компьютерах клиентах.
На компьютере-сервере будет работать настройка по умолчанию.

== Запуск Такси-Мастер ==
После всех выполненных настроек запустите Такси-Мастер.
Если на каком-то из рабочих мест Такси-Мастер не запустится, соберите все файлы с расширением {{code|.log}} из папки Такси-Мастер и вложенных папок, и отправьте их вместе с письмом на {{ящик ОТП}}.

{{info|Вы можете использовать [[TMSysInfo|утилиту сбора информации о системе]] для сбора всех необходимых файлов с расширением {{code|.log}}.}}

[[Категория:Вопросы]]
[[Категория:Установка]]
[[Категория:Настройка]]

Как настроить рабочее место Такси-Мастер?

2013-11-29T09:29:31Z

AnnaNikolskih: 1

'''{{PAGENAME}}''' Ответ на этот вопрос будет изложен ниже.
Полная настройка рабочего места включает в себя несколько этапов:

# [[#Редактирование|служебная страница]].
# [[#Установка|Установка Такси-Мастер]].
# [[#Подключение к базе данных|Настройка подключения к серверу Такси-Мастер]] (к базе данных).
# [[#Подключение к серверу Guardant|Настройка подключения к серверу Guardant]].

На первом рабочем месте, которое будет вашим [[Сервер Такси-Мастер|сервером]], необходимо также проделать ряд важных действий:

# [[#Подключение ключа защиты|Подключить ключ защиты]].
# [[#Установка ПО для ключа|Установить для ключа необходимое программное обеспечение]].
# [[#Установка Firebird|Установить СУБД Firebird]], под управлением которой будет работать база данных.

== Подключение ключа защиты ==
{{also|[[NET III]]|подпись=Основная статья:}}
'''Ключ защиты Guardant NET III''' содержит внутри себя всю лицензионную информацию, необходимую для запуска Такси-Мастер.
Разъем, к которому необходимо подключать ключ защиты, — USB.
Все, что нужно сделать с ключом, — это подключить его к компьютеру.

После подключения операционная система начнет искать подходящий драйвер.
Скорее всего, ей это не удастся.
Драйвер вы установите в дальнейшем вместе с [[#Установка ПО для ключа|остальным программным обеспечением]] для ключа.

Запомните IP-адрес компьютера, к которому подключили ключ защиты.
Подразумевается, что компьютер, к которому подключен ключ, — сервер, поэтому далее в примерах будет использоваться адрес {{code|192.168.0.1}} (см. [[#Установка на сервер|ниже]]).

== Установка ПО для ключа ==
После того, как вы подключили ключ защиты к компьютеру, необходимо установить для ключа программное обеспечение.
Это программное обеспечение включает в себя два компонента:

# Драйвер ключа Guardant NET III.
# [[Сервер Guardant]].

Драйвер устанавливается ''из [[Дистрибутив Такси-Мастер|дистрибутива Такси-Мастер]]''.
После установки драйвера вы сможете заметить, что зеленый светодиод на ключе защиты загорелся (до этого он мог только мигать).

[[Сервер Guardant]] также устанавливается из дистрибутива Такси-Мастер.
Чтобы убедиться в том, что сервер Guardant будет установлен, при установке Такси-Мастер на шаге выбора компонентов убедитесь в том, что флажок {{checkbox|Сервер GuardantNet3}} ''установлен:''

{{картинка/по центру|Флажок Сервер GuardantNet3 при установке ТМ1.png}}

Подробнее об установке Такси-Мастер вы сможете почитать [[#Установка|ниже]].

== Установка ==
{{also|[[Установка Такси-Мастер]]|подпись=Основная статья:}}
Установка Такси-Мастер происходит по-разному на сервер Такси-Мастер и на клиентские рабочие места.
В первом случае необходимо установить дополнительные компоненты: [[Firebird]] и [[сервер Guardant]], но требуется меньше настроек.
Во втором случае эти компоненты устанавливать не нужно, но необходимо выполнить дополнительную настройку (на каждом рабочем месте).

=== Установка на сервер ===
{{also|[[Сервер Такси-Мастер]]|подпись=Основная статья:}}
{{картинка/по центру|Предустановка Установка на сервер ТМ1.png}}
Чтобы установить серверную часть Такси-Мастер, запустите дистрибутив и следуйте инструкциям.
На шаге выбора компонентов, как указано на изображении выше, выберите предустановку «Установка на сервер» — ниже установятся флажки напротив всех необходимых компонентов.
Обратите внимание, что среди таких компонентов присутствуют:

# [[Сервер Firebird]].
# [[Сервер Guardant]].

Это означает, что, во-первых, база данных будет работать на компьютере-сервере (отчасти поэтому он называется сервером); а во-вторых, ключ будет подключен именно к этому компьютеру.
Если вы, [[#Подключение ключа защиты|следуя инструкции по подключению ключа]], выполняли эти действия на данном рабочем месте, то больше ничего делать не нужно.
Продолжайте установку.

После установки вам потребуется узнать IP-адрес данного компьютера, который в дальнейшем пригодится при [[#Установка на клиент|установке Такси-Мастер на клиентские компьютеры]].
Рекомендуем вам выбирать для компьютера-сервера IP-адрес вида {{code|192.168.0.1}}.

=== Установка на клиент ===
{{картинка/по центру|Предустановка Установка на клиент ТМ1.png}}
В отличие от [[#Установка на сервер|установки на сервер]], установка на клиент происходит немного другим образом.
В частности, такие компоненты, как Firebird и сервер Guardant, не устанавливаются (вместо последнего устанавливается компонент «Клиент Guardant»).
Это первый момент — выбрать на шаге выбора компонентов предустановку «Установка клиентской части».

Второй важный момент при установке — указать путь к базе данных, которая работает на компьютере-сервере:

{{картинка/по центру|Путь к серверу и базе данных при установке ТМ1.png}}

Обратите внимание на поле {{field|Имя сервера}}: в это поле необходимо вводить IP-адрес или имя компьютера, на котором находится ваша рабочая база данных.
В данном примере указан IP-адрес {{code|192.168.0.1}}, который принят в качестве примера [[#Установка на сервер|выше]].
Этот IP-адрес необходимо будет вводить ''на всех'' компьютерах-клиентах при установке клиентской части Такси-Мастер.

== Подключение к базе данных ==
{{also|[[Подключение к базе данных]]|подпись=Основная статья:}}
Подключение к базе данных настраивается непосредственно в Такс-Мастер или в [[Taxi.ini|специальном файле настроек]].
Второй вариант гораздо быстрее, поэтому рассмотрим его.

Обратите внимание, что по умолчанию после установки Такси-Мастер в этом файле записан путь к базе данных на ''локальном'' компьютере.
Это значит, что на компьютере-сервере подключение к базе данных можно не настраивать.
Тем не менее, на компьютерах-клиентах подключение настраивать ''необходимо''.

Чтобы настроить подключение к базе данных (второй вариант), выполните следующие действия:
# Откройте папку, в которую установлена клиентская часть Такси-Мастер. По умолчанию это папка {{путь к папке ТМ1}}.
# Найдите файл {{путь|Taxi.ini}} и откройте его в Блокноте.
# Найдите строку {{code/(}}DatabaseName=...{{code/)}}. Она находится практически в самом начале файла и по умолчанию выглядит так: {{code/(}}DatabaseName=LOCALHOST:C:\Program Files\Taxi\Data.gdb{{code/)}}.
# Замените указанное имя компьютера ({{code|LOCALHOST}}) на IP-адрес компьютера-сервера. Например, так: {{code/(}}DatabaseName=192.168.0.1:C:\Program Files\Taxi\Data.gdb{{code/)}}.
# Сохраните файл.

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

== Подключение к серверу Guardant ==
{{also|{{code|[[gnclient.ini]]}}|подпись=Основная статья:}}
Настройка подключения к [[Сервер Guardant|серверу Guardant]] необходима для того, чтобы программа Такси-Мастер на клиентском рабочем месте могла запуститься.
Подключение к серверу Guardant никак не связано с [[#Подключение к базе данных|подключением к базе данных]], и его настрйока происходит в [[gnclient.ini|другом настроечном файле]]:

# Откройте папку, в которую установлена клиентская часть Такси-Мастер. По умолчанию это папка {{путь к папке ТМ1}}.
# Найдите файл {{путь|gnclient.ini}} и откройте его в Блокноте.
# Найдите строку {{code/(}}IP_NAME=...{{code/)}}. Она находится ближе к концу файла и по умолчанию выглядит так: {{code/(}}IP_NAME=LOCALHOST{{code/)}} или {{code/(}}IP_NAME=127.0.0.1{{code/)}}.
# Замените указанное имя компьютера (или IP-адрес) на IP-адрес компьютера, к которому [[#Подключение ключа защиты|подключен ключ защиты]]. Например, как было принято [[#Подключение ключа защиты|выше]], укажите адрес {{code|192.168.0.1}}: {{code/(}}IP_NAME=192.168.0.1{{code/)}}.
# Сохраните файл.

Эти действия, как и в случае с [[#Подключение к базе данных|настройкой подключения к базе данных]], необходимо выполнить на всех-компьютерах клиентах.
На компьютере-сервере будет работать настройка по умолчанию.

== Запуск Такси-Мастер ==
После всех выполненных настроек запустите Такси-Мастер.
Если на каком-то из рабочих мест Такси-Мастер не запустится, соберите все файлы с расширением {{code|.log}} из папки Такси-Мастер и вложенных папок, и отправьте их вместе с письмом на {{ящик ОТП}}.

{{info|Вы можете использовать [[TMSysInfo|утилиту сбора информации о системе]] для сбора всех необходимых файлов с расширением {{code|.log}}.}}

[[Категория:Вопросы]]
[[Категория:Установка]]
[[Категория:Настройка]]

Как настроить рабочее место Такси-Мастер?

2013-11-29T09:27:11Z

AnnaNikolskih: 1

'''{{PAGENAME}}''' Ответ на этот вопрос будет изложен ниже.
Полная настройка рабочего места включает в себя несколько этапов:

# [[#Установка|Установка Такси-Мастер]].
# [[#Подключение к базе данных|Настройка подключения к серверу Такси-Мастер]] (к базе данных).
# [[#Подключение к серверу Guardant|Настройка подключения к серверу Guardant]].

На первом рабочем месте, которое будет вашим [[Сервер Такси-Мастер|сервером]], необходимо также проделать ряд важных действий:

# [[#Подключение ключа защиты|Подключить ключ защиты]].
# [[#Установка ПО для ключа|Установить для ключа необходимое программное обеспечение]].
# [[#Установка Firebird|Установить СУБД Firebird]], под управлением которой будет работать база данных.

== Подключение ключа защиты ==
{{also|[[Системные_требования]]|подпись=Основная статья:}}
{{also|[[NET III]]|подпись=Основная статья:}}
'''Ключ защиты Guardant NET III''' содержит внутри себя всю лицензионную информацию, необходимую для запуска Такси-Мастер.
Разъем, к которому необходимо подключать ключ защиты, — USB.
Все, что нужно сделать с ключом, — это подключить его к компьютеру.

После подключения операционная система начнет искать подходящий драйвер.
Скорее всего, ей это не удастся.
Драйвер вы установите в дальнейшем вместе с [[#Установка ПО для ключа|остальным программным обеспечением]] для ключа.

Запомните IP-адрес компьютера, к которому подключили ключ защиты.
Подразумевается, что компьютер, к которому подключен ключ, — сервер, поэтому далее в примерах будет использоваться адрес {{code|192.168.0.1}} (см. [[#Установка на сервер|ниже]]).

== Установка ПО для ключа ==
После того, как вы подключили ключ защиты к компьютеру, необходимо установить для ключа программное обеспечение.
Это программное обеспечение включает в себя два компонента:

# Драйвер ключа Guardant NET III.
# [[Сервер Guardant]].

Драйвер устанавливается ''из [[Дистрибутив Такси-Мастер|дистрибутива Такси-Мастер]]''.
После установки драйвера вы сможете заметить, что зеленый светодиод на ключе защиты загорелся (до этого он мог только мигать).

[[Сервер Guardant]] также устанавливается из дистрибутива Такси-Мастер.
Чтобы убедиться в том, что сервер Guardant будет установлен, при установке Такси-Мастер на шаге выбора компонентов убедитесь в том, что флажок {{checkbox|Сервер GuardantNet3}} ''установлен:''

{{картинка/по центру|Флажок Сервер GuardantNet3 при установке ТМ1.png}}

Подробнее об установке Такси-Мастер вы сможете почитать [[#Установка|ниже]].

== Установка ==
{{also|[[Установка Такси-Мастер]]|подпись=Основная статья:}}
Установка Такси-Мастер происходит по-разному на сервер Такси-Мастер и на клиентские рабочие места.
В первом случае необходимо установить дополнительные компоненты: [[Firebird]] и [[сервер Guardant]], но требуется меньше настроек.
Во втором случае эти компоненты устанавливать не нужно, но необходимо выполнить дополнительную настройку (на каждом рабочем месте).

=== Установка на сервер ===
{{also|[[Сервер Такси-Мастер]]|подпись=Основная статья:}}
{{картинка/по центру|Предустановка Установка на сервер ТМ1.png}}
Чтобы установить серверную часть Такси-Мастер, запустите дистрибутив и следуйте инструкциям.
На шаге выбора компонентов, как указано на изображении выше, выберите предустановку «Установка на сервер» — ниже установятся флажки напротив всех необходимых компонентов.
Обратите внимание, что среди таких компонентов присутствуют:

# [[Сервер Firebird]].
# [[Сервер Guardant]].

Это означает, что, во-первых, база данных будет работать на компьютере-сервере (отчасти поэтому он называется сервером); а во-вторых, ключ будет подключен именно к этому компьютеру.
Если вы, [[#Подключение ключа защиты|следуя инструкции по подключению ключа]], выполняли эти действия на данном рабочем месте, то больше ничего делать не нужно.
Продолжайте установку.

После установки вам потребуется узнать IP-адрес данного компьютера, который в дальнейшем пригодится при [[#Установка на клиент|установке Такси-Мастер на клиентские компьютеры]].
Рекомендуем вам выбирать для компьютера-сервера IP-адрес вида {{code|192.168.0.1}}.

=== Установка на клиент ===
{{картинка/по центру|Предустановка Установка на клиент ТМ1.png}}
В отличие от [[#Установка на сервер|установки на сервер]], установка на клиент происходит немного другим образом.
В частности, такие компоненты, как Firebird и сервер Guardant, не устанавливаются (вместо последнего устанавливается компонент «Клиент Guardant»).
Это первый момент — выбрать на шаге выбора компонентов предустановку «Установка клиентской части».

Второй важный момент при установке — указать путь к базе данных, которая работает на компьютере-сервере:

{{картинка/по центру|Путь к серверу и базе данных при установке ТМ1.png}}

Обратите внимание на поле {{field|Имя сервера}}: в это поле необходимо вводить IP-адрес или имя компьютера, на котором находится ваша рабочая база данных.
В данном примере указан IP-адрес {{code|192.168.0.1}}, который принят в качестве примера [[#Установка на сервер|выше]].
Этот IP-адрес необходимо будет вводить ''на всех'' компьютерах-клиентах при установке клиентской части Такси-Мастер.

== Подключение к базе данных ==
{{also|[[Подключение к базе данных]]|подпись=Основная статья:}}
Подключение к базе данных настраивается непосредственно в Такс-Мастер или в [[Taxi.ini|специальном файле настроек]].
Второй вариант гораздо быстрее, поэтому рассмотрим его.

Обратите внимание, что по умолчанию после установки Такси-Мастер в этом файле записан путь к базе данных на ''локальном'' компьютере.
Это значит, что на компьютере-сервере подключение к базе данных можно не настраивать.
Тем не менее, на компьютерах-клиентах подключение настраивать ''необходимо''.

Чтобы настроить подключение к базе данных (второй вариант), выполните следующие действия:
# Откройте папку, в которую установлена клиентская часть Такси-Мастер. По умолчанию это папка {{путь к папке ТМ1}}.
# Найдите файл {{путь|Taxi.ini}} и откройте его в Блокноте.
# Найдите строку {{code/(}}DatabaseName=...{{code/)}}. Она находится практически в самом начале файла и по умолчанию выглядит так: {{code/(}}DatabaseName=LOCALHOST:C:\Program Files\Taxi\Data.gdb{{code/)}}.
# Замените указанное имя компьютера ({{code|LOCALHOST}}) на IP-адрес компьютера-сервера. Например, так: {{code/(}}DatabaseName=192.168.0.1:C:\Program Files\Taxi\Data.gdb{{code/)}}.
# Сохраните файл.

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

== Подключение к серверу Guardant ==
{{also|{{code|[[gnclient.ini]]}}|подпись=Основная статья:}}
Настройка подключения к [[Сервер Guardant|серверу Guardant]] необходима для того, чтобы программа Такси-Мастер на клиентском рабочем месте могла запуститься.
Подключение к серверу Guardant никак не связано с [[#Подключение к базе данных|подключением к базе данных]], и его настрйока происходит в [[gnclient.ini|другом настроечном файле]]:

# Откройте папку, в которую установлена клиентская часть Такси-Мастер. По умолчанию это папка {{путь к папке ТМ1}}.
# Найдите файл {{путь|gnclient.ini}} и откройте его в Блокноте.
# Найдите строку {{code/(}}IP_NAME=...{{code/)}}. Она находится ближе к концу файла и по умолчанию выглядит так: {{code/(}}IP_NAME=LOCALHOST{{code/)}} или {{code/(}}IP_NAME=127.0.0.1{{code/)}}.
# Замените указанное имя компьютера (или IP-адрес) на IP-адрес компьютера, к которому [[#Подключение ключа защиты|подключен ключ защиты]]. Например, как было принято [[#Подключение ключа защиты|выше]], укажите адрес {{code|192.168.0.1}}: {{code/(}}IP_NAME=192.168.0.1{{code/)}}.
# Сохраните файл.

Эти действия, как и в случае с [[#Подключение к базе данных|настройкой подключения к базе данных]], необходимо выполнить на всех-компьютерах клиентах.
На компьютере-сервере будет работать настройка по умолчанию.

== Запуск Такси-Мастер ==
После всех выполненных настроек запустите Такси-Мастер.
Если на каком-то из рабочих мест Такси-Мастер не запустится, соберите все файлы с расширением {{code|.log}} из папки Такси-Мастер и вложенных папок, и отправьте их вместе с письмом на {{ящик ОТП}}.

{{info|Вы можете использовать [[TMSysInfo|утилиту сбора информации о системе]] для сбора всех необходимых файлов с расширением {{code|.log}}.}}

[[Категория:Вопросы]]
[[Категория:Установка]]
[[Категория:Настройка]]

Права доступа пользователя в Такси-Мастер

2013-11-15T12:21:54Z

AnnaNikolskih: 1

'''{{PAGENAME}}''' регулируют возможность [[Пользователи|пользователя]] использовать те или иные функции [[Клиент Такси-Мастер|клиентской части Такси-Мастер]].
Распределение функций доступа пользователей происходит в зависимости от их ролей. Администратор по умолчанию имеет право доступа ко всем функциям клиентской части программы, а права отдельно взятого оператора могут быть ограниченными, например, он не сможет самостоятельно регулировать настройки Такси-Мастер.

== Роли ==

Задача прав доступа - ограничить или расширить возможности оператора по управлению функционалом программы. Для этого задаются конкретные роли, включающие в себя те или иные возможности пользования Такси-Мастер, которые необходимы именно этой категории пользователей. Роль может распространяться как на одного пользователя, так и на целую группу.

{{youtube|http://youtu.be/bHxI72ckfbo|заголовок=Добавление новой роли и пользователя программы Такси-Мастер}}

=== Добавление новой роли ===

Чтобы задать новую роль, необходимо выбрать соответствующую вкладку в меню "Доступ".

{{картинка|Доступ Роли в ТМ 2.png}}

После выбора меню "Роли", перед вами появится окно, "Меню Доступ: роли", в котором происходит управление ролями пользователя: добавление роли, редактирование, удаление. Чтобы добавить новую роль нажмите на кнопку {{Добавить (Insert)}} или клавишу {{key|Insert}}, после чего у вас откроется окно {{window|Новая роль}}, в котором вы должны произвести ввод новой роли и указать права доступа, которые будут ей соответствовать.

{{картинка|Новая роль в ТМ 2.png}}

=== Последовательность заполнения новой роли ===

# В поле {{button|Наименование}} укажите наименование роли.
# В поле {{button|Исходная роль}} можно выбрать уже существующую роль и, соответственно, все права перенесутся из существующей роли в новую.
# В следующем объемном поле {{button|Права}} вы должны выбрать те права доступа, которые будут соответствовать роли. В этом поле существуют две большие вкладки {{button|Общие}} и {{button|Отчеты}}. Во вкладке {{button|Общие}} указан общий перечень функционала клиентской части Такси-Мастер, к которому можно открыть доступ пользователей. Во вкладке {{button|Отчеты}} указан перечень отчетов доступных для пользователя. Если вы хотите обеспечить пользователю доступ ко всем функциям программы, то целесообразно нажать на кнопку {{button|Выделить все}}, после чего на всем перечне функций программы автоматически установятся флажки, которые открывают права доступа. Кнопка {{button|Снять выделение}} снимает все установленные ранее атрибуты. Также возможно назначить доступ конкретной группе прав. Для этого установите флажок на названии группы, после чего у вас автоматически установятся флажки на все права из выбранной группы. Для справочников настраивается не только видимость, но и возможность добавления, редактирования и удаления записей. Чтобы разрешить или запретить возможность добавления, редактирования или удаления для какого-либо справочника, необходимо выбрать соответствующие атрибуты, которые находятся справа от названия справочника
.
[[Изображение:Функции роли в ТМ 2.png]]

=== Вкладка "Общие" ===

В ней представлен общий список категорий функционала программы Такси-Мастер, к которому можно разрешить либо запретить доступ пользователей.

==== Категория "Базовые". ====
В нее включены первичные функции программы Такси-Мастер, открывающие доступ к базовым элементам программы.

===== Настройка =====
Атрибут разрешает право доступа пользователя к редактированию [[Настройка Такси-Мастер|настроек]] программы.

===== Раскраска =====
Атрибут позволяет пользователю [[Настройка раскраски списка|менять цвета]] полей в зависимости от признака по своему усмотрению.

===== Экспорт в Microsoft Excel =====
Атрибут позволяет экспортировать данные из Такси-Мастер в электронные таблицы Microsoft Excel.

==== Категория "Помощь". ====
Предоставляет право на использование помощи для работы в программе непосредственно в Такси-Мастер и на help.taximaster.ru

===== Online помощь =====
Атрибут разрешает право доступа пользователя к пункту {{button|Online помощь}} меню {{окно|Помощь}}.

===== О программе =====
Дает право пользователю на просмотр [[Версия Такси-Мастер#Где посмотреть версию?|информации о программе]] через соответствующий пункт меню {{окно|Помощь}}.

===== Сбор информации о системе =====
Атрибут позволяет предоставить право пользователю на [[Утилита сбора информации о системе|сбор информации о системе]] через одноименный пункт меню {{окно|Помощь}}.

==== Категория "Доступ" ====
Данная категория прав включает в себя права на добавление, редактирование и удаление новых ролей и пользователей программы.

===== Пользователи =====
Атрибут позволяет менять состав [[Пользователь Такси-Мастер|пользователей]] программы Такси-Мастер, а также производить редактирование их прав на доступ.

====== Учетная запись ======
Атрибут дает возможность редактировать учетные записи пользователей программы.

===== Роли =====
Атрибут предоставляет право на добавление, удаление и редактирование ролей.

==== Категория "Справочники" ====
В нее включены все [[справочники]] программы Такси-Мастер, к которым возможно открыть или ограничить доступ пользователей программы.

===== Автомобили =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Автомобили» (ТМ2)|справочника «Автомобили»]].

====== Импорт, удаление фотографий ======
Атрибут предоставляет возможность импортировать и удалять фотографии из справочника "Автомобили".

===== Варианты изменения состояний заказа =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Варианты изменения состояний заказов»|справочника «Варианты изменения состояний заказов»]].

===== Водители =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Водители»|справочника «Водители»]]

====== Импорт, удаление фотографий ======
Атрибут предоставляет возможность импортировать и удалять фотографии из справочника «Водители».

===== Города =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Города»|справочника «Города»]].

===== Группы экипажей =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Группы экипажей»|справочника «Группы экипажей»]].

===== Дисконтные карты =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Дисконтные карты»|справочника «Дисконтные карты»]].

===== Дисконтные карты: типы =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Дисконтные карты: типы»|справочника «Дисконтные карты: типы»]].

===== Звуковые файлы Asterisk =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Звуковые файлы Asterisk»|справочника «Звуковые файлы Asterisk»]].

===== Категории телефона =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Категории телефона»|справочника «Категории телефона»]].

===== Платежи =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Платежи»|справочника «Платежи»]].

===== Правила изменения категорий телефонов =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Правила изменения категорий телефонов»|справочника «Правила изменения категорий телефонов»]].

===== Привязки улиц к районам =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Привязки улиц к районам»|справочника «Привязки улиц к районам»]].

===== Признаки экипажей =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Признаки экипажей»|справочника «Признаки экипажей»]].

===== Проезды между районами =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Проезды между районами»|справочника «Проезды между районами»]].

===== Пункты и стоянки =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Пункты»|справочника «Пункты и стоянки»]].

===== Районы =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Районы»|справочника «Районы»]].

===== Расходы фирмы =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Расходы фирмы»|справочника «Расходы фирмы»]].

===== Сдачи с заказов =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Сдачи с заказов»|справочника «Сдачи с заказов»]].

===== Скидки клиентов =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Скидки»|справочника «Скидки клиентов»]].

===== Скидки\наценки на заказы =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Скидки/наценки на заказы»|справочника «Скидки/наценки на заказы»]].

===== Смены сдач с заказов =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Смены сдач с заказов»|справочника «Смены сдач с заказов»]].

===== Состояния заказа =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Состояния заказа»|справочника «Состояния заказа»]].

===== Состояния экипажа =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Состояния экипажа»|справочника «Состояния экипажа»]].

===== Статистика по телефонам =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Статистика по телефонам»|справочника «Статистика по телефонам»]].

===== Тарифы =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Тарифы»|справочника «Тарифы»]].

===== Смены тарифов =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Смены тарифов»|справочника «Смены тарифов»]].

===== Телефоны =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Телефоны»|справочника «Телефоны»]].

====== Перемещение в категорию с типом "Черный" ======
Атрибут дает пользователю возможность перемещать телефон в категорию "Черные".

====== Перемещение из категории с типом "Черные" ======
Атрибут дает пользователю возможность перемещать телефон из категории "Черные" в другие категории.

===== Улицы =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Улицы»|справочника «Улицы»]].

===== Услуги =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Услуги»|справочника «Услуги»]].

===== Шаблоны операций =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Шаблоны операций»|справочника «Шаблоны операций»]].

===== Штрафы =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Штрафы»|справочника «Штрафы»]].

===== Экипажи =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Экипажи»|справочника «Экипажи»]].

==== Категория "Заказы" ====
В категорию "Заказы" включены права к справочникам заказов (текущих, предварительных, выполненных, удаленных), к истории заказов и некоторым дополнительным функциям, связанным с заказами.

===== Текущие\предварительные =====
Атрибут предоставляет права на просмотр, редактирование, добавление и удаление [[Текущий заказ|текущих]] и [[Предварительный заказ|предварительных]] заказов.

===== Ежедневные =====
Атрибут предоставляет права на просмотр, редактирование, добавление и удаление [[Ежедневный заказ|ежедневных]] заказов.

===== Выполненные =====
Атрибут предоставляет права на просмотр, редактирование, и удаление выполненных заказов.

====== Редактирование выполненных заказов ======
Атрибут предоставляет права на редактирование выполненных заказов.

====== Удаление выполненных заказов ======
Атрибут предоставляет права на удаление выполненных заказов.

====== Кнопка "Период" ======
Установленный атрибут предоставляет права на изменение периода времени просмотра в выполненных заказах. В ином случае, оператору нельзя будет самостоятельно задавать период просмотра, и он по умолчанию будет равен количеству часов, установленному в [[Параметры Такси-Мастер#Показывать операторам предыдущие заказы за N часов|соответствующих параметрах]].

===== Удаленные =====
Атрибут предоставляет права на доступ к справочнику удаленных заказов.

===== История состояний заказов =====
Атрибут предоставляет права на просмотр историй состояний заказов.

===== Подставить следующий экипаж по стоянке подачи =====
Установив данный атрибут, пользователь сможет поставить на заказ экипаж, который находится следующий в очереди по стоянке подачи. Сделать это можно следующим образом: нажмите правой кнопкой мыши в списке заказов, после чего в заказ подставляется экипаж, который идет следом за текущим экипажем заказа, если в заказе указана стоянка подачи.

==== Категория "Карточка заказа" ====
Категория предоставляет права доступа к разным полям в [[Карточка заказа в {{ТМ}}|карточке заказа]].

===== Поле "Время принятия" =====
Атрибут настраивает возможность редактирования поля {{button|Время принятия}}.

[[Изображение:Поле время принятия.png]]

===== Поле "Время подачи" =====
Атрибут настраивает возможность редактирования поля {{button|Время подачи}}.

[[Изображение:Поле Время подачи.png]]

===== Изменение адреса подачи =====
Атрибут настраивает возможность изменения адреса подачи, то есть поле адреса подачи в конкретном заказе можно будет заполнить только один раз, если данный атрибут выключен.

[[Изображение:Поле Адрес подачи.png]]

===== Изменение группы =====
Атрибут настраивает возможность изменения группы экипажей, то есть поле {{button|Группа экипажа}} в конкретном заказе можно будет заполнить только один раз, если данный атрибут выключен.

===== Поле "Экипаж" =====
Атрибут настраивает возможность редактирования поля {{button|Экипаж}}.

[[Изображение:Поле Экипаж.png]]

====== Изменение экипажа ======
Атрибут настраивает возможность изменения экипажа, то есть поле {{button|Экипаж}} в конкретном заказе можно будет заполнить только один раз, если данный атрибут выключен.

===== Поле "Сумма" =====
Атрибут настраивает возможность редактирования поля {{button|Сумма}}.

===== Поле "Оплачено банковской картой" =====
Атрибут настраивает возможность редактирования поля {{button|Оплачено банковской картой}}

[[Файл:Поле Оплачено банковской картой.jpeg]]

===== Кнопка "Подобрать оптимальный экипаж" =====
Атрибут настраивает видимость кнопки {{field|Подобрать оптимальный экипаж}} в карточке заказа.

===== Поле "Вид завершения": тип завершения "Прекращен" =====
Атрибут настраивает поле {{button|Вид завершения}}.

[[Изображение:Поле Вид завершения.png]]

===== Поле "Время завершения" (в завершенных заказах) =====
Атрибут настраивает видимость поля {{поле|Время завершения}} в завершенных заказах (в текущих и предварительных заказах поле всегда скрыто).

===== Поле "Деньги приняты" =====
Атрибут настраивает видимость флажка {{checkbox|Деньги приняты}}.

===== Кнопка "Настройка внешнего вида карточки" =====
Атрибут настраивает видимость кнопки {{кнопка|Настройка внешнего вида карточки}}.

[[Изображение:Кнопка Настройка внешнего вида в карточке заказа.png]]

===== Кнопка "Отмена" =====
Атрибут настраивает доступ к кнопке {{field|Отмена}}.

[[Изображение:Кнопка Отмена.png]]

==== Категория "Экипажи" ====
Позволяет настроить права доступа к [[Справочник «Экипажи»|справочнику «Экипажи»]], к истории изменения состояний экипажей и таблице динамических приоритетов.

===== Экипажи =====
Атрибут позволяет настроить права на видимость [[Окно «Экипажи» в {{ТМ}}|окна «Экипажи»]], на кнопки вывода экипажа на линию, изменения состояний экипажа и завершения смены экипажа.

===== Динамические приоритеты =====
Атрибут настраивает права доступа к таблице динамических приоритетов (см. Файл -> Настройки -> Экипажи -> Подбор на заказ -> Подбор по стоянке).

===== История состояний экипажа =====
Атрибут предоставляет права на просмотр историй состояний заказов. Ее можно просмотреть следующим образом: во-первых, необходимо сделать активным в окне {{button|Экипажи}} тот экипаж, у которого пользователь желает просмотреть историю, во-вторых, нажать на экипаж правой кнопкой мыши и выбрать позицию {{button|История состояний экипажа}}, либо нажать на кнопку {{button|История состояний экипажа}}, которая находится на панели управления окна {{button|Экипажи}}.

==== Категория "Стоянки" ====
Позволяет настроить права доступа для окна [[Окно «Стоянки» в {{ТМ}}|окна {{окно|Стоянки}}]].

===== Стоянки =====
Позволяет настроить видимость [[Окно «Стоянки» в {{ТМ}}|окна «Стоянки»]].

====== Перемещение экипажа в очереди по стоянке ======
Атрибут позволяет настроить доступ к кнопкам перемещения экипажа в очереди по стоянкам.

====== Сортировка стоянок ======
Атрибут позволяет настроить доступ к кнопкам изменения позиции стоянок окна «Стоянки».

====== Установка\снятие экипажа со стоянок ======
Атрибут позволяет настроить доступ к кнопкам установки\снятия экипажа со стоянок.

==== Категория "Клиенты" ====
Дает возможность настроить права доступа на справочники, расчеты и новости клиентов.

===== Все клиенты =====
Справочник "Все клиенты" объединяет в себе справочники физических и юридических лиц. Здесь недоступно добавление новых клиентов, это действие выполняется в соответствующих справочниках.

===== Физические лица =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Физические лица»|справочника «Физические лица»]].

===== Юридические лица =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Юридические лица»|справочника «Юридические лица»]].

===== Любимые экипажи =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Физические лица»#Вкладка «Любимые экипажи»|справочника "Любимые экипажи"]], который находится на одной из вкладок в карточке клиента.

===== Новости =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Физические лица»#Вкладка «Новости»|справочника "Новостей клиента"]]

===== Расчеты =====
Атрибут предоставляет права на просмотр и редактирование расчетов клиента.

====== Время операции ======
Атрибут настраивает возможность редактирования поля {{поле|Время операции}}.

====== Удаленные ======
Атрибут настраивает возможность удаления операций и возможность просмотра таких операций.

===== Сотрудники =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Юридические лица»#Вкладка «Сотрудники»|справочника "Сотрудники"]], который находится на одной из вкладок в карточке клиента.

===== Телефоны =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Юридические лица»#Вкладка «Телефоны»|справочника "Телефоны"]], который находится на одной из вкладок в карточке клиента.

===== Статистика =====
Атрибут предоставляет права на на редактирование [[Справочник «Юридические лица»#Вкладка «Телефоны»|статистики клиентов]] в карточках клиентов.

==== Категория "Водители" ====
Дает возможность настройки прав на справочники:
#[[Окно «Водители: Назначенные штрафы»|Назначенные штрафы]]
#[[Окно «Водители: Планирование смен»|Планирование смен]]
#[[Окно «Водители: Фактические смены»|Фактические смены]]
#[[Окно «Водители: Продажа смен»|Продажа смен]]
#[[Модуль расчетов с водителями в Такси-Мастер|Расчеты]]

===== Назначенные штрафы =====
Атрибут предоставляет права на просмотр и редактирование [[Окно «Водители: Назначенные штрафы»|справочника "Назначенные штрафы"]].

===== Планирование смен =====
Атрибут предоставляет права на просмотр и редактирование [[Окно «Водители: Планирование смен»|справочника "Планирование смен"]].

===== Фактические смены =====
Атрибут предоставляет права на просмотр и редактирование [[Окно «Водители: Фактические смены»|справочника "Фактические смены"]].

===== Продажа смен =====
Атрибут предоставляет права на просмотр и редактирование [[Окно «Водители: Продажа смен»|справочника "Продажа смен"]].

===== Расчеты =====
Атрибут предоставляет права на просмотр и редактирование [[Модуль расчетов с водителями в Такси-Мастер|справочника "Расчеты"]].

====== Время операции ======
Атрибут настраивает возможность редактирования поля {{поле|Время операции}}.

====== Удаленные ======
Атрибут настраивает возможность удаления операций и возможность просмотра таких операций.

===== Пополнить счет =====
Атрибут настраивает возможность доступа к кнопке {{путь|Меню "Водители" -> Пополнить счет}}

==== Категория "Отчеты" ====
Дает возможность настройки прав у [[Отчеты Такси-Мастер|справочника "Отчеты"]], группы отчетов.

===== Отчеты =====
Атрибут предоставляет права на просмотр и редактирование на справочник отчетов (Меню "Отчеты" -> "Редактор отчетов").

===== Группы =====
Атрибут предоставляет права на просмотр и редактирование справочника групп отчетов. Справочник "Группы отчетов" можно открыть из поля {{поле|Группа}} в карточке "Отчеты" (в редакторе отчетов).

===== Импорт =====
Атрибут настраивает видимость пункта меню "Отчеты" -> Импорт.

==== Категория "Карты" ====
Дает возможность настройки прав для справочников:
# [[Справочник «Точки запрета проезда»]]
# [[Справочник «Группы точек запрета проезда»]]
# [[Справочник «Точки выезда из города»]]
# [[Справочник «Привязка районов к карте»]]
# [[Справочник «Привязка стоянок к карте»]]

===== Точки запрета проезда =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Точки запрета проезда»|справочник «Точки запрета проезда»]].

===== Группы точек запрета проезда =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Группы точек запрета проезда»|справочника «Группы точек запрета проезда»]].

===== Точки выезда из города =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Точки выезда из города»|справочника «Точки выезда из города»]].

===== Привязка районов к карте =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Привязка районов к карте»|справочника «Привязка районов к карте»]].

===== Привязка стоянок к карте =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Привязка стоянок к карте»|справочника «Привязка стоянок к карте»]].

==== Категория "Связь с водителями" ====
Дает возможность настройки прав для справочников [[Окно «Шаблоны»|«Шаблоны сообщений»]], «Новости» (в меню Водители), видимости некоторых параметров в [[Справочник «Водители»#Добавление нового водителя|карточке водителя]], видимости [[С чего начать?#Отправка сообщений оператором|окна "Сообщения"]], кнопки {{кнопка|Час-Пик}}.

===== Сообщения =====
Атрибут дает возможность настройки видимости кнопки и окна "Сообщения".

===== Шаблоны сообщений =====
Атрибут предоставляет права на просмотр и редактирование справочника [[Окно «Шаблоны»|"Шаблоны сообщений"]].

===== Новости =====
Атрибут предоставляет права на просмотр и редактирование справочника "Новости" в меню "Водители".

===== Группа параметров GPRS (карточка водителя) =====
Атрибут предоставляет права на редактирование [[Справочник «Водители»#Добавление нового водителя|параметров GPRS]] в карточке водителя.

====== Дата блокировки водителя ======
Атрибут предоставляет права на блокировку водителя (в карточке клиента).

===== Режим работы "Час пик" =====
Атрибут дает возможность настройки видимости кнопки [[Час пик|"Час пик"]].

==== Категория "Телефония" ====
Настраивает доступ к справочникам [[Журнал звонков (модуль «Средства связи»)|"Журнал звонков"]], "Записи разговоров", [[Окно «Фильтры телефонов» для устройств связи|"Фильтры телефонов"]], флажкам в [[Окно «Софтфон»|окне "Софтфон"]]

===== Журнал звонков =====
Атрибут настраивает видимость [[Журнал звонков (модуль «Средства связи»)|журнала звонков]].

====== Кнопка "Убрать из неотвеченных" ======
Атрибут настраивает видимость кнопки {{кнопка|Убрать из неотвеченных}}

===== Записи разговоров =====
Атрибут настраивает видимость таблицы "Записи разговоров".

===== Фильтры телефонов =====
Атрибут предоставляет права на просмотр и редактирование [[Окно «Фильтры телефонов» для устройств связи|справочника "Фильтры телефонов"]].

===== Состояние линий =====
Атрибут предоставляет права на просмотр и редактирование [[Окно «Состояние линий»|окна "Состояние линий"]].

===== Софтфон: Флажок "АО" (автоответ) =====
Атрибут позволяет настраивать видимость флажка {{checkbox|"АО"}} в [[Окно «Софтфон»|окне софтфона]].

===== Софтфон: Флажок "АОК" (автооткрытие карточки заказа) =====
Атрибут позволяет настраивать видимость флажка {{checkbox|"АОК"}} в [[Окно «Софтфон»|окне софтфона]].

===== Софтфон: Флажок "П" (перерыв) =====
Атрибут позволяет настраивать видимость флажка {{checkbox|"П"}} в [[Окно «Софтфон»|окне софтфона]].

===== Поля Asterisk Марка и Цвет (карточка автомобиля) =====
Атрибут влияет на видимость полей {{поле|Марка}} и {{поле|Цвет}} в [[Справочник «Автомобили»#Добавление нового автомобиля|карточке автомобиля]].

===== Очередь звонков Asterisk =====
Атрибут предоставляет права на просмотр и редактирование [[Окно «Очередь звонков Asterisk»|окна "Очередь звонков Asterisk"]].

==== Категория "Модуль СМС" ====
Права для настройки возможности отправки коротких текстовых сообщений на сотовые телефоны.

===== Отправка сообщения на номер =====
Атрибут настраивает видимость пункта меню [[Окно «Отправка СМС на номер»|{{окно|Отправка СМС на номер}}]].

===== Отправка сообщения водителям =====
Атрибут настраивает видимость пункта меню [[Окно «Отправка СМС водителям»|{{окно|Отправка СМС водителям}}]].

===== Массовая рассылка =====
Атрибут настраивает видимость пункта меню [[Массовая рассылка СМС|{{окно|Отправка СМС на номер}}]].

===== Фильтры телефонов =====
Атрибут предоставляет права на просмотр и редактирование [[Фильтр сотовых телефонов|справочника "Фильтры телефонов"]].

===== Шаблоны =====
Атрибут предоставляет права на просмотр и редактирование справочника [[Окно «Шаблоны»|"Шаблоны СМС"]].

===== Задачи =====
Атрибут предоставляет права на просмотр задач по отправке СМС.

===== Журнал =====
Атрибут предоставляет права на просмотр журнала отправки СМС.

===== Сервисный список =====
Атрибут предоставляет права на просмотр и редактирование справочника [[Параметры модуля СМС#Заказы|"Сервисный список]]" (Меню "Файл" -> Настройки -> СМС -> Вкладка "Заказы" -> Кнопка {{кнопка|Сервисный список}}.

==== Категория "Платежные терминалы" ====
Настраивает доступ к справочнику [[Модуль интеграции с платежными терминалами#Заведение новой учетной записи платежной системы в Такси-Мастер|"Платежные терминалы"]] и кнопкам {{кнопка|Экспорт терминальных аккаунтов}} и {{кнопка|Импорт терминальных аккаунтов}}.

===== Платежные системы =====
Атрибут предоставляет права на просмотр и редактирование справочника [[Модуль интеграции с платежными терминалами#Заведение новой учетной записи платежной системы в Такси-Мастер|"Платежные системы"]].

===== Экспорт\импорт терминальных аккаунтов =====
Атрибут настраивает видимость кнопок {{кнопка|Экспорт терминальных аккаунтов}} и {{кнопка|Импорт терминальных аккаунтов}}.

===== Сверка =====
Атрибут предоставляет право на формирование файлов сверки.

=== Доступ пользователя к правам на создание отчетов ===
Содержит в себе перечень [[Отчеты Такси-Мастер|отчетов]], к которым необходимо открыть либо запретить доступ пользователя.

{{вам сюда|Отчеты Такси-Мастер}}

После того, как все необходимые права доступа пользователя будут отмечены, для подтверждения создания новой роли нажмите кнопку {{кнопка|ОК}}.

{{картинка|Создание роли в ТМ 2.png}}

Теперь в {{окно|Меню доступ: Роли}} отобразиться созданная вами роль.

{{картинка|Роль в ТМ 2.png}}

== Пользователь в {{ТМ}} ==

На каждом рабочем месте должен быть установлен конкретный [[Пользователь Такси-Мастер|пользователь]] программы {{ТМ}}, у каждого из которых может быть различный набор функций и прав доступа к [[Клиент {{ТМ}}|клиентской части]] программы, которые задаются ролью пользователя. Например, функционал оператора и функционал администратора могут существенно отличаться друг от друга.

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

=== Меню Доступ: Пользователи ===
Первым шагом к созданию нового пользователя будет следующее. Откройте {{окно|Меню доступ}} и выберите меню {{окно|Пользователи}}.
{{картинка|Меню Доступ Пользователи ТМ.png}}

После совершения данных действий у вас появится окно, в котором представлен перечень пользователей, которые уже созданы в программе. Вы можете изменять их настройки и набор прав доступа, выделив конкретного пользователя и нажав кнопку {{ЭУ/Кнопка|тм2-редактировать}} или клавишу {{key|Enter}}. Также вы можете удалять ненужных пользователь, выделив необходимого вам и нажав на кнопку {{ЭУ/Кнопка|тм2-удалить}} или клавишу {{key|Ctrl+Del}}.
Обратите внимание, что права на создание, редактирование и удаление пользователей существуют только в том случае, если они допускаются ролью, то есть установлены соответствующие атрибуты в роли пользователя, который намеревается произвести изменения в составе.

Для того, чтобы создать нового пользователя нажмите кнопку {{ЭУ/Кнопка|тм2-добавить}} или клавишу {{key|Insert}}.

{{картинка|Меню Доступ Пользователи в ТМ2.png}}

=== Окно "Новый пользователь" ===
Для создания нового пользователя программы {{ТМ}} необходимо корректно заполнить все необходимые поля в окне {{окно|Новый пользователь}}. Рассмотрим заполнение каждого поля отдельно.

{{картинка|Новый пользователь ТМ2.png}}

==== Поле "Ф.И.О" ====
В поле {{поле|Ф.И.О.}} введите фамилию, имя, отчество пользователя.

==== Поле "Логин" ====
В поле {{поле|Логин}} введите логин нового пользователя. Логин необходим при работе с [[База данных {{ТМ}}|базой данных]], которая скрыта от пользователя внутри системы.

==== Поле "Пароль" и "Подтверждение" ====
В поле {{поле|Пароль}} введите пароль нового пользователя и повторите его набор в поле {{поле|Подтверждение}}. Пароль необходим для идентификации пользователя при запуске программы Такси-Мастер.

==== Поле "Примечания" ====
В поле {{поле|Примечания}} укажите дополнительные сведения по новому пользователю, если это необходимо.

==== Поле "Номер телефона: сотовый, домашний" ====
В поле {{поле|Сотовый}} введите номер мобильного телефона нового пользователя, а в поле {{поле|Домашний}}, соответственно, его домашний номер.

==== Поле "Уволен по причине" ====
Данное поле заполняется при редактировании карточки пользователя в том случае, если данный пользователь будет уволен. Установка атрибута {{checkbox|Уволен по причине}} будет означать увольнение пользователя, а в самом же поле должна быть указана причина.

==== Атрибут "Удален" ====
Установка данного атрибута означает, что данный пользователь будет удален из общего перечня. Данное действие приведет к изменениям в окне {{окно|Меню доступ: Пользователи}} в списке пользователей программы.

==== Поле "Роли" ====
Если у вас созданы [[#Роль|роли]] пользователей, то в данном окне будет находится их перечень. Установите атрибут у соответствующей роли, в рамках которой будет действовать новый пользователь.

==== Поле "Права" ====
В поле {{поле|Права}} приведен список [[Права доступа пользователя в {{ТМ}}|прав доступа]] пользователя к функционалу клиентской части программы. Если у вас нет списка готовых ролей, то заполните данное поле в [[#Последовательность заполнения новой роли|соответствии с набором прав]], который хотите предоставить новому пользователю программы. Если вы нажмете кнопку {{кнопка|Выделить все}}, то программа автоматически установит атрибуты у каждого права доступа. Кнопка {{кнопка|Снять выделение}} автоматически удалит все установленные атрибуты из данного поля.

После заполнения всех полей окна {{окно|Новый пользователь}}, нажмите кнопку {{кнопка|ОК}}. После совершения этих действий, произойдет добавление нового пользователя в списке пользователей программы Такси-Мастер.

{{картинка|Новый пользователь в ТМ.png}}

Чтобы войти в качестве нового пользователя в программу, необходимо осуществить ее перезапуск. После чего в окне входа {{окно|Добро пожаловать в Такси-Мастер}} в поле {{поле|Пользователь}} введите имя того пользователя, в качестве которого вы хотите зайти в программу, а в поле {{поле|Пароль}} введите пароль, соответствующий данному пользователю. Запустите программу Такси-Мастер.

=== Копирование настроек пользователя ===
Чтобы осуществить передачу настроек от одного пользователя к другому, необходимо совершить следующие действия:
# В окне {{окно|Меню Доступ: Пользователи}} выделите пользователя, настройки которого вы хотите передать.
# Нажмите кнопку {{кнопка|Копировать настройки пользователя}}, которая располагается на панели управления окна и выглядит следующим образом: [[Изображение:Копировать настройки пользователя.png]]
# В появившемся окне {{окно|Копирование настроек}} установите флажки напротив тех пользователей, которым хотите передать права.
# Нажмите {{key|ОК}}

{{картинка|Копирование настроек.png}}

{{Отчет}}
[[Категория:ТМ2]]
[[Категория:Клиентская часть]]
[[Категория:Справочники]]

Права доступа пользователя в Такси-Мастер

2013-11-15T12:20:55Z

AnnaNikolskih:

'''{{PAGENAME}}''' регулируют возможность [[Пользователи|пользователя]] использовать те или иные функции [[Клиент Такси-Мастер|клиентской части Такси-Мастер]].
Распределение функций доступа пользователей происходит в зависимости от их ролей. Администратор по умолчанию имеет право доступа ко всем функциям клиентской части программы, а права отдельно взятого оператора могут быть ограниченными, например, он не сможет самостоятельно регулировать настройки Такси-Мастер.

== Роли ==

Задача прав доступа - ограничить или расширить возможности оператора по управлению функционалом программы. Для этого задаются конкретные роли, включающие в себя те или иные возможности пользования Такси-Мастер, которые необходимы именно этой категории пользователей. Роль может распространяться как на одного пользователя, так и на целую группу.

{{youtube|http://youtu.be/bHxI72ckfbo|заголовок=Добавление новой роли и пользователя программы Такси-Мастер}}

=== Добавление новой роли ===

Чтобы задать новую роль, необходимо выбрать соответствующую вкладку в меню "Доступ".

{{картинка|Доступ Роли в ТМ 2.png}}

После выбора меню "Роли", перед вами появится окно, "Меню Доступ: роли", в котором происходит управление ролями пользователя: добавление роли, редактирование, удаление. Чтобы добавить новую роль нажмите на кнопку {{Добавить (Insert)}} или клавишу {{key|Insert}}, после чего у вас откроется окно {{window|Новая роль}}, в котором вы должны произвести ввод новой роли и указать права доступа, которые будут ей соответствовать.

{{картинка|Новая роль в ТМ 2.png}}

=== Последовательность заполнения новой роли ===

# В поле {{button|Наименование}} укажите наименование роли.
# В поле {{button|Исходная роль}} можно выбрать уже существующую роль и, соответственно, все права перенесутся из существующей роли в новую.
# В следующем объемном поле {{button|Права}} вы должны выбрать те права доступа, которые будут соответствовать роли. В этом поле существуют две большие вкладки {{button|Общие}} и {{button|Отчеты}}. Во вкладке {{button|Общие}} указан общий перечень функционала клиентской части Такси-Мастер, к которому можно открыть доступ пользователей. Во вкладке {{button|Отчеты}} указан перечень отчетов доступных для пользователя. Если вы хотите обеспечить пользователю доступ ко всем функциям программы, то целесообразно нажать на кнопку {{button|Выделить все}}, после чего на всем перечне функций программы автоматически установятся флажки, которые открывают права доступа. Кнопка {{button|Снять выделение}} снимает все установленные ранее атрибуты. Также возможно назначить доступ конкретной группе прав. Для этого установите флажок на названии группы, после чего у вас автоматически установятся флажки на все права из выбранной группы. Для справочников настраивается не только видимость, но и возможность добавления, редактирования и удаления записей. Чтобы разрешить или запретить возможность добавления, редактирования или удаления для какого-либо справочника, необходимо выбрать соответствующие атрибуты, которые находятся справа от названия справочника
.
[[Изображение:Функции роли в ТМ 2.png]]

=== Вкладка "Общие" ===

В ней представлен общий список категорий функционала программы Такси-Мастер, к которому можно разрешить либо запретить доступ пользователей.

==== Категория "Базовые". ====
В нее включены первичные функции программы Такси-Мастер, открывающие доступ к базовым элементам программы.

===== Настройка =====
Атрибут разрешает право доступа пользователя к редактированию [[Настройка Такси-Мастер|настроек]] программы.

===== Раскраска =====
Атрибут позволяет пользователю [[Настройка раскраски списка|менять цвета]] полей в зависимости от признака по своему усмотрению.

===== Экспорт в Microsoft Excel =====
Атрибут позволяет экспортировать данные из Такси-Мастер в электронные таблицы Microsoft Excel.

==== Категория "Помощь". ====
Предоставляет право на использование помощи для работы в программе непосредственно в Такси-Мастер и на help.taximaster.ru

===== Online помощь =====
Атрибут разрешает право доступа пользователя к пункту {{button|Online помощь}} меню {{окно|Помощь}}.

===== О программе =====
Дает право пользователю на просмотр [[Версия Такси-Мастер#Где посмотреть версию?|информации о программе]] через соответствующий пункт меню {{окно|Помощь}}.

===== Сбор информации о системе =====
Атрибут позволяет предоставить право пользователю на [[Утилита сбора информации о системе|сбор информации о системе]] через одноименный пункт меню {{окно|Помощь}}.

==== Категория "Доступ" ====
Данная категория прав включает в себя права на добавление, редактирование и удаление новых ролей и пользователей программы.

===== Пользователи =====
Атрибут позволяет менять состав [[Пользователь Такси-Мастер|пользователей]] программы Такси-Мастер, а также производить редактирование их прав на доступ.

====== Учетная запись ======
Атрибут дает возможность редактировать учетные записи пользователей программы.

===== Роли =====
Атрибут предоставляет право на добавление, удаление и редактирование ролей.

==== Категория "Справочники" ====
В нее включены все [[справочники]] программы Такси-Мастер, к которым возможно открыть или ограничить доступ пользователей программы.

===== Автомобили =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Автомобили» (ТМ2)|справочника «Автомобили»]].

====== Импорт, удаление фотографий ======
Атрибут предоставляет возможность импортировать и удалять фотографии из справочника "Автомобили".

===== Варианты изменения состояний заказа =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Варианты изменения состояний заказов»|справочника «Варианты изменения состояний заказов»]].

===== Водители =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Водители»|справочника «Водители»]]

====== Импорт, удаление фотографий ======
Атрибут предоставляет возможность импортировать и удалять фотографии из справочника «Водители».

===== Города =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Города»|справочника «Города»]].

===== Группы экипажей =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Группы экипажей»|справочника «Группы экипажей»]].

===== Дисконтные карты =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Дисконтные карты»|справочника «Дисконтные карты»]].

===== Дисконтные карты: типы =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Дисконтные карты: типы»|справочника «Дисконтные карты: типы»]].

===== Звуковые файлы Asterisk =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Звуковые файлы Asterisk»|справочника «Звуковые файлы Asterisk»]].

===== Категории телефона =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Категории телефона»|справочника «Категории телефона»]].

===== Платежи =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Платежи»|справочника «Платежи»]].

===== Правила изменения категорий телефонов =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Правила изменения категорий телефонов»|справочника «Правила изменения категорий телефонов»]].

===== Привязки улиц к районам =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Привязки улиц к районам»|справочника «Привязки улиц к районам»]].

===== Признаки экипажей =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Признаки экипажей»|справочника «Признаки экипажей»]].

===== Проезды между районами =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Проезды между районами»|справочника «Проезды между районами»]].

===== Пункты и стоянки =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Пункты»|справочника «Пункты и стоянки»]].

===== Районы =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Районы»|справочника «Районы»]].

===== Расходы фирмы =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Расходы фирмы»|справочника «Расходы фирмы»]].

===== Сдачи с заказов =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Сдачи с заказов»|справочника «Сдачи с заказов»]].

===== Скидки клиентов =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Скидки»|справочника «Скидки клиентов»]].

===== Скидки\наценки на заказы =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Скидки/наценки на заказы»|справочника «Скидки/наценки на заказы»]].

===== Смены сдач с заказов =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Смены сдач с заказов»|справочника «Смены сдач с заказов»]].

===== Состояния заказа =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Состояния заказа»|справочника «Состояния заказа»]].

===== Состояния экипажа =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Состояния экипажа»|справочника «Состояния экипажа»]].

===== Статистика по телефонам =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Статистика по телефонам»|справочника «Статистика по телефонам»]].

===== Тарифы =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Тарифы»|справочника «Тарифы»]].

===== Смены тарифов =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Смены тарифов»|справочника «Смены тарифов»]].

===== Телефоны =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Телефоны»|справочника «Телефоны»]].

====== Перемещение в категорию с типом "Черный" ======
Атрибут дает пользователю возможность перемещать телефон в категорию "Черные".

====== Перемещение из категории с типом "Черные" ======
Атрибут дает пользователю возможность перемещать телефон из категории "Черные" в другие категории.

===== Улицы =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Улицы»|справочника «Улицы»]].

===== Услуги =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Услуги»|справочника «Услуги»]].

===== Шаблоны операций =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Шаблоны операций»|справочника «Шаблоны операций»]].

===== Штрафы =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Штрафы»|справочника «Штрафы»]].

===== Экипажи =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Экипажи»|справочника «Экипажи»]].

==== Категория "Заказы" ====
В категорию "Заказы" включены права к справочникам заказов (текущих, предварительных, выполненных, удаленных), к истории заказов и некоторым дополнительным функциям, связанным с заказами.

===== Текущие\предварительные =====
Атрибут предоставляет права на просмотр, редактирование, добавление и удаление [[Текущий заказ|текущих]] и [[Предварительный заказ|предварительных]] заказов.

===== Ежедневные =====
Атрибут предоставляет права на просмотр, редактирование, добавление и удаление [[Ежедневный заказ|ежедневных]] заказов.

===== Выполненные =====
Атрибут предоставляет права на просмотр, редактирование, и удаление выполненных заказов.

====== Редактирование выполненных заказов ======
Атрибут предоставляет права на редактирование выполненных заказов.

====== Удаление выполненных заказов ======
Атрибут предоставляет права на удаление выполненных заказов.

====== Кнопка "Период" ======
Установленный атрибут предоставляет права на изменение периода времени просмотра в выполненных заказах. В ином случае, оператору нельзя будет самостоятельно задавать период просмотра, и он по умолчанию будет равен количеству часов, установленному в [[Параметры Такси-Мастер#Показывать операторам предыдущие заказы за N часов|соответствующих параметрах]].

===== Удаленные =====
Атрибут предоставляет права на доступ к справочнику удаленных заказов.

===== История состояний заказов =====
Атрибут предоставляет права на просмотр историй состояний заказов.

===== Подставить следующий экипаж по стоянке подачи =====
Установив данный атрибут, пользователь сможет поставить на заказ экипаж, который находится следующий в очереди по стоянке подачи. Сделать это можно следующим образом: нажмите правой кнопкой мыши в списке заказов, после чего в заказ подставляется экипаж, который идет следом за текущим экипажем заказа, если в заказе указана стоянка подачи.

==== Категория "Карточка заказа" ====
Категория предоставляет права доступа к разным полям в [[Карточка заказа в {{ТМ}}|карточке заказа]].

===== Поле "Время принятия" =====
Атрибут настраивает возможность редактирования поля {{button|Время принятия}}.

[[Изображение:Поле время принятия.png]]

===== Поле "Время подачи" =====
Атрибут настраивает возможность редактирования поля {{button|Время подачи}}.

[[Изображение:Поле Время подачи.png]]

===== Изменение адреса подачи =====
Атрибут настраивает возможность изменения адреса подачи, то есть поле адреса подачи в конкретном заказе можно будет заполнить только один раз, если данный атрибут выключен.

[[Изображение:Поле Адрес подачи.png]]

===== Изменение группы =====
Атрибут настраивает возможность изменения группы экипажей, то есть поле {{button|Группа экипажа}} в конкретном заказе можно будет заполнить только один раз, если данный атрибут выключен.

===== Поле "Экипаж" =====
Атрибут настраивает возможность редактирования поля {{button|Экипаж}}.

[[Изображение:Поле Экипаж.png]]

===== Поле "Сумма" =====
Атрибут настраивает возможность редактирования поля {{button|Сумма}}.

====== Изменение экипажа ======
Атрибут настраивает возможность изменения экипажа, то есть поле {{button|Экипаж}} в конкретном заказе можно будет заполнить только один раз, если данный атрибут выключен.

===== Поле "Оплачено банковской картой" =====
Атрибут настраивает возможность редактирования поля {{button|Оплачено банковской картой}}

[[Файл:Поле Оплачено банковской картой.jpeg]]

===== Кнопка "Подобрать оптимальный экипаж" =====
Атрибут настраивает видимость кнопки {{field|Подобрать оптимальный экипаж}} в карточке заказа.

===== Поле "Вид завершения": тип завершения "Прекращен" =====
Атрибут настраивает поле {{button|Вид завершения}}.

[[Изображение:Поле Вид завершения.png]]

===== Поле "Время завершения" (в завершенных заказах) =====
Атрибут настраивает видимость поля {{поле|Время завершения}} в завершенных заказах (в текущих и предварительных заказах поле всегда скрыто).

===== Поле "Деньги приняты" =====
Атрибут настраивает видимость флажка {{checkbox|Деньги приняты}}.

===== Кнопка "Настройка внешнего вида карточки" =====
Атрибут настраивает видимость кнопки {{кнопка|Настройка внешнего вида карточки}}.

[[Изображение:Кнопка Настройка внешнего вида в карточке заказа.png]]

===== Кнопка "Отмена" =====
Атрибут настраивает доступ к кнопке {{field|Отмена}}.

[[Изображение:Кнопка Отмена.png]]

==== Категория "Экипажи" ====
Позволяет настроить права доступа к [[Справочник «Экипажи»|справочнику «Экипажи»]], к истории изменения состояний экипажей и таблице динамических приоритетов.

===== Экипажи =====
Атрибут позволяет настроить права на видимость [[Окно «Экипажи» в {{ТМ}}|окна «Экипажи»]], на кнопки вывода экипажа на линию, изменения состояний экипажа и завершения смены экипажа.

===== Динамические приоритеты =====
Атрибут настраивает права доступа к таблице динамических приоритетов (см. Файл -> Настройки -> Экипажи -> Подбор на заказ -> Подбор по стоянке).

===== История состояний экипажа =====
Атрибут предоставляет права на просмотр историй состояний заказов. Ее можно просмотреть следующим образом: во-первых, необходимо сделать активным в окне {{button|Экипажи}} тот экипаж, у которого пользователь желает просмотреть историю, во-вторых, нажать на экипаж правой кнопкой мыши и выбрать позицию {{button|История состояний экипажа}}, либо нажать на кнопку {{button|История состояний экипажа}}, которая находится на панели управления окна {{button|Экипажи}}.

==== Категория "Стоянки" ====
Позволяет настроить права доступа для окна [[Окно «Стоянки» в {{ТМ}}|окна {{окно|Стоянки}}]].

===== Стоянки =====
Позволяет настроить видимость [[Окно «Стоянки» в {{ТМ}}|окна «Стоянки»]].

====== Перемещение экипажа в очереди по стоянке ======
Атрибут позволяет настроить доступ к кнопкам перемещения экипажа в очереди по стоянкам.

====== Сортировка стоянок ======
Атрибут позволяет настроить доступ к кнопкам изменения позиции стоянок окна «Стоянки».

====== Установка\снятие экипажа со стоянок ======
Атрибут позволяет настроить доступ к кнопкам установки\снятия экипажа со стоянок.

==== Категория "Клиенты" ====
Дает возможность настроить права доступа на справочники, расчеты и новости клиентов.

===== Все клиенты =====
Справочник "Все клиенты" объединяет в себе справочники физических и юридических лиц. Здесь недоступно добавление новых клиентов, это действие выполняется в соответствующих справочниках.

===== Физические лица =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Физические лица»|справочника «Физические лица»]].

===== Юридические лица =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Юридические лица»|справочника «Юридические лица»]].

===== Любимые экипажи =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Физические лица»#Вкладка «Любимые экипажи»|справочника "Любимые экипажи"]], который находится на одной из вкладок в карточке клиента.

===== Новости =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Физические лица»#Вкладка «Новости»|справочника "Новостей клиента"]]

===== Расчеты =====
Атрибут предоставляет права на просмотр и редактирование расчетов клиента.

====== Время операции ======
Атрибут настраивает возможность редактирования поля {{поле|Время операции}}.

====== Удаленные ======
Атрибут настраивает возможность удаления операций и возможность просмотра таких операций.

===== Сотрудники =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Юридические лица»#Вкладка «Сотрудники»|справочника "Сотрудники"]], который находится на одной из вкладок в карточке клиента.

===== Телефоны =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Юридические лица»#Вкладка «Телефоны»|справочника "Телефоны"]], который находится на одной из вкладок в карточке клиента.

===== Статистика =====
Атрибут предоставляет права на на редактирование [[Справочник «Юридические лица»#Вкладка «Телефоны»|статистики клиентов]] в карточках клиентов.

==== Категория "Водители" ====
Дает возможность настройки прав на справочники:
#[[Окно «Водители: Назначенные штрафы»|Назначенные штрафы]]
#[[Окно «Водители: Планирование смен»|Планирование смен]]
#[[Окно «Водители: Фактические смены»|Фактические смены]]
#[[Окно «Водители: Продажа смен»|Продажа смен]]
#[[Модуль расчетов с водителями в Такси-Мастер|Расчеты]]

===== Назначенные штрафы =====
Атрибут предоставляет права на просмотр и редактирование [[Окно «Водители: Назначенные штрафы»|справочника "Назначенные штрафы"]].

===== Планирование смен =====
Атрибут предоставляет права на просмотр и редактирование [[Окно «Водители: Планирование смен»|справочника "Планирование смен"]].

===== Фактические смены =====
Атрибут предоставляет права на просмотр и редактирование [[Окно «Водители: Фактические смены»|справочника "Фактические смены"]].

===== Продажа смен =====
Атрибут предоставляет права на просмотр и редактирование [[Окно «Водители: Продажа смен»|справочника "Продажа смен"]].

===== Расчеты =====
Атрибут предоставляет права на просмотр и редактирование [[Модуль расчетов с водителями в Такси-Мастер|справочника "Расчеты"]].

====== Время операции ======
Атрибут настраивает возможность редактирования поля {{поле|Время операции}}.

====== Удаленные ======
Атрибут настраивает возможность удаления операций и возможность просмотра таких операций.

===== Пополнить счет =====
Атрибут настраивает возможность доступа к кнопке {{путь|Меню "Водители" -> Пополнить счет}}

==== Категория "Отчеты" ====
Дает возможность настройки прав у [[Отчеты Такси-Мастер|справочника "Отчеты"]], группы отчетов.

===== Отчеты =====
Атрибут предоставляет права на просмотр и редактирование на справочник отчетов (Меню "Отчеты" -> "Редактор отчетов").

===== Группы =====
Атрибут предоставляет права на просмотр и редактирование справочника групп отчетов. Справочник "Группы отчетов" можно открыть из поля {{поле|Группа}} в карточке "Отчеты" (в редакторе отчетов).

===== Импорт =====
Атрибут настраивает видимость пункта меню "Отчеты" -> Импорт.

==== Категория "Карты" ====
Дает возможность настройки прав для справочников:
# [[Справочник «Точки запрета проезда»]]
# [[Справочник «Группы точек запрета проезда»]]
# [[Справочник «Точки выезда из города»]]
# [[Справочник «Привязка районов к карте»]]
# [[Справочник «Привязка стоянок к карте»]]

===== Точки запрета проезда =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Точки запрета проезда»|справочник «Точки запрета проезда»]].

===== Группы точек запрета проезда =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Группы точек запрета проезда»|справочника «Группы точек запрета проезда»]].

===== Точки выезда из города =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Точки выезда из города»|справочника «Точки выезда из города»]].

===== Привязка районов к карте =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Привязка районов к карте»|справочника «Привязка районов к карте»]].

===== Привязка стоянок к карте =====
Атрибут предоставляет права на просмотр и редактирование [[Справочник «Привязка стоянок к карте»|справочника «Привязка стоянок к карте»]].

==== Категория "Связь с водителями" ====
Дает возможность настройки прав для справочников [[Окно «Шаблоны»|«Шаблоны сообщений»]], «Новости» (в меню Водители), видимости некоторых параметров в [[Справочник «Водители»#Добавление нового водителя|карточке водителя]], видимости [[С чего начать?#Отправка сообщений оператором|окна "Сообщения"]], кнопки {{кнопка|Час-Пик}}.

===== Сообщения =====
Атрибут дает возможность настройки видимости кнопки и окна "Сообщения".

===== Шаблоны сообщений =====
Атрибут предоставляет права на просмотр и редактирование справочника [[Окно «Шаблоны»|"Шаблоны сообщений"]].

===== Новости =====
Атрибут предоставляет права на просмотр и редактирование справочника "Новости" в меню "Водители".

===== Группа параметров GPRS (карточка водителя) =====
Атрибут предоставляет права на редактирование [[Справочник «Водители»#Добавление нового водителя|параметров GPRS]] в карточке водителя.

====== Дата блокировки водителя ======
Атрибут предоставляет права на блокировку водителя (в карточке клиента).

===== Режим работы "Час пик" =====
Атрибут дает возможность настройки видимости кнопки [[Час пик|"Час пик"]].

==== Категория "Телефония" ====
Настраивает доступ к справочникам [[Журнал звонков (модуль «Средства связи»)|"Журнал звонков"]], "Записи разговоров", [[Окно «Фильтры телефонов» для устройств связи|"Фильтры телефонов"]], флажкам в [[Окно «Софтфон»|окне "Софтфон"]]

===== Журнал звонков =====
Атрибут настраивает видимость [[Журнал звонков (модуль «Средства связи»)|журнала звонков]].

====== Кнопка "Убрать из неотвеченных" ======
Атрибут настраивает видимость кнопки {{кнопка|Убрать из неотвеченных}}

===== Записи разговоров =====
Атрибут настраивает видимость таблицы "Записи разговоров".

===== Фильтры телефонов =====
Атрибут предоставляет права на просмотр и редактирование [[Окно «Фильтры телефонов» для устройств связи|справочника "Фильтры телефонов"]].

===== Состояние линий =====
Атрибут предоставляет права на просмотр и редактирование [[Окно «Состояние линий»|окна "Состояние линий"]].

===== Софтфон: Флажок "АО" (автоответ) =====
Атрибут позволяет настраивать видимость флажка {{checkbox|"АО"}} в [[Окно «Софтфон»|окне софтфона]].

===== Софтфон: Флажок "АОК" (автооткрытие карточки заказа) =====
Атрибут позволяет настраивать видимость флажка {{checkbox|"АОК"}} в [[Окно «Софтфон»|окне софтфона]].

===== Софтфон: Флажок "П" (перерыв) =====
Атрибут позволяет настраивать видимость флажка {{checkbox|"П"}} в [[Окно «Софтфон»|окне софтфона]].

===== Поля Asterisk Марка и Цвет (карточка автомобиля) =====
Атрибут влияет на видимость полей {{поле|Марка}} и {{поле|Цвет}} в [[Справочник «Автомобили»#Добавление нового автомобиля|карточке автомобиля]].

===== Очередь звонков Asterisk =====
Атрибут предоставляет права на просмотр и редактирование [[Окно «Очередь звонков Asterisk»|окна "Очередь звонков Asterisk"]].

==== Категория "Модуль СМС" ====
Права для настройки возможности отправки коротких текстовых сообщений на сотовые телефоны.

===== Отправка сообщения на номер =====
Атрибут настраивает видимость пункта меню [[Окно «Отправка СМС на номер»|{{окно|Отправка СМС на номер}}]].

===== Отправка сообщения водителям =====
Атрибут настраивает видимость пункта меню [[Окно «Отправка СМС водителям»|{{окно|Отправка СМС водителям}}]].

===== Массовая рассылка =====
Атрибут настраивает видимость пункта меню [[Массовая рассылка СМС|{{окно|Отправка СМС на номер}}]].

===== Фильтры телефонов =====
Атрибут предоставляет права на просмотр и редактирование [[Фильтр сотовых телефонов|справочника "Фильтры телефонов"]].

===== Шаблоны =====
Атрибут предоставляет права на просмотр и редактирование справочника [[Окно «Шаблоны»|"Шаблоны СМС"]].

===== Задачи =====
Атрибут предоставляет права на просмотр задач по отправке СМС.

===== Журнал =====
Атрибут предоставляет права на просмотр журнала отправки СМС.

===== Сервисный список =====
Атрибут предоставляет права на просмотр и редактирование справочника [[Параметры модуля СМС#Заказы|"Сервисный список]]" (Меню "Файл" -> Настройки -> СМС -> Вкладка "Заказы" -> Кнопка {{кнопка|Сервисный список}}.

==== Категория "Платежные терминалы" ====
Настраивает доступ к справочнику [[Модуль интеграции с платежными терминалами#Заведение новой учетной записи платежной системы в Такси-Мастер|"Платежные терминалы"]] и кнопкам {{кнопка|Экспорт терминальных аккаунтов}} и {{кнопка|Импорт терминальных аккаунтов}}.

===== Платежные системы =====
Атрибут предоставляет права на просмотр и редактирование справочника [[Модуль интеграции с платежными терминалами#Заведение новой учетной записи платежной системы в Такси-Мастер|"Платежные системы"]].

===== Экспорт\импорт терминальных аккаунтов =====
Атрибут настраивает видимость кнопок {{кнопка|Экспорт терминальных аккаунтов}} и {{кнопка|Импорт терминальных аккаунтов}}.

===== Сверка =====
Атрибут предоставляет право на формирование файлов сверки.

=== Доступ пользователя к правам на создание отчетов ===
Содержит в себе перечень [[Отчеты Такси-Мастер|отчетов]], к которым необходимо открыть либо запретить доступ пользователя.

{{вам сюда|Отчеты Такси-Мастер}}

После того, как все необходимые права доступа пользователя будут отмечены, для подтверждения создания новой роли нажмите кнопку {{кнопка|ОК}}.

{{картинка|Создание роли в ТМ 2.png}}

Теперь в {{окно|Меню доступ: Роли}} отобразиться созданная вами роль.

{{картинка|Роль в ТМ 2.png}}

== Пользователь в {{ТМ}} ==

На каждом рабочем месте должен быть установлен конкретный [[Пользователь Такси-Мастер|пользователь]] программы {{ТМ}}, у каждого из которых может быть различный набор функций и прав доступа к [[Клиент {{ТМ}}|клиентской части]] программы, которые задаются ролью пользователя. Например, функционал оператора и функционал администратора могут существенно отличаться друг от друга.

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

=== Меню Доступ: Пользователи ===
Первым шагом к созданию нового пользователя будет следующее. Откройте {{окно|Меню доступ}} и выберите меню {{окно|Пользователи}}.
{{картинка|Меню Доступ Пользователи ТМ.png}}

После совершения данных действий у вас появится окно, в котором представлен перечень пользователей, которые уже созданы в программе. Вы можете изменять их настройки и набор прав доступа, выделив конкретного пользователя и нажав кнопку {{ЭУ/Кнопка|тм2-редактировать}} или клавишу {{key|Enter}}. Также вы можете удалять ненужных пользователь, выделив необходимого вам и нажав на кнопку {{ЭУ/Кнопка|тм2-удалить}} или клавишу {{key|Ctrl+Del}}.
Обратите внимание, что права на создание, редактирование и удаление пользователей существуют только в том случае, если они допускаются ролью, то есть установлены соответствующие атрибуты в роли пользователя, который намеревается произвести изменения в составе.

Для того, чтобы создать нового пользователя нажмите кнопку {{ЭУ/Кнопка|тм2-добавить}} или клавишу {{key|Insert}}.

{{картинка|Меню Доступ Пользователи в ТМ2.png}}

=== Окно "Новый пользователь" ===
Для создания нового пользователя программы {{ТМ}} необходимо корректно заполнить все необходимые поля в окне {{окно|Новый пользователь}}. Рассмотрим заполнение каждого поля отдельно.

{{картинка|Новый пользователь ТМ2.png}}

==== Поле "Ф.И.О" ====
В поле {{поле|Ф.И.О.}} введите фамилию, имя, отчество пользователя.

==== Поле "Логин" ====
В поле {{поле|Логин}} введите логин нового пользователя. Логин необходим при работе с [[База данных {{ТМ}}|базой данных]], которая скрыта от пользователя внутри системы.

==== Поле "Пароль" и "Подтверждение" ====
В поле {{поле|Пароль}} введите пароль нового пользователя и повторите его набор в поле {{поле|Подтверждение}}. Пароль необходим для идентификации пользователя при запуске программы Такси-Мастер.

==== Поле "Примечания" ====
В поле {{поле|Примечания}} укажите дополнительные сведения по новому пользователю, если это необходимо.

==== Поле "Номер телефона: сотовый, домашний" ====
В поле {{поле|Сотовый}} введите номер мобильного телефона нового пользователя, а в поле {{поле|Домашний}}, соответственно, его домашний номер.

==== Поле "Уволен по причине" ====
Данное поле заполняется при редактировании карточки пользователя в том случае, если данный пользователь будет уволен. Установка атрибута {{checkbox|Уволен по причине}} будет означать увольнение пользователя, а в самом же поле должна быть указана причина.

==== Атрибут "Удален" ====
Установка данного атрибута означает, что данный пользователь будет удален из общего перечня. Данное действие приведет к изменениям в окне {{окно|Меню доступ: Пользователи}} в списке пользователей программы.

==== Поле "Роли" ====
Если у вас созданы [[#Роль|роли]] пользователей, то в данном окне будет находится их перечень. Установите атрибут у соответствующей роли, в рамках которой будет действовать новый пользователь.

==== Поле "Права" ====
В поле {{поле|Права}} приведен список [[Права доступа пользователя в {{ТМ}}|прав доступа]] пользователя к функционалу клиентской части программы. Если у вас нет списка готовых ролей, то заполните данное поле в [[#Последовательность заполнения новой роли|соответствии с набором прав]], который хотите предоставить новому пользователю программы. Если вы нажмете кнопку {{кнопка|Выделить все}}, то программа автоматически установит атрибуты у каждого права доступа. Кнопка {{кнопка|Снять выделение}} автоматически удалит все установленные атрибуты из данного поля.

После заполнения всех полей окна {{окно|Новый пользователь}}, нажмите кнопку {{кнопка|ОК}}. После совершения этих действий, произойдет добавление нового пользователя в списке пользователей программы Такси-Мастер.

{{картинка|Новый пользователь в ТМ.png}}

Чтобы войти в качестве нового пользователя в программу, необходимо осуществить ее перезапуск. После чего в окне входа {{окно|Добро пожаловать в Такси-Мастер}} в поле {{поле|Пользователь}} введите имя того пользователя, в качестве которого вы хотите зайти в программу, а в поле {{поле|Пароль}} введите пароль, соответствующий данному пользователю. Запустите программу Такси-Мастер.

=== Копирование настроек пользователя ===
Чтобы осуществить передачу настроек от одного пользователя к другому, необходимо совершить следующие действия:
# В окне {{окно|Меню Доступ: Пользователи}} выделите пользователя, настройки которого вы хотите передать.
# Нажмите кнопку {{кнопка|Копировать настройки пользователя}}, которая располагается на панели управления окна и выглядит следующим образом: [[Изображение:Копировать настройки пользователя.png]]
# В появившемся окне {{окно|Копирование настроек}} установите флажки напротив тех пользователей, которым хотите передать права.
# Нажмите {{key|ОК}}

{{картинка|Копирование настроек.png}}

{{Отчет}}
[[Категория:ТМ2]]
[[Категория:Клиентская часть]]
[[Категория:Справочники]]

Как настроить рабочее место Такси-Мастер?

2013-10-28T07:04:33Z

AnnaNikolskih: /* Установка ПО для ключа */

Как настроить рабочее место Такси-Мастер?

2013-10-28T07:02:41Z

AnnaNikolskih: /* Установка ПО для ключа */

'''{{PAGENAME}}''' Ответ на этот вопрос будет изложен ниже.
Полная настройка рабочего места включает в себя несколько этапов:

# [[#Установка|Установка Такси-Мастер]].
# [[#Подключение к базе данных|Настройка подключения к серверу Такси-Мастер]] (к базе данных).
# [[#Подключение к серверу Guardant|Настройка подключения к серверу Guardant]].

На первом рабочем месте, которое будет вашим [[Сервер Такси-Мастер|сервером]], необходимо также проделать ряд важных действий:

# [[#Подключение ключа защиты|Подключить ключ защиты]].
# [[#Установка ПО для ключа|Установить для ключа необходимое программное обеспечение]].
# [[#Установка Firebird|Установить СУБД Firebird]], под управлением которой будет работать база данных.

== Подключение ключа защиты ==
{{also|[[NET III]]|подпись=Основная статья:}}
'''Ключ защиты Guardant NET III''' содержит внутри себя всю лицензионную информацию, необходимую для запуска Такси-Мастер.
Разъем, к которому необходимо подключать ключ защиты, — USB.
Все, что нужно сделать с ключом, — это подключить его к компьютеру.

После подключения операционная система начнет искать подходящий драйвер.
Скорее всего, ей это не удастся.
Драйвер вы установите в дальнейшем вместе с [[#Установка ПО для ключа|остальным программным обеспечением]] для ключа.

Запомните IP-адрес компьютера, к которому подключили ключ защиты.
Подразумевается, что компьютер, к которому подключен ключ, — сервер, поэтому далее в примерах будет использоваться адрес {{code|192.168.0.1}} (см. [[#Установка на сервер|ниже]]).

== Установка ПО для ключа ==
После того, как вы подключили ключ защиты к компьютеру, необходимо установить для ключа программное обеспечение.
Это программное обеспечение включает в себя два компонента:

# Драйвер ключа Guardant NET III.
# //[[Сервер Guardant]].

Драйвер устанавливается ''из [[Дистрибутив Такси-Мастер|дистрибутива Такси-Мастер]]''.
После установки драйвера вы сможете заметить, что зеленый светодиод на ключе защиты загорелся (до этого он мог только мигать).

[[Сервер Guardant]] также устанавливается из дистрибутива Такси-Мастер.
Чтобы убедиться в том, что сервер Guardant будет установлен, при установке Такси-Мастер на шаге выбора компонентов убедитесь в том, что флажок {{checkbox|Сервер GuardantNet3}} ''установлен:''

{{картинка/по центру|Флажок Сервер GuardantNet3 при установке ТМ1.png}}

Подробнее об установке Такси-Мастер вы сможете почитать [[#Установка|ниже]].

== Установка ==
{{also|[[Установка Такси-Мастер]]|подпись=Основная статья:}}
Установка Такси-Мастер происходит по-разному на сервер Такси-Мастер и на клиентские рабочие места.
В первом случае необходимо установить дополнительные компоненты: [[Firebird]] и [[сервер Guardant]], но требуется меньше настроек.
Во втором случае эти компоненты устанавливать не нужно, но необходимо выполнить дополнительную настройку (на каждом рабочем месте).

=== Установка на сервер ===
{{also|[[Сервер Такси-Мастер]]|подпись=Основная статья:}}
{{картинка/по центру|Предустановка Установка на сервер ТМ1.png}}
Чтобы установить серверную часть Такси-Мастер, запустите дистрибутив и следуйте инструкциям.
На шаге выбора компонентов, как указано на изображении выше, выберите предустановку «Установка на сервер» — ниже установятся флажки напротив всех необходимых компонентов.
Обратите внимание, что среди таких компонентов присутствуют:

# [[Сервер Firebird]].
# [[Сервер Guardant]].

Это означает, что, во-первых, база данных будет работать на компьютере-сервере (отчасти поэтому он называется сервером); а во-вторых, ключ будет подключен именно к этому компьютеру.
Если вы, [[#Подключение ключа защиты|следуя инструкции по подключению ключа]], выполняли эти действия на данном рабочем месте, то больше ничего делать не нужно.
Продолжайте установку.

После установки вам потребуется узнать IP-адрес данного компьютера, который в дальнейшем пригодится при [[#Установка на клиент|установке Такси-Мастер на клиентские компьютеры]].
Рекомендуем вам выбирать для компьютера-сервера IP-адрес вида {{code|192.168.0.1}}.

=== Установка на клиент ===
{{картинка/по центру|Предустановка Установка на клиент ТМ1.png}}
В отличие от [[#Установка на сервер|установки на сервер]], установка на клиент происходит немного другим образом.
В частности, такие компоненты, как Firebird и сервер Guardant, не устанавливаются (вместо последнего устанавливается компонент «Клиент Guardant»).
Это первый момент — выбрать на шаге выбора компонентов предустановку «Установка клиентской части».

Второй важный момент при установке — указать путь к базе данных, которая работает на компьютере-сервере:

{{картинка/по центру|Путь к серверу и базе данных при установке ТМ1.png}}

Обратите внимание на поле {{field|Имя сервера}}: в это поле необходимо вводить IP-адрес или имя компьютера, на котором находится ваша рабочая база данных.
В данном примере указан IP-адрес {{code|192.168.0.1}}, который принят в качестве примера [[#Установка на сервер|выше]].
Этот IP-адрес необходимо будет вводить ''на всех'' компьютерах-клиентах при установке клиентской части Такси-Мастер.

== Подключение к базе данных ==
{{also|[[Подключение к базе данных]]|подпись=Основная статья:}}
Подключение к базе данных настраивается непосредственно в Такс-Мастер или в [[Taxi.ini|специальном файле настроек]].
Второй вариант гораздо быстрее, поэтому рассмотрим его.

Обратите внимание, что по умолчанию после установки Такси-Мастер в этом файле записан путь к базе данных на ''локальном'' компьютере.
Это значит, что на компьютере-сервере подключение к базе данных можно не настраивать.
Тем не менее, на компьютерах-клиентах подключение настраивать ''необходимо''.

Чтобы настроить подключение к базе данных (второй вариант), выполните следующие действия:
# Откройте папку, в которую установлена клиентская часть Такси-Мастер. По умолчанию это папка {{путь к папке ТМ1}}.
# Найдите файл {{путь|Taxi.ini}} и откройте его в Блокноте.
# Найдите строку {{code/(}}DatabaseName=...{{code/)}}. Она находится практически в самом начале файла и по умолчанию выглядит так: {{code/(}}DatabaseName=LOCALHOST:C:\Program Files\Taxi\Data.gdb{{code/)}}.
# Замените указанное имя компьютера ({{code|LOCALHOST}}) на IP-адрес компьютера-сервера. Например, так: {{code/(}}DatabaseName=192.168.0.1:C:\Program Files\Taxi\Data.gdb{{code/)}}.
# Сохраните файл.

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

== Подключение к серверу Guardant ==
{{also|{{code|[[gnclient.ini]]}}|подпись=Основная статья:}}
Настройка подключения к [[Сервер Guardant|серверу Guardant]] необходима для того, чтобы программа Такси-Мастер на клиентском рабочем месте могла запуститься.
Подключение к серверу Guardant никак не связано с [[#Подключение к базе данных|подключением к базе данных]], и его настрйока происходит в [[gnclient.ini|другом настроечном файле]]:

# Откройте папку, в которую установлена клиентская часть Такси-Мастер. По умолчанию это папка {{путь к папке ТМ1}}.
# Найдите файл {{путь|gnclient.ini}} и откройте его в Блокноте.
# Найдите строку {{code/(}}IP_NAME=...{{code/)}}. Она находится ближе к концу файла и по умолчанию выглядит так: {{code/(}}IP_NAME=LOCALHOST{{code/)}} или {{code/(}}IP_NAME=127.0.0.1{{code/)}}.
# Замените указанное имя компьютера (или IP-адрес) на IP-адрес компьютера, к которому [[#Подключение ключа защиты|подключен ключ защиты]]. Например, как было принято [[#Подключение ключа защиты|выше]], укажите адрес {{code|192.168.0.1}}: {{code/(}}IP_NAME=192.168.0.1{{code/)}}.
# Сохраните файл.

Эти действия, как и в случае с [[#Подключение к базе данных|настройкой подключения к базе данных]], необходимо выполнить на всех-компьютерах клиентах.
На компьютере-сервере будет работать настройка по умолчанию.

== Запуск Такси-Мастер ==
После всех выполненных настроек запустите Такси-Мастер.
Если на каком-то из рабочих мест Такси-Мастер не запустится, соберите все файлы с расширением {{code|.log}} из папки Такси-Мастер и вложенных папок, и отправьте их вместе с письмом на {{ящик ОТП}}.

{{info|Вы можете использовать [[TMSysInfo|утилиту сбора информации о системе]] для сбора всех необходимых файлов с расширением {{code|.log}}.}}

[[Категория:Вопросы]]
[[Категория:Установка]]
[[Категория:Настройка]]

С чего начать?

2013-10-25T11:55:17Z

AnnaNikolskih: /* Запуск программы {{ТМ}}. */

После того, как программа Такси-Мастер успешно установлена на ваш компьютер, у вас может возникнуть вопрос: с чего начать работу с программой? Какие должны быть первоначальные действия? Как сделать программу более удобной для работы в ней? Эта статья является пошаговой инструкцией для новых пользователей программы {{ТМ}}, в ней вы найдете все ответы на интересующие вас вопросы.

{{youtube|http://youtu.be/119owyLDysA|заголовок=Установка программы, ее компонентов и модулей. Первоначальные действия по настройке программы}}

== Запуск программы {{ТМ}}. ==

Для начала необходимо [[Запуск {{ТМ}}|запустить программу]]. Вы это можете сделать несколькими способами:

# Если в процессе установки вы установили флажок "Создать ярлык на рабочем столе", то на вашем рабочем столе появится иконка Такси-Мастер. Запустить программу вы можете двойным щелчком левой кнопки мыши по ярлыку.
#: [[Изображение:Ярлык Такси-Мастер.png]]
# Запуск программы через меню "Пуск". Найдите в меню "Пуск" папку с программой Такси-Мастер и нажмите один раз по ярлыку программы для входа в нее.
# Запуск программы через папку, в которую вы ее устанавливали. Зайдите в эту папку (если вы выбрали путь по умолчанию, то она будет располагаться здесь: {{путь к папке ТМ2}}). Запустите программу {{путь|TMEnterprise.exe}} двойным щелчком мыши по ярлыку.

Обратите внимание, что ваша версия программы Такси-Мастер может отличаться, в статье же указаны примеры для Такси-Мастер Enterprise.

== Вход в программу: ввод имени и пароля ==

После того, как программа будет запущена, вам необходимо пройти авторизацию, во время которой вы вводите имя и пароль в форме "Вход в систему". Для начала вы должны указать на месте логина {{code|Администратор}} и на месте пароля {{code|admin}}. После того, как все [[Настройка Такси-Мастер|настройки]] установлены и все необходимые действия для корректной работы программы произведены, в том числе заполнено меню [[Пользователь Такси-Мастер|Пользователи]], вы будете заходить в программу уже под другим логином и паролем, которые создадите в [[Справочник «Пользователи» (ТМ2)| справочнике Пользователи]]

{{картинка|Вход в ТМ.png}}

== Начало работы в Такси-Мастер ==

Если запуск программы произошел успешно, то перед вами появится [[Клиент {{ТМ}}|клиентская часть программы Такси-Мастер]]. Это рабочая область программы (см. [[Главное окно Такси-Мастер]]), где операторы будут совершать все необходимые действия. Она состоит из трех главных областей: [[Заказ]]ы, [[Экипаж]]и и [[Окно «Стоянки» в {{ТМ}}|Стоянки]].

Вам необходимо заполнить [[Справочники]] программы для ее корректной работы. Так как работа многих справочников связана между собой, заполняйте их в определенной последовательности, потому что, например, для заполнения справочника "Экипажи", вам нужно сначала заполнить справочники "Водители" и Автомобили".

Меню "Справочники" располагается на главной панели управления программы.

{{картинка|Меню "Справочники".png}}

=== Последовательность заполнения справочников: ===

# [[Справочник «Автомобили» (ТМ2)|Справочник «Автомобили»]], в котором вы должны будете перечислить все автомобили, которые работают в вашей фирме, а также дополнительную информацию о них.
# [[Справочник «Водители» (ТМ2)|Справочник «Водители»]], в котором укажите всех водителей, которые работают в вашей фирме.
# [[Справочник «Экипажи»]]. Укажите в нем водителей, автомобили и владельцев автомобилей.
# [[Справочник «Тарифы»]]. В нем отражаются тарифы, с помощью которых будет производиться автоматический расчет стоимости заказов.
# [[Справочник «Сдачи с заказов»]], в котором находится список сдач с заказов.
# [[Справочник «Признаки экипажей»]], в котором вы создаете список признаков экипажей.
# [[Справочник «Группы экипажей»]]. В нем вы можете осуществить группировку ваших экипажей по какому-либо определенному признаку.
# [[Справочник «Смены сдач с заказов»]] - список смен сдач с заказов.
# [[Справочник «Города»]] - в нем задаются города и привязываются к карте.
# [[Справочник «Районы»]], в котором вы указываете список возможных районов, а также цену посадки и цену высадки, которые могут прибавляться к стоимости заказа.
# [[Справочник «Улицы» (ТМ2)|Справочник «Улицы»]] - в него вы заносите список улиц.
# [[Справочник «Проезды между районами»]]. В него вы должны занести стоимость проезда между районами.
# [[Справочник «Пункты»| Справочник «Пункты и Стоянки»]], в него вы заносите необходимые пункты и стоянки.
# [[Справочник «Группы точек запрета проезда»]] - группировка точек запрета проезда.
# [[Справочник «Точки запрета проезда»]] - в нем вы указывайте точки запрета проезда.
# [[Справочник «Телефоны»]] - здесь хранится список всех телефонов, с которых могут быть оформлены заказы.
# [[Справочник «Категории телефона»]] - в него вы заносите список категорий, в каждую из которых могут быть включены один или несколько телефонов.
# [[Справочник «Правила изменения категорий телефонов»]] - в нем вы указываете список правил переноса телефонов из одной категории в другую.
# [[Справочник «Статистика по телефонам»]] - справочник, в котором хранятся номера телефонов, с которых уже когда-либо принимались заказы. Заполняется автоматически.
# [[Справочник «Типы дисконтных карт»]] - должен содержать набор дисконтных карт.
# [[Справочник «Дисконтные карты»]] - в него вы заносите список дисконтных карт, а также в этом справочнике будет отражаться статистика по ним.
# [[Справочник «Скидки/наценки на заказы»]] - в него вы заносите список скидок (наценок) на ваши услуги.
# [[Справочник «Скидки»|Справочник «Скидки клиентов»]] - в данном справочнике вы должны сформировать список скидок. Данные скидки распространяются не на всех клиентов, а на определенную категорию, или действуют единовременно, в отличие от справочника [[Справочник «Скидки/наценки на заказы»]], в котором указываются скидки (наценки), распространяющиеся на всех клиентов.
# [[Справочник «Услуги» (ТМ2)|Справочник «Услуги»]] - в него вы можете внести список дополнительных услуг.
# [[Справочник «Штрафы»]] - в него вы заносите список возможных штрафов для водителей.
# [[Справочник «Шаблоны операций»]]. В него вы должны занести шаблоны операций для расчетов.
# [[Справочник «Расходы фирмы»]] - в нем должен находиться список расходов вашей фирмы.
# [[Справочник «Состояния заказа»]] - в этом справочнике находятся состояния заказов. Вы можете как добавлять новые состояния заказов, так и редактировать уже существующие.
# [[Справочник «Варианты изменения состояний заказов»]] - в него вы заносите пользовательские состояния заказов, которые используются в работе для особых случаев.
# [[Справочник «Состояния экипажа»]] - в нем хранится список состояний экипажа. Вы можете добавлять новые состояния, а также пользоваться и редактировать уже существующие.
# [[Справочник «Звуковые файлы Asterisk»]] - в нем вы можете установить звуковое сопровождение для различных категорий (только для программ Такси Мастер 2, работающих с программным обеспечением [[Asterisk]]).

=== Меню "Доступ". Пользователи программы. ===

В меню "Доступ" осуществляется ввод, редактирование, группировка [[Права доступа пользователя в Такси-Мастер#Пользователь в Такси-Мастер|пользователей]] программы Такси-Мастер, а также их [[Права доступа пользователя в Такси-Мастер|прав]] на доступ.

Для того, чтобы начать работу с Такси-Мастер, вам необходимо заполнить [[Права доступа пользователя в Такси-Мастер#Пользователь в Такси-Мастер|справочник «Пользователи»]] и [[Права доступа пользователя в Такси-Мастер#Роли|справочник «Роли»]].

После того, как ввод соответствующих данных будет произведен, необходимо перезапустить программу Такси-Мастер.

=== Создание нового пользователя ===

Чтобы создать нового пользователя программы Такси-Мастер, воспользуйтесь меню "Доступ". Выберите в нем пункт "Пользователи" и откройте его.

{{картинка|Меню Доступ Пользователи ТМ.png}}

После открытия меню "Пользователи" у вас появляется окно "Доступ: Пользователи", в котором находится возможный список пользователей данной программы. Чтобы добавить нового пользователя, например, Оператора, нужно совершить следующие действия:

# Нажать на кнопку {{ЭУ/Кнопка|тм2-добавить}} или клавишу {{key|Insert}}.
# В появившемся окне "Новый пользователь" заполнить поле {{button|Ф.И.О}}, в котором необходимо указать фамилию, имя и отчество нового пользователя.
# В поле {{button|Логин}} указать логин нового пользователя.
# В поле {{button|Пароль}} ввести пароль пользователя, а в поле {{button|Подтверждение}} повторить его.
# В поле {{button|Группа пользователей}} откройте список групп пользователей, нажав на стрелочку, и выберите соответствующую группу.
# В поле {{button|Примечания}} ввести необходимые примечания по новому пользователю.
# В поле {{button|Сотовый телефон}} и {{button|Домашний телефон}} указать телефоны пользователя.
# Поле {{поле|Уволен по причине}}. Данное поле заполняется при редактировании карточки пользователя в том случае, если данный пользователь будет уволен. Установка атрибута {{checkbox|Уволен по причине}} будет означать увольнение пользователя, а в самом же поле должна быть указана причина.
# Установка атрибута {{checkbox|Удален}} означает, что данный пользователь будет удален из общего перечня. Данное действие приведет к изменениям в окне {{окно|Меню доступ: Пользователи}} в списке пользователей программы.
# Поле {{поле|Роли}}. Если у вас созданы [[Права доступа пользователя в {{ТМ}}#Роль|роли]] пользователей, то в данном окне будет находится их перечень. Установите атрибут у соответствующей роли, в рамках которой будет действовать новый пользователь.
# В поле {{поле|Права}} приведен список [[Права доступа пользователя в {{ТМ}}|прав доступа]] пользователя к функционалу клиентской части программы. Если у вас нет списка готовых ролей, то заполните данное поле в [[Права доступа пользователя в {{ТМ}}#Последовательность заполнения новой роли|соответствии с набором прав]], который хотите предоставить новому пользователю программы. Если вы нажмете кнопку {{кнопка|Выделить все}}, то программа автоматически установит атрибуты у каждого права доступа. Кнопка {{кнопка|Снять выделение}} автоматически удалит все установленные атрибуты из данного поля.
# Нажать кнопку {{button|ОК}}

{{картинка|Новый пользователь ТМ2.png}}

После выполнения всех этих действий, у вас появится окно-подтверждение, сообщающее об успешной регистрации.

Теперь в окне "Доступ: Пользователи" у вас появится новый пользователь.

{{картинка|Новый пользователь в ТМ.png}}

Выйдите из программы Такси-Мастер и вновь зайдите в нее, но вместо пользователя {{code|Администратор}} и пароля {{code|admin}} введите логин и пароль того пользователя, которого вы создали.

Более подробно ознакомиться с правилами создания нового пользователя можно [[Права доступа пользователя в {{ТМ}}#Пользователь в {{ТМ}}|здесь]].

== Начало работы в Такси-Мастер. Основные функции. ==

Основной функцией в Такси-Мастер является прием и обработка заказов клиентов. Как же это делать?

Для начала вы должны корректно заполнить [[Справочник «Экипажи»]], что позволит вам ставить на заказ экипажи.

=== Ввод экипажа на линию ===

Чтобы привести в действие экипаж, необходимо сделать следующее:

# Корректно заполнить Справочник «Экипажи», перед этим заполнив [[Справочник «Автомобили» (ТМ2)|Справочник Автомобили]] и [[Справочник «Водители» (ТМ2)|справочник Водители]].
# Чтобы вывести экипаж на линию, необходимо в окне "Экипажи" включить вкладку {{button|На линии}}.
# Затем нажать на {{ЭУ/Кнопка|тм2-добавить}} или клавишу {{key|Insert}}.
# В окне "Вывод экипажа на линию" заполните поле {{button|Экипаж}}, нажав на стрелочку рядом с ним. В выпавшем списке выберите экипаж, который хотите поставить на линию. После этого у вас автоматически заполнятся поля {{button|Водитель}} и {{button|Машина}}.
# В поле {{button|Стоянка}} выберите стоянку, на которой расположен в данный момент экипаж.
# В поле {{button|Состояние}} выберите нужное вам состояние автомобиля.
# В поле {{button|Начало смены}} укажите время начала смены экипажа. Если вы оставите значение времени по умолчанию, то экипаж выйдет на линию в эту же минуту.
# После совершения всех этих действий нажмите {{button|ОК}}
#: [[Изображение:Вывод экипажа на линию в ТМ 2.png]]

Если вы правильно произвели эти действия, то в окне "Экипажи" во вкладке "На линии" у вас должен появится экипаж, который вы вывели, с тем состоянием, которое вы обозначили в поле "Состояние".

{{картинка|Экипажи на линии в ТМ 2.png}}

=== Заполнение карточки заказа ===

Следующим действием вам нужно будет обработать заказ. Это можно будет сделать в [[Карточка заказа в {{ТМ}}|карточке заказа]], которая находится в [[Заказы|окне {{окно|Заказы}}]] и открывается путем нажатия кнопки {{Добавить}} или клавиши {{key|Insert}}.

Поля заполнения в карточке заказа разделены на группы, которые отделены друг от друга горизонтальной линией. Некоторые из них нужно заполнять вручную, а некоторые заполнятся автоматически. Также часть необязательных для ввода полей можно пропустить во время оформления "Карточки заказа".

Последовательность заполнения [[КЗ|карточки заказа]]:

# Группа "Заказ принят" оформляется при принятии заказа от клиента. Включает в себя такие поля как:
#* {{button|Телефон}} - обязательное для заполнения поле. Сейчас вы должны ввести телефон клиента в ручную, а во время работу оно будет заполняться автоматически, если у вас установлен какой-либо из [[Модули Такси-Мастер|модулей связи]].
#* {{button|Звонить на}} - здесь находится номер для обратной связи с клиентом. Вводится автоматически из поля {{field|Телефон}}.
#* {{button|Время принятия}} — время приема заказа. Заполняется автоматически.
#* {{button|Время подачи}} — время подачи автомобиля. Автоматически заполняется с интервалом в десять минут после {{field|Время принятия}}.
#* {{button|Через}} — время, через которое клиент ожидает подачи автомобиля.
#* {{button|Вод}} - время, в течение которого водитель должен прибыть по адресу подачи.
#* {{checkbox|Почасовой}} — включение заказу атрибута [[Почасовой заказ|почасового]].
#* {{button|Клиент}} - при нажатии на стрелочку выпадет список клиентов.
#* {{button|Заказчик}} — имя заказчика.
#* {{button|Дисконтная карта №}} - номер дисконтной карты клиента.
# Группа "Подача заказа" заполняется в соответствии с адресом подачи автомобиля.
#* {{button|Адрес}} — адрес подачи. Выберите необходимый адрес из выпадающего списка. В этом списке находятся улицы города, а номер дома вы должны указать после запятой вручную.
#* {{button|Стоянка}} заполняется автоматически.
#* {{checkbox|С бордюра}} — добавить заказу атрибут [[заказ с бордюра|«с бордюра»]].
# Группа "Назначение". В этой группе указывается адрес назначения заказа.
#* {{button|Адрес}} — [[адрес назначения]].
#* {{button|Стоянка}} заполняется автоматически в соответствии с адресом назначения.
#* {{checkbox|За город}} — добавить заказу атрибут [[Загородный заказ|«загородный»]].
# Группа "Исполнение заказа". В ней отражается информация о выполнении заказа. При вводе карточки заказа эта группа не является обязательной. В данный же момент для вас имеет значение лишь поле {{button|Экипаж}}, в котором вы должны выбрать экипаж из выпадающего списка. В процессе работы оператор может самостоятельно назначать экипаж на выполнение заказа, а также это могут делать водители с помощью программы [[TMDriver]]. Подробнее ознакомиться с заполнением полей группы "Исполнение заказа" вы можете, перейдя по [[Группа «Исполнение заказа»|ссылке]].

Для принятия заказа после заполнения всех необходимых полей нажмите {{button|ОК}}

{{картинка|Карточка заказа (ТМ2).png}}

Теперь в окне {{window|Заказы}} у вас появится принятый заказ.

{{картинка|Заказ принят в ТМ 2.png}}

Чтобы назначить экипаж на заказ, нужно заполнить соответствующее поле в Карточке заказа, либо же водитель самостоятельно с помощью [[TMDriver]] откликается на заказ.
Сейчас вам необходимо назначить экипаж в Карточке заказа. После этих действий у заказа произойдут изменения в графе "Состояние". Теперь там будет значиться "Заказ отправлен".

{{картинка|Состояние заказа Заказ отправлен в ТМ 2.png}}

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

{{картинка|Состояние экипажа На заказе в ТМ 2.png}}

Также вы можете ознакомиться с более подробной информацией по заполнению карточки заказа [[Карточка заказа в {{ТМ}}#Полная схема приема заказа в {{ТМ}}|здесь]].

=== Общение оператора с водителем ===
Диалог оператора с водителем происходит путем отправки сообщений. Данная функция доступна лишь при условии, что у вас установлен [[Модуль СМС|модуль СМС]].
Связь происходит при помощи [[TMDriver]].

==== Отправка сообщений оператором ====
Оператор может отправить сообщения водителю двумя способами:
# При заполнении [[Карточка заказа в {{ТМ}}|карточки заказа]] оператор, назначая экипаж на заказ, может отправить водителю сообщение, нажав на кнопку {{кнопка|Отправить GPRS сообщение водителю}}. Таким образом оператор может отправлять сообщение только одному водителю, который назначен на заказ.
# С помощью меню {{окно|Сообщения}}, которое находится на панели управления программы.

{{картинка|Меню Сообщения.png}}

Рассмотрим второй способ отправки сообщения водителям подробнее. При выборе пункта меню {{окно|Сообщения}} открывается окно {{window|Сообщения}}.

{{картинка|Окно Сообщения.png}}

Далее будет необходимо произвести следующие действия:
# Выберите водителя из списка, который располагается в левой части окна, и установите атрибут рядом с его позывным. Если вы хотите произвести рассылку всем водителям вашей службы такси, то нажмите кнопку {{кнопка|Выделить всех}} либо сочетание клавиш {{key|Ctrl}}+{{key|A}}. Снять выделение со всех водителей можно нажав на кнопку {{кнопка|Снять выделение}} или же на клавиши {{key|Ctrl}}+{{key|U}}.
# Введите текст сообщения в поле, предназначенном для ввода сообщения, которое располагается в нижней части окна. Очистить все поле ввода сообщения можно путем нажатия на кнопку {{кнопка|Очистить текст сообщения}}. Также ввод сообщения можно осуществлять с помощью [[Окно «Шаблоны»|шаблонов СМС]]. Чтобы вставить шаблон в текст сообщения, нажмите на кнопку {{кнопка|Шаблоны}} либо на клавиши {{key|Сtrl}}+{{key|Down}}, после чего у вас выпадет список шаблонов, из которого вы выбирайте нужный. Изменять шаблоны вы можете путем нажатия на кнопку {{кнопка|Редактировать шаблоны}}.
# Нажмите кнопку {{кнопка|Отправить сообщение}} или клавишу {{key|Enter}} для отправки сообщения. После этого введенное сообщение отобразиться в окне и будет отправлено получателю.

==== Отправка сообщения водителем ====
Отправка сообщения водителем осуществляется через форму на [[TMDriver]] с помощью специальной формы сообщений. Открыть эту форму можно из разных источников, чаще — из [[#Список стоянок|списка стоянок]] кнопкой {{pda key|Сообщение}}.

{{картинка|Отправка_сообщения_(КПК).png}}

В данном окне имеется всего два поля — поле ввода позывного получателя и поле ввода текста.
Чтобы отправить сообщение, укажите позывной получателя и введите текст сообщения, затем нажмите {{pda key|Отправить}}.

{{info|
Чтобы отправить сообщение всем операторам, в качестве получателя укажите {{code|0}}.
Чтобы отправить сообщение всем водителям, в качестве получателя укажите {{code|*}}.
Отправка сообщения всем водителям должна быть разрешена [[Настройка модуля Java#Общие|настройками модуля]].
}}

=== Расчеты с водителями ===
Расчеты с водителями оператор осуществляет с помощью [[Модуль расчетов с водителями в {{ТМ}}|модуля расчетов с водителями]].

== Ссылки ==

[[Запуск {{ТМ}}]]

[[Настройка Такси-Мастер]]

[[Справочник «Пользователи»]]

[[Клиент {{ТМ}}]]

[[Главное окно Такси-Мастер]]

[[Заказ]]

[[Справочники]]

[[Справочник «Права доступа»]]

[[Справочник «Группы прав»]]

{{Справочник}}

[[Категория:ТМ2]]
[[Категория:Установка]]
[[Категория:Клиентская часть]]

Утилита резервного копирования

2013-10-25T11:15:25Z

AnnaNikolskih: /* Ссылки */

{{Info/Clean logs|ссылка=#Журнал работы}}

[[Изображение:Tmbackup-window.png|thumb|Окно утилиты резервного копирования]]
'''Утилита резервного копирования''' — [[Утилиты Такси-Мастер|утилита]], позволяющая создавать [[Резервная копия базы данных|резервные копии]] [[База данных|базы данных]].
Это очень важная утилита, которая предохраняет вас от возможных потерь данных при некорректной эксплуатации системы [[Такси-Мастер]].

Утилита резервного копирования устанавливается на [[сервер Такси-Мастер]].
При установке вы можете отказаться от утилиты, на шаге выбора компонентов убрав флажок {{checkbox-on|Утилита резервного копирования}}, но это не рекомендуется.

== Резервные копии ==
{{картинка/по центру|TMBackup вкладка Резервные копии.png}}

На вкладке {{tab|Резервные копии}} находятся задачи резервного копирования.
Каждая задача представляет собой набор нескольких параметров:

# Путь к базе данных.
# Расписание копирования.
# Путь к каталогу с резервными копиями.
# Дополнительные данные, необходимые для работы утилиты с данной задачей.

Чтобы создать новое задание, нажмите кнопку {{button|Добавить}} или клавишу {{key|Instert}} и в открывшемся окне создания новой задачи заполните следующие поля:

# В поле {{field|DNS имя сервера}} укажите имя компьютера, на который установлен [[сервер Такси-Мастер]], и на котором работает [[Firebird]].
# В поле {{field|База данных}} укажите ''абсолютный [[Путь к базе данных|путь]]'' к [[База данных|базе данных]].
# В поле {{field|Время}} укажите время, в которое будет производиться создание [[Резервная копия базы данных|резервной копии]].
# В поле {{field|Дни недели}} укажите дни недели, по которым будет производиться резервное копирование.
# В поле {{field|Каталог резервирования}} укажите путь к каталогу, в котором будут храниться резервные копии.
# Нажмите {{button|OK}} для сохранения новой задачи.

=== Карточка задачи резервного копирования ===
В таблице на вкладке {{tab|Резервные копии}} находится список задач.
На [[#Резервные копии|изображении выше]] вы можете увидеть список из одной задачи, но в действительности задач может быть как угодно много.
По двойному клику по задаче открывается ее '''карточка''':

{{картинка/по центру|Карточка задачи резервного копирования TMBackup.png|Карточка задачи на резервное копирование базы данных}}

[[#Резервные копии|Выше]] уже были описаны все поля, а также данные, которые в эти поля нужно вводить.
Здесь, на изображении, вы можете увидеть, как в действительности выглядит заполненная карточка задачи резервного копирования.

В данном случае поля {{field|Пользователь}} и {{field|Пароль}} ''недоступны для редактирования''.
В них введены данные для [[База данных Такси-Мастер|базы данных Такси-Мастер]].
Это происходит в том случае, когда утилите однозначно известно, база данных какой версии будет резервироваться.

== Резервирование ==
'''Резервирование базы данных''' может происходить автоматически (на основании задач, см. [[#Резервные копии|выше]]) или вручную.

Чтобы происходило автоматическое резервирование на основании задач, утилита резервного копирования всегда должна быть запущена.
Это единственное условие, никаких дополнительных действий не требуется.

Чтобы зарезервировать [[База данных|базу данных]] ''вручную'', необходимо выполнить следующие действия:

# Откройте утилиту резервного копирования на вкладке {{tab|Резервные копии}}.
# Выберите в списке задачу, по которой нужно произвести резервирование. Для этого нужно щёлкнуть на ней мышью, чтобы курсор установился на нее.
# Нажмите кнопку {{button/Резервировать}} или комбинацию клавиш {{key|Ctrl}}+{{key|B}} (от англ. “backup”). Появится небольшое окно, в котором вы увидите индикатор процесса резервирования.
# Дождитесь завершения резервирования. После завершения операции окно с индикатором процесса исчезнет.
# Сверните утилиту.

== Восстановление из резервной копии ==
Восстановление из резервной копии происходит по какому-то заданию, поэтому чтобы восстановить базу данных, нужно создать хотя бы одно задание (см. [[#Резервные копии|выше]]).
После этого выполните следующие действия:

# Отключите все [[подключения к базе данных]].
# Выберите в списке задание на резервирование, которое соответствует нужной вам базе данных.
# Нажмите кнопку {{button/Восстановить}} или комбинацию клавиш {{key|Ctrl}}+{{key|R}} (от англ. “restore”).
# В открывшемся диалоговом окне выбора файла укажите путь к нужной резервной копии.
# Нажмите {{button|OK}}.
# Дождитесь завершения восстановления базы данных.

После этого рекомендуется перезагрузить компьютер, хотя это не является обязательным.

== Shadow-копии ==
Shadow-копирование представляет собой ведение синхронной копии базы данных.
Другими словами, это точная копия рабочей базы данных, которая ведется в другом месте файловой системы компьютера, на котором работает [[сервер Firebird]].
При поломке рабочей базы вы можете быстро переключиться на shadow-копию, что позволяет сузить пробел в работе к минимальному времени.
Чтобы настроить shadow-копирование в утилите резервного копирования, выполните следующие действия:

# Откройте утилиту резервного копирования.
# Откройте вкладку {{tab|Настройки}}.
# В группе полей {{fieldset|Shadow-копии}} в поле {{field|База данных}} укажите абсолютный путь к файлу базы данных.
# В поле {{field|Пользователь}} укажите имя пользователя для подключения к базе данных.
#: {{code|SYSDBA}} для [[{{ТМ}}]].
# В поле {{field|Пароль}} укажите пароль для подключения к базе данных.
#: {{code|admin}} для [[{{ТМ}}]].
# В поле {{field|Скрипт запуска Firebird}} укажите путь к файлу скрипта для запуска [[Firebird]].
#: {{путь к папке ТМ2|\Firebird\bin\_start.bat}} для [[{{ТМ}}]].
# В поле {{field|Скрипт остановки Firebird}} укажите путь к файлу скрипта для остановки [[Firebird]].
#: {{путь к папке ТМ2|\Firebird\bin\_stop.bat}} для [[{{ТМ}}]].
# Откройте вкладку {{tab|Shadow-копии}}.
# Нажмите кнопку {{button/ui|добавить-запись}} или клавишу {{key|Insert}}.
# В открывшемся окне {{window|Shadow-копия}} укажите путь к файлу shadow-копии (например, {{путь|D:\tme_db.shd}}).
# Нажмите {{button|OK}}.

Не создавайте большое количество shadow-копий — это может замедлить работу сервера.

{{info|
Shadow-копия должна находиться в локальной файловой системе — на локальных дисках компьютера, на котором работает сервер Firebird.
Сохранение shadow-копии на сетевой ресурс ''невозможно'' ввиду специфики работы СУБД Firebird.
}}

=== Активация работы shadow-копии ===
Если в процессе работы [[база данных]] повредилась (самая частая ошибка — физическое копирование при имеющихся [[Подключение к базе данных|подключениях]]), вы можете быстро активировать shadow-копию.
Для этого выполните следующие действия:

# Откройте утилиту резервного копирования.
# Откройте вкладку {{tab|Shadow-копии}}.
# Выберите в списке shadow-копию.
# Нажмите кнопку {{button|Активировать}}.

После этого вы можете заняться восстановлением базы данных (см. [[починка базы данных]]).

=== Перед обновлением ===
Перед [[Обновление {{ТМ}}#Shadow-копии|обновлением]] необходимо отключать shadow-копирование, чтобы [[база данных]] корректно обновилась.
После обновления shadow-копирование снова можно включить.

== Настройки ==
На вкладке {{tab|Настройки}} находятся настройки утилиты резервного копирования.
Не рекомендуется изменять их.

== Журнал работы ==
Утилита резервного копирования ведет [[журнал работы]] — {{путь|TMBackup.log}}.
Он находится в той же папке, в которой располагается утилита, по умолчанию путь к нему — {{путь к папке ТМ2|\Logs\TMBackup.log}}.

== Ссылки ==
* [[Сборка мусора]] — сборка мусора с помощью утилиты администрирования базы данных.
* [[Перенос базы данных]]
* [[Резервная копия базы данных]]
* [[Обновление Такси-Мастер]]
* {{code/url|http://taxidev.blogspot.com/2010/03/tmbackup.html}} — рецепт приготовления TMBackup.
* {{code/url|http://www.taxidev.ru/2010/04/shadow.html}} — советы по shadow-копированию.

{{утилиты}}

[[Категория:Утилиты]]
[[Категория:База данных]]
[[Категория:Подключающиеся к базе данных]]
[[Категория:Резервное копирование]]

TMServer

2013-10-08T07:08:24Z

AnnaNikolskih: /* Запуск и настройка TMServer */

'''{{PAGENAME}}''' — [[Утилиты Такси-Мастер|утилита]] [[{{ТМ}}]], позволяющая снизить нагрузку на сервер [[Firebird]] и [[База данных {{ТМ}}|базу данных Такси-Мастер]], таким образом повысить производительность системы Такси-Мастер.
TMServer, в сущности, является дополнительным слоем между [[Клиент {{ТМ}}|клиентской]] и [[Сервер {{ТМ}}|серверной частями Такси-Мастер]].
Из этого следует, что если TMServer используется, то все клиенты Такси-Мастер подключаются именно к этой утилите, а не напрямую к базе данных.
Чтобы указать той или иной клиентской части, что нужно работать с TMServer, необходимо выполнить настройку соответствующим образом.

== Внешний вид TMServer ==
Внешне утилита TMServer выглядит так:

{{картинка|TMServer.png}}

В верхней части находится индикатор статуса и кнопка {{button|Настройки}}, открывающая отдельное окно параметров утилиты.
Ниже следует область журналирования, еще ниже отображается статистика по отправленным и полученным данным.

== Запуск и настройка TMServer ==
Первое, что нужно сделать, — запустить TMServer.
В главном окне утилиты нажмите кнопку {{button|Настройки}}, чтобы открыть окно настроек:

{{картинка|Настройки_TMServer.png}}

Необходимо ввести [[Путь к базе данных|настройки подключения к базе данных]].
Порты, которые утилита будет прослушивать, также заданы по умолчанию (30000, 29999).

Также необходимо ввести настройки ключа защиты [[Ключ защиты|Guardant]].

Поле {{поле|адрес}}. В данном поле вводится IP-адрес сервера, на котором установлен ключ Guardant. Внимание, не используйте в качестве ip-адреса 127.0.0.1, т.к. клиентские приложения будут обращаться к этому адресу, при подключении к [[Сервер_Guardant| серверу Guardant]]

В настройках включите выполнение автоматических действий, чтобы перенести функцию выполнения автоматических действий над данными с рабочего места Такси-Мастер на TMServer.

== Нужно ли подключать ''все'' рабочие места? ==
К TMServer настоятельно рекомендуется подключать ''все'' рабочие места Такси-Мастер.

== Тихий запуск ==
Утилита TMServer имеет возможность «тихого» запуска — исключается необходимость вручную стартовать работу утилиты после ее открытия.
Тихий запуск включается с помощью ключа <code>-s</code>, то есть из командной строки необходимо запустить:

<pre>
"C:\Program Files\TMEnterprise\Utilities\TMServer.exe" -s
</pre>

Вы можете создать ярлык, в строку запуска которого добавить строку, указанную выше, после чего данный ярлык будет запускать утилиту в «тихом» режиме.

{{утилиты}}

[[Категория:ТМ2]]
[[Категория:AUO]]
[[Категория:Настройка]]
[[Категория:Клиентская часть]]
[[Категория:База данных]]
[[Категория:Утилиты]]
[[Категория:TMServer]]
[[Категория:Тихий запуск]]

Сервер связи с водителями

2013-10-03T11:40:13Z

AnnaNikolskih: /* Версия протокола */

{{Info/Clean logs|ссылка=#Журналы работы GPRS-сервера}}
[[Изображение:Сервер связи с водителями.png|thumb|Окно сервера связи с водителями]]
'''Сервер связи с водителями''' — это серверное приложение, которое является одной из трех частей [[Модуль «Связь с водителями»|модуля «Связь с водителями»]].
сервер связи с водителями позволяет соединить между собой [[мобильное приложение TMDriver]] и [[Такси-Мастер]].
Сервер использует одну ''специфическую'' лицензию ключа Guardant, обращаясь к [[Сервер Guardant|серверу Guardant]].

В системе необходимо присутствие только одного сервера связи с водителями, это также подчеркивается в его названии (сервер всегда один).
Клиенты сервера связи с водителями — это копии [[TMDriver]], [[TMDriverWM]] и [[TMDriverWinCE]], их для одного сервера может быть как угодно много (зависит от количества приобретенных лицензий).

== Архитектурная единица ==
Сервер связи с водителями — это отдельная единица системы.

Сервер связи с водителями является сервером в отношении всех копий [[TMDriver]], которые к нему подключаются.
Количество возможных подключений зависит от записи в [[NET III|ключе защиты]].

Сервер связи с водителями является клиентом для [[Сервер Guardant|сервера Guardant]] и для [[Firebird|сервера Firebird]].
Другими словами, сервер связи с водителями — это:

# [[Клиент Guardant]], поэтому имеет свой файл настроек {{code|[[gnclient.ini]]}}.
# [[Клиент Firebird]], поэтому имеет свою строку подключения к базе данных, описанную в файле {{code|[[#Файл конфигурации сервера связи с водителями|TMGPRSConnection.xml]]}} {{серым|(в этом же файле сохраняет настройки [[конфигуратор сервера связи с водителями]])}}.

== Версия сервера связи с водителями ==
Сервер связи с водителями имеет свой собственный номер версии.
Версия, помимо информационной составляющей, несет важный смысл: предохранить сервер связи с водителями от подключения неподходящих копий [[TMDriver]], то есть тех приложений, которые не подходят для работы с сервером связи с водителями текущей версии.
Вы можете увидеть номер версии в заголовке окна сервера {{серым|(отмечено зеленым)}}:

{{картинка|Версия сервера связи с водителями.png}}

При установке новой версии (например, после [[Компоненты модуля «Связь с водителями»|скачивания]]) водители могут потерять возможность подключаться к новому серверу связи с водителями ввиду разницы между версиями, поэтому все копии [[TMDriver]] также нужно своевременно обновлять.

=== Версия протокола ===
Помимо версии, сервер связи с водителями несет в себе информацию о протоколе взаимодействия с [[TMDriver]].
Не имеет особого значения номер протокола, однако помните о том, что {{важно|протоколы сервера связи с водителями и TMDriver должны совпадать}} для корректной работы системы.
В противном случае [[TMDriver]] либо не подключится, выдав сообщение о несоответствии версии протокола; либо будет работать с ошибками.

== Установка сервера связи с водителями ==

{{Предупреждение/GPRS-сервер}}

Установка сервера связи с водителями происходит из одного дистрибутива с программой [[Такси-Мастер]], полученного вами на компакт-диске или по электронной почте.
Дистрибутив — один самостоятельный исполняемый файл с расширением {{code|exe}}.

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

Сразу после завершения установки программы и сервера связи с водителями его необходимо запустить. Ярлык сервера располагается на рабочем столе и имеет следующую иконку:

{{картинка|Иконка сервера связи с водителями.png}}

Также вы можете его найти по пути {{путь|Меню "Пуск"\TMEnterprise\Сервер связи с водителями\Сервер связи с водителями}} и {{путь|C:\Program Files (x86)\TMEnterprise\TMDriverServer\TMDriverServer}}

В Конфигураторе, который является частью сервера, необходимо отредактировать настройки сервера связи с водителями.
С начальными настройками сервер связи с водителями ''неработоспособен в большинстве случаев.''

== Настройка сервера связи с водителями ==

Для настройки работы сервера связи с водителями служит конфигуратор сервера связи с водителями.
Конфигуратор открывается из окна сервера связи с водителями, по нажатию на кнопку "Настройки".

{{картинка|Настройки сервера связи с водителями.png}}

Помните также о том, что настройка одного только сервера связи с водителями не является достаточной.
Чтобы система [[Такси-Мастер]] работала качественно, необходимо полностью [[Настройка модуля «Связь с водителями»|настраивать]] весь [[модуль «Связь с водителями»]].

Окно настроек сервера делится на несколько областей (например, {{fieldset|База данных}}, {{fieldset|Сервер}} и др.).
В каждой из областей находятся управляющие элементы (поля ввода, флажки).

{{картинка|Окно настроек сервера связи с водителями.png}}

Ниже следует описание каждого поля:

=== {{fieldset|Порт}} ===
# В поле {{field|Порт}} указывается порт, по которому приложение TMDriver подключается к серверу связи с водителями.

=== {{fieldset|База данных}} ===
# В поле {{field|IP}} указывается IP-адрес компьютера, с которого осуществляется запуск программы Такси-Мастер и на котором расположена база данных.
# В поле {{field|Путь к базе данных}} указывается ''[[Путь к базе данных|абсолютный путь]]'' к [[База данных Такси-Мастер|базе данных Такси-Мастер]].
# Нажмите кнопку {{button|Проверить}} для установки корректности введенной информации по базе данных. Если она задана верно, то у вас появится запись "Подключение произошло успешно" и индикатор приобретет зеленый цвет. Если же какая-либо информация будет введена некорректно, то индикатор приобретет красный цвет, а в поле появятся замечания по заполнению, которые необходимо будет устранить.

{{info|
Вы можете оставить поле {{field|IP}} пустым — в этом случае сервер связи с водителями будет находить подключение ''автоматически''.
}}

=== {{fieldset|TMServer}} ===
# Поле {{поле|IP-адрес}}. В нем необходимо указать локальный IP-адрес компьютера, на котором расположена база данных, и работает TMServer.
# Поля {{поле|Порт 1}} и {{поле|Порт 2}}. В эти поля заносятся данные из соответствующих [[TMServer#Настройка клиентских рабочих мест|настроек TMServer]] и чаще всего автоматически устанавливаются по умолчанию.
# Если все настройки по TMServer будут установлена верно, то у вас появится запись "Подключение произошло успешно" и индикатор приобретет зеленый цвет. Если же какая-либо информация будет задана некорректно, то индикатор приобретет красный цвет, а в поле появятся замечания по заполнению, которые необходимо будет устранить.

=== {{fieldset|Ключ}} ===
В данной группе происходит установка настроек по ключу защиты [[Ключ защиты|Guardant]].
# Поле {{поле|IP-адрес}}. В данном поле вводится IP-адрес сервера, на котором установлен ключ Guardant.
# Если все настройки по ключу защиты будут установлена верно, то у вас появится запись "Подключение произошло успешно" и индикатор приобретет зеленый цвет. Если же какая-либо информация будет задана некорректно, то индикатор приобретет красный цвет, а в поле появятся замечания по заполнению, которые необходимо будет устранить.

=== {{fieldset|Интерфейс}} ===
# Флажок {{checkbox-on|Сворачивать в трей}} включает или выключает сворачивание сервера связи с водителями в трей (правый нижний угол на панели управления рядом с часами).

=== {{fieldset|Запуск}} ===
# Флажок {{checkbox-on|Автоматически начинать работу после запуска}} включает или выключает автоматическое начало работы сервера связи с водителями после его запуска без необходимости нажимать кнопку {{button|Старт}}.
# Флажок {{checkbox-on|Запускаться в свернутом виде}} включает или выключает сворачивание сервера связи с водителями в трей сразу же после его запуска.
# Флажок {{checkbox-on|Запускаться при загрузке Windows}} включает или выключает автоматический запуск сервера связи с водителями сразу же после загрузки ОС WIndows.

== Запуск сервера связи с водителями ==
[[Изображение:Taskmgr-на-сервере-ТМ.png|thumb|Процессы, которые должны быть запущены]]
Чтобы запустить сервер связи с водителями, необходимо выполнение нескольких условий:

# Запущен [[Firebird]].
# [[База данных Такси-Мастер]] работоспособна, и к ней есть доступ.
# Запущен [[сервер Guardant]], и к нему есть доступ.
# Ключ [[NET III]] подключен к тому компьютеру, на котором запущен [[сервер Guardant]].
# Ключ [[NET III]] корректно [[Прошивка NET III|прошит]].
# [[Файл настройки доступа к NET III]] отредактирован и содержит корректную информацию.
# Локальная сеть позволяет соединить сервер связи с водителями (в данном случае он выступает как [[клиент Guardant]]) и [[сервер Guardant]].
# Пользователь Windows, под которым выполнен вход, обладает правами на запуск приложений, в том числе — сервер связи с водителями.

Если условия выполняются, вы сможете запустить сервер связи с водителями.
Для этого выполните следующие действия:

# Откройте меню «Пуск».
# Найдите папку, соответствующую серверу связи с водителями.
# Запустите ярлык '''Сервер связи с водителями'''.

Вы можете запустить сервер связи с водителями прямо из папки, в которую он установлен.
Для этого выполните действия:

# Откройте папку, в которую установлен сервер связи с водителями (по умолчанию, {{путь|C:\Program Files (x86)\TMEnterprise\TMDriverServer\TMDriverServer}}).
# Запустите файл {{путь|TMDriverServer.exe}}.

== Работа сервера связи с водителями ==
При работе сервер связи с водителями показывает окно информации.
Если закрыть это окно, сервер связи с водителями отключится, и каждое [[мобильное приложение TMDriver]] получит сообщение об обрыве связи и перестанет получать информацию о стоянках и заказах.
Чтобы этого не произошло, не закрывайте окно сервера связи с водителями.
Если вы хотите, чтобы оно не занимало место на экране, сверните его в панель задач Windows.

Для начала работы сервера нажмите на кнопку {{button|Старт}}. После этого все работающие мобильные приложения [[TMDriver]] подключатся к нему и будут получать информацию о заказах и стоянках из программы Такси-Мастер.

=== Доступ к интернет ===
Во время работы сервер связи с водителями организует несколько каналов связи через интернет.
Объект, с которым происходит соединение, — это [[мобильное приложение TMDriver]].
Таких объектов может быть несколько, но это не имеет принципиального значения.
сервер связи с водителями нуждается в ''прямом'' доступе к интернет, то есть без участия прокси-серверов, а также в ''статическом ip-адресе''.
Вы можете организовать работу и с динамическим внешним ip-адресом, но в этом случае техническая поддержка будет оказана вам с очень маленькой вероятностью.

Чтобы проверить доступ к вашему серверу связи с водителями извне, вы можете воспользоваться сервисом [http://ping.eu/port-chk/ ping.eu], выбрав режим {{radio|Port check}}.
В поле {{field|Domain or host name}} укажите внешний ip-адрес компьютера, на котором установлен и запущен сервер связи с водителями, а в поле {{field|Port number}} — номер порта, по которому происходит соединение.
Вводите в эти поля те же данные, которые вы вводите в настройках [[TMDriver]]:

# В поле {{field|Domain or host name}} — данные из поля {{field|Сервер}} настроек [[TMDriver]].
# В поле {{field|Port number}} — данные из поля {{field|Порт}} настроек [[TMDriver]].

После этого нажмите {{button|Go}}.
Если в результате работы вы получите ответ {{code|port closed}}, значит проблема находится на стороне компьютера, на котором работает сервер связи с водителями.
Примите меры для открытия доступа к нему по указанному порту.
Если же вы увидите сообщение {{code|port open}}, следовательно, проблема заключается в настройках TMDriver; в этом случае проверьте правильность введенных данных (сервер, порт, [[ИД водителя]], пароль водителя).

=== Работа с прокси ===
Сервер связи с водителями самостоятельно не поддерживает работу с прокси, поэтому если вы устанавливаете сервер связи с водителями на компьютер, который имеет выход в интернет через прокси, вам необходимо использовать NAT для того, чтобы обеспечить доступ извне к какому-то определенному порту (часто — {{code|22457}}).
Если прямого доступа извне к серверу связи с водителями нет, водители с [[TMDriver]] не смогут работать с этим сервером, и как следствие, не смогут выходить на смену, выполнять заказы и вообще участвовать в рабочем процессе диспетчерской.
Будьте внимательны при настройке внешнего канала интернет в вашей диспетчерской.

== Обновление сервера связи с водителями ==
Обновление сервера связи с водителями происходит параллельно [[Обновление Такси-Мастер 2|обновлению Такси-Мастер]] из одного дистрибутива.

Единственное, что нужно помнить при обновлении компонентов системы, это то, что прежде всего необходимо '''остановить старый сервер связи с водителями''', нажав кнопку {{button|Стоп}} и закрыв окно сервера связи с водителями.
Подождите несколько секунд, чтобы сервер связи с водителями гарантированно успел освободить [[NET III|лицензию ключа]].

Дождитесь окончания процесса установки и запустите сервер связи с водителями.
Готово.

== Журналы работы сервера связи с водителями ==
Во время работы сервер связи с водителями заполняет актуальной информацией несколько [[Журнал работы|журналов работы]].
Их четыре:

# Непосредственно [[журнал работы сервера связи с водителями]] — первичный источник информации о проблемах, которые могут возникнуть в работе.
# Журнал входящих пакетов сервера связи с водителями.
# Журнал исходящих пакетов сервера связи с водителями.
# Журнал соединений сервера связи с водителями.

Все журналы работы сервера связи с водителями располагаются по пути {{путь|C:\Program Files (x86)\TMEnterprise\TMDriverServer\Logs}}

== Организация внешнего соединения ==
Статический внешний IP-адрес является требованием для корректной работы сервера связи с водителями.
Однако если у вас нет возможности выделить статический адрес, вы можете использовать ''динамический адрес в комбинации с динамическим DNS''.

'''Динамический DNS''' позволяет клиентам (в случае с сервером связи с водителями клиенты — это [[TMDriver]] и [[TMDriverWM]]) обращаться к серверу (то есть, к серверу связи с водителями) по ''имени'' (DNS).
''Имя'' же указывает на ''действующий IP-адрес'', по которому находится сервер связи с водителями.
Таким образом, если IP-адрес сервера изменяется (а он будет изменяться, если не статический), то на клиентах (TMDriver) ''не нужно'' менять настройки соединения — все сделает провайдер динамических DNS.

=== Как настроить dynamic DNS? ===
Мы рекомендуем использовать сервис DynDNS ({{code/url|http://dyndns.com}}).
Помимо этого, существует множество других, но DynDNS проверен временем, и мы можем поручиться за качество его работы.

Итак, как настроить динамический DNS с помощью сервиса DynDNS?
Для этого нужно выполнить несколько простых действий:

# Откройте страницу {{code/url|http://dyndns.com}} и зарегистрируйтесь (создайте аккаунт). Надежно сохраните логин и пароль.
# После регистрации подтвердите аккаунт — пройдите по ссылке, которая будет в письме, отправленном на электронный ящик, указанный при регистрации.
# В разделе Services выберите услугу: “Dynamic DNS Free” (Services → Domain Services → Dynamic DNS → Dynamic DNS Free).
# Нажмите “Get started”.
# В поле “Host name” введите желаемый домен третьего уровня. Придумайте такой домен третьего уровня, чтобы, во-первых, он однозначно был уникальным (очевидно, DNS “petya” или “taxi” уже заняты). Например, домен “txi-txi”.
# В выпадающем списке, расположенном правее Host name, укажите желаемый домен второго уровня. Из Host name и домена второго уровня будет складываться полный DNS. Запомните его — он пригодится в дальнейшем.
# Wildcard Status, Service Type и Mail Routing оставьте по умолчанию.
# Нажмите на ссылку “Use auto detected IP address A.B.C.D”, где {{code|A.B.C.D}} — ваш текущий внешний IP-адрес, который был автоматически определен сервисом.
# Нажмите “Add to cart”.
# Нажмите Next, затем — Activate Services.

Готово.
Теперь необходимо [http://cdn.dyndns.com/windows/DynUpSetup.exe скачать утилиту], которая должна работать на компьютере-сервере (на нем работает сервер связи с водителями), подключенном к интернету и сообщать службе DynDNS о любом изменении вашего динамического IP-адреса.
Настройка этой утилиты заключается в указании ваших данных для доступа к аккаунту DynDNS (логин и пароль) и выбранного доменного имени.

После настройки утилиты необходимо перезагрузить компьютер.
Клиентская утилита DynDNS запустится вместе с операционной системой и сразу приступит к работе.
От DynDNS больше ничего не требуется — вы можете запустить сервер связи с водителями и перенастроить в TMDriver параметры подключения (в поле {{field|Сервер}} указать выданное сервисом DynDNS имя, то есть домен третьего уровня).

== Ссылки ==
* [[Журнал работы сервера связи с водителями]] — описание сообщений, которые могут появиться в журнале работы сервера связи с водителями. Рекомендуется к прочтению системным администраторам.
* {{code/url|http://taximasta.ya.ru}} — блог о настройке сервера связи с водителями и не только.
* {{code/url|http://ping.eu}} — ресурс для тестирования внешних сетевых ресурсов вашего компьютера.

[[Категория:Серверы]]
[[Категория:Модуль «Связь с водителями»]]
[[Категория:Настройка]]
[[Категория:Подключающиеся к базе данных]]
[[Категория:Сервер связи с водителями]]

Вход в Такси-Мастер

2013-10-03T08:06:51Z

AnnaNikolskih: /* Настройки входа в {{ТМ}} */

'''Вход в {{ТМ}}''' — процедура запуска [[Такси-Мастер]], при которой происходит сопоставление пользователя, работающего с системой, пользователю, заведенному в [[справочник]]е Такси-Мастер.
Пользователи Такси-Мастер заводятся в особом справочнике [[Пользователи Такси-Мастер|«Пользователи»]]. Вход происходит при запуске Такси-Мастер через форму входа.

== Пошаговая инструкция для входа в Такси-Мастер ==
{{youtube|http://youtu.be/1NwfOkmAgNo|заголовок=Вход в Такси-Мастер}}

# Осуществите запуск программы, щелкнув два раза левой кнопкой мыши по ярлыку программы.
# В открывшемся окне {{окно|Добро пожаловать в Такси-Мастер}} введите имя пользователя. Имя пользователя, от лица которого необходимо осуществить вход в программу, вы выбираете из выпадающего списка в поле {{поле|Пользователь}}. Если это первый вход в программу и у вас не заполнен [[справочник «Пользователи»]], то вы производите запуск программы под пользователем {{code|Администратор}}, который имеет право на администрирование системы. После того, как [[справочник «Пользователи»]] будет заполнен и соответствующие [[Права доступа пользователя в {{ТМ}}|права пользователя]] будут заданы, вы осуществляете запуск программы от его имени.
# Укажите пароль пользователя, от имени которого вы осуществляете вход в программу Такси-Мастер, в поле {{поле|Пароль}}. Каждому конкретному пользователю в [[справочник «Пользователи»|справочнике «Пользователи»]]задается свой пароль. Если вы осуществляете запуск от имени {{code|Администратор}}а, то пароль для него будет {{code|admin}}(по умолчанию).
# Нажмите кнопку {{кнопка|Вход}} для запуска Такси-Мастер.

{{картинка|Вход в ТМ.png}}

== Настройки входа в {{ТМ}} ==

Для корректной работы Такси-Мастер, необходимо, в первую очередь, произвести настройки приложения [[TMServer]]. С его помощью Такси-Мастер получает данные о расположении [[База данных {{ТМ}}|базы данных]] и [[Ключ защиты|ключа защиты]].
Настройки входа задаются непосредственно при запуске программы в меню {{окно|Настройки}}.

{{картинка|Настройки входа в ТМ.png}}

=== База данных ===
Настройки [[База данных {{ТМ}}|базы данных]] важны для корректной работы программы, поскольку в них накапливается вся информация в процессе работы.

Элементы группы "База данных":
# Поле {{поле|IP-адрес}} и поле {{поле|Путь}} заполняются автоматически, информацией полученной из приложения [[TMServer]].
# Поле {{поле|Пароль администратора}}. В данном поле можно задавать и изменять пароль администратора. В поле {{поле|Подтверждение пароля}} необходимо будет повторить пароль для его подтверждения. Кнопка, расположенная рядом, меняет символы ввода пароля: вместо звездочек будет отображаться пароль в буквенном виде как он есть.
# Таблица дает информацию по таким параметрам базы данных и программы Такси-Мастер как версия и сборка.
# Атрибут {{checkbox|автоматически заходить в программы под пользователем Windows}}. Если установить данный атрибут, то произойдет взаимосвязь логина и пароля пользователя программы с логином и паролем пользователя операционной системы. То есть при входе в операционную систему оператор уже укажет свои логин и пароль и, соответственно, при запуске программы не нужно будет производить этих действий. Данные параметры задаются в операционной системе, а также в [[Справочник «Пользователи»|справочнике «Пользователи»]] и должны быть идентичны.
# Если вся информация по базе данных будет установлена верно, то у вас появится запись "Подключение произошло успешно" и индикатор приобретет зеленый цвет. Если же какая-либо информация будет задана некорректно, то индикатор приобретет красный цвет, а в поле появятся замечания по заполнению, которые необходимо будет устранить.

=== TMServer ===
Настройки [[TMServer]] необходимы для взаимодействия утилиты TMServer и программы Такси-Мастер.

Элементы группы TMServer:
# Поле {{поле|IP-адрес}}. В нем необходимо указать локальный IP-адрес компьютера, на котором расположена база данных, и работает TMServer.
# Поля {{поле|Порт 1}} и {{поле|Порт 2}}. В эти поля заносятся данные из соответствующих [[TMServer#Настройка клиентских рабочих мест|настроек TMServer]] и чаще всего автоматически устанавливаются по умолчанию.
# Если все настройки по TMServer будут установлена верно, то у вас появится запись "Подключение произошло успешно" и индикатор приобретет зеленый цвет. Если же какая-либо информация будет задана некорректно, то индикатор приобретет красный цвет, а в поле появятся замечания по заполнению, которые необходимо будет устранить.

=== Ключ ===
В данной группе происходит установка настроек по ключу защиты [[Ключ защиты|Guardant]].

Элементы группы "Ключ":
# Поле {{поле|IP-адрес}}. заполняются автоматически, информацией полученной из приложения [[TMServer]].
# Поле {{поле|Наименование организации}} заполняется автоматически по данным, которые прошиты в ключе защиты. По такому же принципу автоматически заполняются поля {{поле|ТМ}}, в котором отображается общее количество лицензий, и {{поле|Asterisk}}, в котором отображается версия [[Asterisk]].
# Данные о [[Модуль «Интеграция с картами»|интеграции с картами]] и интеграции с телефонией прошиваются в ключ защиты. При запуске программы в соответствующих полях можно выбирать, установив атрибут в нужной позиции, как карту, с которой программа будет производить интеграцию, так и телефонию.
# Если все настройки по ключу защиты будут установлена верно, то у вас появится запись "Подключение произошло успешно" и индикатор приобретет зеленый цвет. Если же какая-либо информация будет задана некорректно, то индикатор приобретет красный цвет, а в поле появятся замечания по заполнению, которые необходимо будет устранить.

В случае корректного заполнения настроек входа, индикаторы База данных, TMServer и Ключ приобретают зеленый цвет.

[[Категория:Клиентская часть]]
[[Категория:ТМ2]]

TMServer

2013-10-03T07:47:42Z

AnnaNikolskih: /* Запуск и настройка TMServer */

'''{{PAGENAME}}''' — [[Утилиты Такси-Мастер|утилита]] [[{{ТМ}}]], позволяющая снизить нагрузку на сервер [[Firebird]] и [[База данных {{ТМ}}|базу данных Такси-Мастер]], таким образом повысить производительность системы Такси-Мастер.
TMServer, в сущности, является дополнительным слоем между [[Клиент {{ТМ}}|клиентской]] и [[Сервер {{ТМ}}|серверной частями Такси-Мастер]].
Из этого следует, что если TMServer используется, то все клиенты Такси-Мастер подключаются именно к этой утилите, а не напрямую к базе данных.
Чтобы указать той или иной клиентской части, что нужно работать с TMServer, необходимо выполнить настройку соответствующим образом.

== Внешний вид TMServer ==
Внешне утилита TMServer выглядит так:

{{картинка|TMServer.png}}

В верхней части находится индикатор статуса и кнопка {{button|Настройки}}, открывающая отдельное окно параметров утилиты.
Ниже следует область журналирования, еще ниже отображается статистика по отправленным и полученным данным.

== Запуск и настройка TMServer ==
Первое, что нужно сделать, — запустить TMServer.
В главном окне утилиты нажмите кнопку {{button|Настройки}}, чтобы открыть окно настроек:

{{картинка|Настройки_TMServer.png}}

Необходимо ввести [[Путь к базе данных|настройки подключения к базе данных]].
Логин и пароль для подключения к базе данных заданы по умолчанию, их изменение в большинстве случаев не требуется.
Порты, которые утилита будет прослушивать, также заданы по умолчанию (30000, 29999, 29998).

Также необходимо ввести настройки ключа защиты [[Ключ защиты|Guardant]].

Поле {{поле|адрес}}. В данном поле вводится IP-адрес сервера, на котором установлен ключ Guardant. Внимание, не используйте в качестве ip-адреса 127.0.0.1, т.к. клиентские приложения будут обращаться к этому адресу, при подключении к [[Сервер_Guardant| серверу Guardant]]

В настройках включите выполнение автоматических действий, чтобы перенести функцию выполнения автоматических действий над данными с рабочего места Такси-Мастер на TMServer.

== Нужно ли подключать ''все'' рабочие места? ==
К TMServer настоятельно рекомендуется подключать ''все'' рабочие места Такси-Мастер.

== Тихий запуск ==
Утилита TMServer имеет возможность «тихого» запуска — исключается необходимость вручную стартовать работу утилиты после ее открытия.
Тихий запуск включается с помощью ключа <code>-s</code>, то есть из командной строки необходимо запустить:

<pre>
"C:\Program Files\TMEnterprise\Utilities\TMServer.exe" -s
</pre>

Вы можете создать ярлык, в строку запуска которого добавить строку, указанную выше, после чего данный ярлык будет запускать утилиту в «тихом» режиме.

{{утилиты}}

[[Категория:ТМ2]]
[[Категория:AUO]]
[[Категория:Настройка]]
[[Категория:Клиентская часть]]
[[Категория:База данных]]
[[Категория:Утилиты]]
[[Категория:TMServer]]
[[Категория:Тихий запуск]]

TMServer

2013-10-03T07:45:22Z

AnnaNikolskih: /* Запуск и настройка TMServer */

'''{{PAGENAME}}''' — [[Утилиты Такси-Мастер|утилита]] [[{{ТМ}}]], позволяющая снизить нагрузку на сервер [[Firebird]] и [[База данных {{ТМ}}|базу данных Такси-Мастер]], таким образом повысить производительность системы Такси-Мастер.
TMServer, в сущности, является дополнительным слоем между [[Клиент {{ТМ}}|клиентской]] и [[Сервер {{ТМ}}|серверной частями Такси-Мастер]].
Из этого следует, что если TMServer используется, то все клиенты Такси-Мастер подключаются именно к этой утилите, а не напрямую к базе данных.
Чтобы указать той или иной клиентской части, что нужно работать с TMServer, необходимо выполнить настройку соответствующим образом.

== Внешний вид TMServer ==
Внешне утилита TMServer выглядит так:

{{картинка|TMServer.png}}

В верхней части находится индикатор статуса и кнопка {{button|Настройки}}, открывающая отдельное окно параметров утилиты.
Ниже следует область журналирования, еще ниже отображается статистика по отправленным и полученным данным.

== Запуск и настройка TMServer ==
Первое, что нужно сделать, — запустить TMServer.
В главном окне утилиты нажмите кнопку {{button|Настройки}}, чтобы открыть окно настроек:

{{картинка|Настройки_TMServer.png}}

Необходимо ввести [[Путь к базе данных|настройки подключения к базе данных]].
Логин и пароль для подключения к базе данных заданы по умолчанию, их изменение в большинстве случаев не требуется.
Порты, которые утилита будет прослушивать, также заданы по умолчанию (30000, 29999, 29998).

Также необходимо ввести настройки ключа защиты [[Ключ защиты|Guardant]].

Поле {{поле|адрес}}. В данном поле вводится IP-адрес сервера, на котором установлен ключ Guardant. Внимание, не используйте в качестве ip-адреса 127.0.0.1, т.к. клиентские приложения будут обращаться к этому адресу, при подключении к [[Сервер_Guardant| серверу Guardant]]

В настройках включите выполнение автоматических действий, чтобы перенести функцию выполнения автоматических действий над данными с рабочего места Такси-Мастер на TMServer.

== Нужно ли подключать ''все'' рабочие места? ==
К TMServer настоятельно рекомендуется подключать ''все'' рабочие места Такси-Мастер.

== Тихий запуск ==
Утилита TMServer имеет возможность «тихого» запуска — исключается необходимость вручную стартовать работу утилиты после ее открытия.
Тихий запуск включается с помощью ключа <code>-s</code>, то есть из командной строки необходимо запустить:

<pre>
"C:\Program Files\TMEnterprise\Utilities\TMServer.exe" -s
</pre>

Вы можете создать ярлык, в строку запуска которого добавить строку, указанную выше, после чего данный ярлык будет запускать утилиту в «тихом» режиме.

{{утилиты}}

[[Категория:ТМ2]]
[[Категория:AUO]]
[[Категория:Настройка]]
[[Категория:Клиентская часть]]
[[Категория:База данных]]
[[Категория:Утилиты]]
[[Категория:TMServer]]
[[Категория:Тихий запуск]]

TMServer

2013-10-03T07:19:56Z

AnnaNikolskih: /* Запуск и настройка TMServer */

'''{{PAGENAME}}''' — [[Утилиты Такси-Мастер|утилита]] [[{{ТМ}}]], позволяющая снизить нагрузку на сервер [[Firebird]] и [[База данных {{ТМ}}|базу данных Такси-Мастер]], таким образом повысить производительность системы Такси-Мастер.
TMServer, в сущности, является дополнительным слоем между [[Клиент {{ТМ}}|клиентской]] и [[Сервер {{ТМ}}|серверной частями Такси-Мастер]].
Из этого следует, что если TMServer используется, то все клиенты Такси-Мастер подключаются именно к этой утилите, а не напрямую к базе данных.
Чтобы указать той или иной клиентской части, что нужно работать с TMServer, необходимо выполнить настройку соответствующим образом.

== Внешний вид TMServer ==
Внешне утилита TMServer выглядит так:

{{картинка|TMServer.png}}

В верхней части находится индикатор статуса и кнопка {{button|Настройки}}, открывающая отдельное окно параметров утилиты.
Ниже следует область журналирования, еще ниже отображается статистика по отправленным и полученным данным.

== Запуск и настройка TMServer ==
Первое, что нужно сделать, — запустить TMServer.
В главном окне утилиты нажмите кнопку {{button|Настройки}}, чтобы открыть окно настроек:

{{картинка|Настройки_TMServer.png}}

Необходимо ввести [[Путь к базе данных|настройки подключения к базе данных]].
Логин и пароль для подключения к базе данных заданы по умолчанию, их изменение в большинстве случаев не требуется.
Порты, которые утилита будет прослушивать, также заданы по умолчанию (30000, 29999, 29998).

Также необходимо ввести настройки ключа защиты [[Ключ защиты|Guardant]].
Поле {{поле|адрес}}. В данном поле вводится IP-адрес сервера, на котором установлен ключ Guardant.

В настройках включите выполнение автоматических действий, чтобы перенести функцию выполнения автоматических действий над данными с рабочего места Такси-Мастер на TMServer.

== Нужно ли подключать ''все'' рабочие места? ==
К TMServer настоятельно рекомендуется подключать ''все'' рабочие места Такси-Мастер.

== Тихий запуск ==
Утилита TMServer имеет возможность «тихого» запуска — исключается необходимость вручную стартовать работу утилиты после ее открытия.
Тихий запуск включается с помощью ключа <code>-s</code>, то есть из командной строки необходимо запустить:

<pre>
"C:\Program Files\TMEnterprise\Utilities\TMServer.exe" -s
</pre>

Вы можете создать ярлык, в строку запуска которого добавить строку, указанную выше, после чего данный ярлык будет запускать утилиту в «тихом» режиме.

{{утилиты}}

[[Категория:ТМ2]]
[[Категория:AUO]]
[[Категория:Настройка]]
[[Категория:Клиентская часть]]
[[Категория:База данных]]
[[Категория:Утилиты]]
[[Категория:TMServer]]
[[Категория:Тихий запуск]]

TMServer

2013-10-03T07:19:15Z

AnnaNikolskih: /* Запуск и настройка TMServer */

'''{{PAGENAME}}''' — [[Утилиты Такси-Мастер|утилита]] [[{{ТМ}}]], позволяющая снизить нагрузку на сервер [[Firebird]] и [[База данных {{ТМ}}|базу данных Такси-Мастер]], таким образом повысить производительность системы Такси-Мастер.
TMServer, в сущности, является дополнительным слоем между [[Клиент {{ТМ}}|клиентской]] и [[Сервер {{ТМ}}|серверной частями Такси-Мастер]].
Из этого следует, что если TMServer используется, то все клиенты Такси-Мастер подключаются именно к этой утилите, а не напрямую к базе данных.
Чтобы указать той или иной клиентской части, что нужно работать с TMServer, необходимо выполнить настройку соответствующим образом.

== Внешний вид TMServer ==
Внешне утилита TMServer выглядит так:

{{картинка|TMServer.png}}

В верхней части находится индикатор статуса и кнопка {{button|Настройки}}, открывающая отдельное окно параметров утилиты.
Ниже следует область журналирования, еще ниже отображается статистика по отправленным и полученным данным.

== Запуск и настройка TMServer ==
Первое, что нужно сделать, — запустить TMServer.
В главном окне утилиты нажмите кнопку {{button|Настройки}}, чтобы открыть окно настроек:

{{картинка|Настройки_TMServer.png}}

Необходимо ввести [[Путь к базе данных|настройки подключения к базе данных]].
Логин и пароль для подключения к базе данных заданы по умолчанию, их изменение в большинстве случаев не требуется.
Порты, которые утилита будет прослушивать, также заданы по умолчанию (30000, 29999, 29998).

Также необходимо ввести настройки ключа защиты [[Ключ защиты|Guardant]].
# Поле {{поле|IP-адрес}}. В данном поле вводится IP-адрес сервера, на котором установлен ключ Guardant.

В настройках включите выполнение автоматических действий, чтобы перенести функцию выполнения автоматических действий над данными с рабочего места Такси-Мастер на TMServer.

== Нужно ли подключать ''все'' рабочие места? ==
К TMServer настоятельно рекомендуется подключать ''все'' рабочие места Такси-Мастер.

== Тихий запуск ==
Утилита TMServer имеет возможность «тихого» запуска — исключается необходимость вручную стартовать работу утилиты после ее открытия.
Тихий запуск включается с помощью ключа <code>-s</code>, то есть из командной строки необходимо запустить:

<pre>
"C:\Program Files\TMEnterprise\Utilities\TMServer.exe" -s
</pre>

Вы можете создать ярлык, в строку запуска которого добавить строку, указанную выше, после чего данный ярлык будет запускать утилиту в «тихом» режиме.

{{утилиты}}

[[Категория:ТМ2]]
[[Категория:AUO]]
[[Категория:Настройка]]
[[Категория:Клиентская часть]]
[[Категория:База данных]]
[[Категория:Утилиты]]
[[Категория:TMServer]]
[[Категория:Тихий запуск]]

TMServer

2013-10-03T07:05:18Z

AnnaNikolskih:

'''{{PAGENAME}}''' — [[Утилиты Такси-Мастер|утилита]] [[{{ТМ}}]], позволяющая снизить нагрузку на сервер [[Firebird]] и [[База данных {{ТМ}}|базу данных Такси-Мастер]], таким образом повысить производительность системы Такси-Мастер.
TMServer, в сущности, является дополнительным слоем между [[Клиент {{ТМ}}|клиентской]] и [[Сервер {{ТМ}}|серверной частями Такси-Мастер]].
Из этого следует, что если TMServer используется, то все клиенты Такси-Мастер подключаются именно к этой утилите, а не напрямую к базе данных.
Чтобы указать той или иной клиентской части, что нужно работать с TMServer, необходимо выполнить настройку соответствующим образом.

== Внешний вид TMServer ==
Внешне утилита TMServer выглядит так:

{{картинка|TMServer.png}}

В верхней части находится индикатор статуса и кнопка {{button|Настройки}}, открывающая отдельное окно параметров утилиты.
Ниже следует область журналирования, еще ниже отображается статистика по отправленным и полученным данным.

== Запуск и настройка TMServer ==
Первое, что нужно сделать, — запустить TMServer.
В главном окне утилиты нажмите кнопку {{button|Настройки}}, чтобы открыть окно настроек:

{{картинка|Настройки_TMServer.png}}

Необходимо ввести [[Путь к базе данных|настройки подключения к базе данных]].
Логин и пароль для подключения к базе данных заданы по умолчанию, их изменение в большинстве случаев не требуется.
Порты, которые утилита будет прослушивать, также заданы по умолчанию (30000, 29999, 29998).

В настройках включите выполнение автоматических действий, чтобы перенести функцию выполнения автоматических действий над данными с рабочего места Такси-Мастер на TMServer.

== Нужно ли подключать ''все'' рабочие места? ==
К TMServer настоятельно рекомендуется подключать ''все'' рабочие места Такси-Мастер.

== Тихий запуск ==
Утилита TMServer имеет возможность «тихого» запуска — исключается необходимость вручную стартовать работу утилиты после ее открытия.
Тихий запуск включается с помощью ключа <code>-s</code>, то есть из командной строки необходимо запустить:

<pre>
"C:\Program Files\TMEnterprise\Utilities\TMServer.exe" -s
</pre>

Вы можете создать ярлык, в строку запуска которого добавить строку, указанную выше, после чего данный ярлык будет запускать утилиту в «тихом» режиме.

{{утилиты}}

[[Категория:ТМ2]]
[[Категория:AUO]]
[[Категория:Настройка]]
[[Категория:Клиентская часть]]
[[Категория:База данных]]
[[Категория:Утилиты]]
[[Категория:TMServer]]
[[Категория:Тихий запуск]]

TMServer

2013-10-03T07:03:58Z

AnnaNikolskih:

'''{{PAGENAME}}''' — [[Утилиты Такси-Мастер|утилита]] [[{{ТМ}}]], позволяющая снизить нагрузку на сервер [[Firebird]] и [[База данных {{ТМ}}|базу данных Такси-Мастер]], таким образом повысить производительность системы Такси-Мастер.
TMServer, в сущности, является дополнительным слоем между [[Клиент {{ТМ}}|клиентской]] и [[Сервер {{ТМ}}|серверной частями Такси-Мастер]].
Из этого следует, что если TMServer используется, то все клиенты Такси-Мастер подключаются именно к этой утилите, а не напрямую к базе данных.
Чтобы указать той или иной клиентской части, что нужно работать с TMServer, необходимо [[#Настройка клиентских рабочих мест|выполнить настройку соответствующим образом]].

== Внешний вид TMServer ==
Внешне утилита TMServer выглядит так:

{{картинка|TMServer.png}}

В верхней части находится индикатор статуса и кнопка {{button|Настройки}}, открывающая отдельное окно параметров утилиты.
Ниже следует область журналирования, еще ниже отображается статистика по отправленным и полученным данным.

== Запуск и настройка TMServer ==
Первое, что нужно сделать, — запустить TMServer.
В главном окне утилиты нажмите кнопку {{button|Настройки}}, чтобы открыть окно настроек:

{{картинка|Настройки_TMServer.png}}

Необходимо ввести [[Путь к базе данных|настройки подключения к базе данных]].
Логин и пароль для подключения к базе данных заданы по умолчанию, их изменение в большинстве случаев не требуется.
Порты, которые утилита будет прослушивать, также заданы по умолчанию (30000, 29999, 29998).

В настройках включите выполнение автоматических действий, чтобы перенести функцию выполнения автоматических действий над данными с рабочего места Такси-Мастер на TMServer.

== Нужно ли подключать ''все'' рабочие места? ==
К TMServer настоятельно рекомендуется подключать ''все'' рабочие места Такси-Мастер.

== Тихий запуск ==
Утилита TMServer имеет возможность «тихого» запуска — исключается необходимость вручную стартовать работу утилиты после ее открытия.
Тихий запуск включается с помощью ключа <code>-s</code>, то есть из командной строки необходимо запустить:

<pre>
"C:\Program Files\TMEnterprise\Utilities\TMServer.exe" -s
</pre>

Вы можете создать ярлык, в строку запуска которого добавить строку, указанную выше, после чего данный ярлык будет запускать утилиту в «тихом» режиме.

{{утилиты}}

[[Категория:ТМ2]]
[[Категория:AUO]]
[[Категория:Настройка]]
[[Категория:Клиентская часть]]
[[Категория:База данных]]
[[Категория:Утилиты]]
[[Категория:TMServer]]
[[Категория:Тихий запуск]]

TMServer

2013-10-03T07:02:30Z

AnnaNikolskih:

'''{{PAGENAME}}''' — [[Утилиты Такси-Мастер|утилита]] [[{{ТМ}}]], позволяющая снизить нагрузку на сервер [[Firebird]] и [[База данных {{ТМ}}|базу данных Такси-Мастер]], таким образом повысить производительность системы Такси-Мастер.
TMServer, в сущности, является дополнительным слоем между [[Клиент {{ТМ}}|клиентской]] и [[Сервер {{ТМ}}|серверной частями Такси-Мастер]].
Из этого следует, что если TMServer используется, то все клиенты Такси-Мастер подключаются именно к этой утилите, а не напрямую к базе данных.
Чтобы указать той или иной клиентской части, что нужно работать с TMServer, необходимо [[#Настройка клиентских рабочих мест]] выполнить настройку соответствующим образом.

== Внешний вид TMServer ==
Внешне утилита TMServer выглядит так:

{{картинка|TMServer.png}}

В верхней части находится индикатор статуса и кнопка {{button|Настройки}}, открывающая отдельное окно параметров утилиты.
Ниже следует область журналирования, еще ниже отображается статистика по отправленным и полученным данным.

== Запуск и настройка TMServer ==
Первое, что нужно сделать, — запустить TMServer.
В главном окне утилиты нажмите кнопку {{button|Настройки}}, чтобы открыть окно настроек:

{{картинка|Настройки_TMServer.png}}

Необходимо ввести [[Путь к базе данных|настройки подключения к базе данных]].
Логин и пароль для подключения к базе данных заданы по умолчанию, их изменение в большинстве случаев не требуется.
Порты, которые утилита будет прослушивать, также заданы по умолчанию (30000, 29999, 29998).

В настройках включите выполнение автоматических действий, чтобы перенести функцию выполнения автоматических действий над данными с рабочего места Такси-Мастер на TMServer.

== Нужно ли подключать ''все'' рабочие места? ==
К TMServer настоятельно рекомендуется подключать ''все'' рабочие места Такси-Мастер.

== Тихий запуск ==
Утилита TMServer имеет возможность «тихого» запуска — исключается необходимость вручную стартовать работу утилиты после ее открытия.
Тихий запуск включается с помощью ключа <code>-s</code>, то есть из командной строки необходимо запустить:

<pre>
"C:\Program Files\TMEnterprise\Utilities\TMServer.exe" -s
</pre>

Вы можете создать ярлык, в строку запуска которого добавить строку, указанную выше, после чего данный ярлык будет запускать утилиту в «тихом» режиме.

{{утилиты}}

[[Категория:ТМ2]]
[[Категория:AUO]]
[[Категория:Настройка]]
[[Категория:Клиентская часть]]
[[Категория:База данных]]
[[Категория:Утилиты]]
[[Категория:TMServer]]
[[Категория:Тихий запуск]]

Вход в Такси-Мастер

2013-10-02T13:45:49Z

AnnaNikolskih: /* Настройки входа в {{ТМ}} */

Файл:Настройки TMServer.png

2013-10-02T13:05:26Z

AnnaNikolskih: AnnaNikolskih загружена новая версия «Файл:Настройки TMServer.png»: Настройки_TMServer

Файл:Настройки TMServer.png

2013-10-02T13:04:08Z

AnnaNikolskih: AnnaNikolskih загружена новая версия «Файл:Настройки TMServer.png»: Настройки_TMServer

Вход в Такси-Мастер

2013-10-02T12:45:30Z

AnnaNikolskih:

Файл:Настройки входа в ТМ.png

2013-10-02T12:29:00Z

AnnaNikolskih: AnnaNikolskih загружена новая версия «Файл:Настройки входа в ТМ.png»: Настройки_входа_в_ТМ

Файл:Настройки входа в ТМ.png

2013-10-02T12:28:40Z

AnnaNikolskih: AnnaNikolskih загружена новая версия «Файл:Настройки входа в ТМ.png»: Настройки_входа_в_ТМ

TM API

2013-10-02T10:43:33Z

AnnaNikolskih: /* Описание запросов */

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

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

# Создать механизм приема заказов через интернет.
# Сделать ваш сайт более информативным: публиковать полезную для клиентов информацию прямо из системы - список ближайших [[Справочник «Экипажи»|экипажей]], предварительный расчет стоимости поездки, мониторинг движения автомобиля такси в процессе выполнения [[заказ]]а, [[Модуль «Интеграция с картами»|карты города]] и контактную информацию.
# Расширить возможности своей службы за счет популярного онлайн-сервиса Яндекс Такси.

== Параметры TM API ==
Задать настройки для корректной работы TM API вы сможете в программе [[Такси-Мастер]] в меню {{tab|Настройки}} в одноименной ветке {{tab|TM API}}.
Параметры организуют и контролируют работу [[Модуль «Интернет-заказы»|модуля «Интернет-заказы»]].
# Установите флажок {{checkbox|Использовать TM API}}, чтобы приступить к его использованию.
# В поле {{поле|Локальный порт}} введите номер порта подключения к интернету, на котором работает и будет ожидать запросы о новых заказах [[TMServer]]. Рекомендуется оставить номер порта по умолчанию.
# Установите флажок {{checkbox|Можно использовать данное рабочее место TMServer для распознавания адресов}} для того, чтобы конкретно с данного рабочего места происходило распознавание адресов модулем "Интернет-заказы".
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

=== Ветка «Открытое API» ===
В данной ветке регулируется доступ к синхронизации Такси-Мастер со сторонним сервисом (сайтом), с помощью которого клиенты будут создавать интернет-заказы. С примером кода для работы вы можете ознакомиться в данной статье в разделе [[TM API#Общее описание протокола|Общее описание протокола]].
# Установите флажок {{checkbox|Использовать открытое API}} для того, чтобы запустить работу по обслуживанию модуля «Интернет-заказы». При установленном флажке сервер [[Модуль «Интернет-заказы»|модуля «Интернет-заказы»]] запускается и ожидает запросы о новых заказах.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы с модулем «Интернет-заказы», который будет выслан вам в письме от менеджера.
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

=== Ветка «API для телефонии» ===
В данной ветке регулируются настройки API для телефонии, т.е. взаимодействие [[Такси-Мастер]] с call-центром через программный интерфейс. С его помощью [[Call-центр Oktell|call-центр]] может дать команду Такси-Мастер создать [[зака]]з или запросить информацию о [[Справочник «Состояния заказа»|статусе текущего заказа]].
# Установите флажок {{checkbox|Использовать открытое API для телефонии}} для того, чтобы запустить работу по обслуживанию телефонии через API.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы.
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

=== Ветка «Платежные терминалы» ===
{{info|Ранее для связи [[Модуль интеграции с платежными системами|платежных систем]] и [[Такси-Мастер]] служила такая утилита, как TMWeb. В данный момент мы отказались от ее использования, а функции были распределены между двумя компонентами системы: TM API и [[TMServer]].}}

Параметры этой ветки отвечают за работу [[Модуль интеграции с платежными терминалами|модуля интеграции с платежными системами]].
# Установите флажок {{checkbox|Включить прием терминальных платежей}}. Данная функция позволит отображать все платежные операции по приходу средств от водителей через терминалы в [[База данных Такси-Мастер 2|базе данных]] программы.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы с платежными системами и сверки платежей, который будет выслан вам в письме от менеджера. Секретный ключ - это определенный набор символов, необходимый для формирования подписи при передаче информации о платеже.
# В полях {{поле|Логин}} и {{поле|Пароль}} введите данные учетной записи на сайте http://term.bitmaster.ru.
# Кнопка {{кнопка|Задать всем водителям терминальный аккаунт по их ИД}} служит для соединения TM API с сервером Такси-Мастер. В результате соединения записи о терминальных аккаунтах генерируются, заносятся (для тех водителей, у которых они отсутствуют) и обновляются (для тех водителей, у которых уже существуют терминальные аккаунты) в Такси-Мастер.
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

{{info|Обратите внимание, что для платежных систем также существует открытый и свободно распространяемый API, с помощью которого есть возможность связать [[Такси-Мастер]] и [[Модуль интеграции с платежными системами|платежные системы]]. Обратитесь в отдел дополнительных услуг, написав на {{ящик ОДУ}}, за получением кода для данного компонента системы.}}

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

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

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

<pre>
GET https://ip:port/common_api/1.0/get_crew_groups_list HTTP/1.1
</pre>

Для получения данных из БД используются запросы типа GET. Для записи данных в [[База данных Такси-Мастер|базу данных]] используются запросы типа POST. В запросе типа GET параметры запроса передаются в URI. Пример:
<pre>
GET https://ip:port/common_api/1.0/calc_order_cost?tariff_id=1&distance_city=10 HTTP/1.1
Signature: <...>
</pre>

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

<pre>
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
</pre>

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

<pre>
Запрос:
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
</pre>

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

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

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

Существуют общие для всех запросов коды результатов:
{|
! Код
! Описание
|-
|0
|Успешное выполнение запроса
|-
|1
|Неизвестная ошибка
|-
|2
|Неизвестный тип API
|-
|3
|API отключено в настройках TMWeb
|-
|4
|Не совпадает секретный ключ
|-
|5
|Неподдерживаемая версия API
|-
|6
|Неизвестное название запроса
|-
|7
|Неверный тип запроса GET/POST
|-
|8
|Не хватает входного параметра (в доп. информации ответа будет название отсутствующего параметра)
|-
|9
|Некорректный входной параметр (в доп. информации ответа будет название некорректного параметра)
|-
|10
|Внутренняя ошибка обработки запроса
|}

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

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

Метод: GET или POST

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

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

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

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

Пример:

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

=== Запрос списка групп экипажей ===
Метод: GET

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

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

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

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crew_groups
|Массив
|Список групп экипажей
|-
|• id
|Целое
|ИД группы экипажей
|-
|• name
|Строка
|Название группы экипажей
|}

Пример:

<pre>
Запрос:

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

Ответ:

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

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

Метод: GET

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

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

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

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

{|
!Параметр
!Тип
!Описание
|-
|uds
|Массив
|Список служб [[Модуль «Единая диспетчерская служба»|ЕДС]]
|-
|• id
|Целое
|ИД службы [[Модуль «Единая диспетчерская служба»|ЕДС]]
|-
|• name
|Строка
|Название службы [[Модуль «Единая диспетчерская служба»|ЕДС]]
|}

Пример:

<pre>
Запрос:

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

Ответ:

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

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

Метод: GET

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

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

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

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

{|
!Параметр
!Тип
!Описание
|-
|tariffs
|Массив
|Список [[Справочник «Тарифы»|тарифов]]
|-
|• id
|Целое
|ИД [[Справочник «Тарифы»|тарифа]]
|-
|• name
|Строка
|Название [[Справочник «Тарифы»|тарифа]]
|-
|• is_active
|true или false
|Активный [[Справочник «Тарифы»|тариф]]
|}

Пример:

<pre>
Запрос:

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

Ответ:

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

=== Запрос списка услуг ===
Метод: GET

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

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

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

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

{|
!Параметр
!Тип
!Описание
|-
|services
|Массив
|Список [[Справочник «Услуги»|услуг]]
|-
|• id
|Целое
|ИД [[Справочник «Услуги»|услуги]]
|-
|• name
|Строка
|Название [[Справочник «Услуги»|услуги]]
|-
|• sum
|Дробное
|Абсолютная сумма [[Справочник «Услуги»|услуги]], руб
|-
|• percent
|Дробное
|Процент [[Справочник «Услуги»|услуги]] от стоимости заказа, %
|}

Пример:

<pre>
Запрос:

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

Ответ:

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

=== Запрос списка скидок ===
Метод: GET

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

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

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

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

{|
!Параметр
!Тип
!Описание
|-
|discounts
|Массив
|Список [[Справочник «Скидки клиентов»|скидок]]
|-
|• id
|Целое
|ИД [[Справочник «Скидки клиентов»|скидки]]
|-
|• name
|Строка
|Название [[Справочник «Скидки клиентов»|скидки]]
|-
|• sum
|Дробное
|Абсолютная сумма [[Справочник «Скидки клиентов»|скидки]], руб
|-
|• percent
|Дробное
|Процент [[Справочник «Скидки клиентов»|скидки]] от стоимости заказа, %
|}

Пример:

<pre>
Запрос:

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

Ответ:

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

=== Создание нового заказа ===
Метод: POST

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

Параметры:

{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|phone
|Строка, <= 16 символов
|Номер телефона
|-
|source
|Строка
|Адрес подачи
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
!colspan="3"|Необязательные параметры
|-
|dest
|Строка
|Адрес назначения
|-
|customer
|Строка
|Заказчик
|-
|comment
|Строка
|Комментарий
|-
|crew_group_id
|Целое
|ИД группы экипажей
|-
|uds_id
|Целое
|ИД службы ЕДС
|-
|tariff_id
|Целое
|ИД тарифа
|-
|is_prior
|true или false
|Предварительный заказ
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Заказ с такими параметрами уже создан
|-
|101
|Тариф не найден
|-
|102
|Группа экипажа не найдена
|-
|103
|Служба ЕДС не найдена
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|order_id
|Целое
|ИД созданного заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_order HTTP/1.1
Signature: <...>
Content-Type: application/x-www-form-urlencoded
Content-Length: 127
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

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"order_id":12345
}
}
</pre>

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

Метод: GET

Название запроса: calc_order_cost
{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|tariff_id
|Целое
|ИД тарифа
|-
Параметры:

!colspan="3"|Необязательные параметры
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|is_prior
|true или false
|Предварительный заказ
|-
|client_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»
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Тариф не найден
|-
|101
|Ошибка при расчете по тарифу
|-
|102
|Скидка не найдена
|-
|103
|Клиент не найден
|-
|104
|Район подачи не найден
|-
|105
|Район назначения не найден
|-
|106
|Дисконтная карта не найдена
|}

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

Пример:

<pre>
Запрос:

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

Ответ:

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

=== Запрос информации об экипаже ===
Метод: GET

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

Параметры:
{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|crew_id
|Целое
|ИД экипажа
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Экипаж не найден
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crew_id
|Целое
|ИД экипажа
|-
|code
|Строка
|Позывной экипажа
|-
|name
|Строка
|Наименование экипажа
|-
|driver_id
|Целое
|ИД водителя
|-
|car_id
|Целое
|ИД автомобиля
|-
|crew_group_id
|Целое
|ИД группы экипажа
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_crew_info?crew_id=1 HTTP/1.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
}
}
</pre>

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

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

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|driver_id
|Целое
|ИД водителя
|-
!colspan="3"|Необязательные параметры
|-
|need_photo
|true или false
|Нужна ли фотография водителя
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Водитель не найден
|}

Возвращаемые параметры в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|driver_id
|Целое
|ИД водителя
|-
|name
|Строка
|ФИО водителя
|-
|birthday
|ДД.ММ.ГГГГ
|День рождения водителя
|-
|car_id
|Целое
|ИД основного автомобиля водителя
|-
|license
|Строка
|Удостоверение водителя
|-
|home_phone
|Строка
|Домашний телефон водителя
|-
|mobile_phone
|Строка
|Мобильный телефон водителя
|-
|is_locked
|true или false
|Водитель заблокирован
|-
|is_dismissed
|true или false
|Водитель уволен
|-
|driver_photo
|Base64
|Фото водителя (только если need_photo = true)
|}

Пример:

<pre>
Запрос:

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",
"birthday":"01.01.1980",
"car_id":1,
"license":"1234567890",
"home_phone":"123456",
"mobile_phone":"+79123456789",
"is_locked":false,
"is_dismissed":false
}
}
</pre>

=== Запрос информации об автомобиле ===
Метод: GET

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

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|car_id
|Целое
|ИД автомобиля
|-
!colspan="3"|Необязательные параметры
|-
|need_photo
|true или false
|Нужна ли фотография автомобиля
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Автомобиль не найден
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|car_id
|Целое
|ИД автомобиля
|-
|name
|Строка
|Наименование автомобиля
|-
|code
|Строка
|Позывной автомобиля
|-
|gos_number
|Строка
|Государственный номер автомобиля
|-
|color
|Строка
|Цвет автомобиля
|-
|mark
|Строка
|Марка автомобиля
|-
|short_name
|Строка
|Краткое название автомобиля
|-
|production_year
|Целое
|Год выпуска автомобиля
|-
|car_photo
|Base64
|Фото автомобиля (только если need_photo = true)
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_car_info?car_id=1&need_photo=false HTTP/1.1
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
}
}
</pre>

=== Запрос координат экипажей ===
Метод: GET

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

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Необязательные параметры
|-
|crew_id
|Целое
|ИД экипажа, по которому нужно вернуть координаты. Если не задано, то будут возвращены координаты всех экипажей на линии.
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Координаты не найдены
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crews_coords
|Массив
|Список координат экипажей
|-
|• crew_id
|Целое
|ИД экипажа
|-
|• crew_code
|Строка
|Позывной экипажа
|-
|• coords_time
|ГГГГММДДччммсс
|Время получения координат
|-
|• lat
|Дробное
|Долгота
|-
|• lon
|Дробное
|Широта
|-
|• state_kind
|Строка
|Тип состояния экипажа. Может принимать значения:
• "not_available" — экипаж не на линии

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

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

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

Пример:

<pre>

Запрос:
GET https://ip:port/common_api/1.0/get_crews_coords HTTP/1.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"
},
{
"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 HTTP/1.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"
}
]
}
}
</pre>

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

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
! colspan="3"|Обязательные параметры
|-
|get_streets
|true или false
|Искать улицы
|-
|get_houses
|true или false
|Искать пункты
|-
|get_streets
|true или false
|Искать дома. Не может быть равно true, если get_streets = true или get_points = true.
|-
|street
|Строка
|Часть названия улицы или пункта, если идет поиск улиц или пунктов, или полное название улицы, если идет поиск домов
|-
!colspan="3"|Необязательные параметры
|-
|house
|Строка
|Часть номера дома. Нужно только если get_houses = true.
|-
|max_addresses_count
|Целое
|Максимальное количество адресов в ответе
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Подходящие адреса не найдены
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|addresses
|Массив
|Список подходящих адресов
|-
|• street
|Строка
|Название улицы или пункта
|-
|• house
|Строка
|Номер дома
|-
|• kind
|Строка
|Тип адреса. Может принимать значения:
• "street" — улица

• "house" — дом

• "point" — пункт
|-
|• comment
|Строка
|Комментарий
|}

Пример:

<pre>

Запрос:

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

Ответ:

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

Запрос:

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 HTTP/1.1
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":""
}
]
}
}
</pre>

=== Анализ маршрута ===
Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|source
|Строка
|Адрес подачи
|-
|dest
|Строка
|Адрес назначения
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Адрес подачи не распознан
|-
|101
|Адрес назначения не распознан
|-
|102
|Маршрут не распознан
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|source_lat
|Дробное
|Широта адреса подачи
|-
|source_lon
|Дробное
|Долгота адреса подачи
|-
|source_zone_id
|Целое
|ИД района подачи
|-
|dest_lat
|Дробное
|Широта адреса назначения
|-
|dest_lon
|Дробное
|Долгота адреса назначения
|-
|dest_zone_id
|Целое
|ИД района назначения
|-
|city_dist
|Дробное
|Километраж по городу
|-
|country_dist
|Дробное
|Километраж за городом
|-
|source_country_dist
|Дробное
|Километраж до адреса подачи, если адрес подачи за городом
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/analyze_route?source=STREET1,1&dest=STREET2,2 HTTP/1.1
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
}
}
</pre>

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

Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|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
|Целое
|ИД автомобиля
|-
|start_time
|ГГГГММДДччммсс
|Время создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|finish_time
|ГГГГММДДччммсс
|Время завершения заказа
|-
|source
|Строка
|Адрес подачи
|-
|destination
|Строка
|Адрес назначения
|-
|passenger
|Строка
|Пассажир
|-
|phone
|Строка
|Номер телефона
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_order_state?order_id=1 HTTP/1.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
"start_time":"17.01.2013 12:56:41",
"source_time":"17.01.2013 13:26:17",
"finish_time":"17.01.2013 13:03:43",
"source":"1",
"destination":"2",
"passenger":"Слепаков",
"phone":"8800"
}
}
</pre>

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

Метод: POST

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|phone
|Строка, <= 16 символов
|Номер телефона
|-
|message
|Строка
|Текст СМС
|}

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

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

Пример:

<pre>
Запрос:

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

Signature: <...>

message=SMSText&phone=89050057216

Ответ:

{
"code":0,
"descr":"OK",
"data":{}
}
</pre>

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

Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|login
|Строка, <= 60 символов
|Логин
|-
|password
|Строка, <= 60 символов
|Пароль
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент с логином LOGIN и/или неверный пароль
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|client_id
|Целое
|ИД клиента
|}

Пример:

<pre>
Запрос:

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

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"client_id":131
}
}
</pre>

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

Метод: POST

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

Параметры:

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

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

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Клиент с номером телефона=PHONE уже существует
|-
|101
|Клиент с логином=LOGIN уже существует
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|client_id
|Целое
|ИД созданного клиента
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_order HTTP/1.1

Signature: <...>

Content-Type: application/x-www-form-urlencoded

Content-Length: 127

name=NAME&phones=88,99&login=LOGIN&password=PASSWORD&birthday=19930218115517&gender=male&address=ADDRESS

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"client_id":140
}
}
</pre>

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

Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

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

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

• "female" - женский
|-
|birthday
|ДД.ММ.ГГГГ
|Дата рождения
|-
|phones
|Строка
|Номера телефонов (через запятую)
|-
|balance
|Дробное
|Баланс
|-
|login
|Строка
|Логин
|-
|password
|Строка
|Пароль
|}

Пример:

<pre>
Запрос:

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

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"client_id":140,
"name":"Васильев Артём",
"number":"000140",
"address":"Бутово,45",
"gender":"male",
"birthday":"18.02.1993",
"phones":"[\"88\",\"99\"]",
"balance":1467,
"login":"artem",
"password":"vasilev"
}
}
</pre>

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

Метод: POST

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

Параметры:

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

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

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Клиент с номером телефона=PHONE уже существует
|-
|101
|Клиент с логином=LOGIN уже существует

|}

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

Пример:

<pre>
Запрос:

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

client_id=140&name=NAME&phones=88,99&login=LOGIN&password=PASSWORD&birthday=19930218115517&gender=male&address=ADDRESS

Ответ:

{
"code":0,
"descr":"OK",
"data":{}
}
</pre>

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

Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента (может отсутствовать, если phone заполнен)
|-
|phone
|Строка, <= 16 символов
|Телефон клиента (может отсутствовать, если client_id заполнен)
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|id
|Целое
|ИД заказа
|-
|state_id
|Целое
|ИД состояния заказа
|-
|start_time
|ГГГГММДДччммсс
|Дата создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|source
|Строка
|Адрес подачи
|-
|destination
|Строка
|Адрес назначения
|-
|passenger
|Строка
|Пассажир
|-
|crew_id
|Целое
|ИД экипажа
|-
|prior_crew_id
|Целое
|ИД предварительного экипажа
|-
|driver_id
|Целое
|ИД водителя
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_current_orders?client_id=140&phone=18 HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"orders":[
{
"id":20648,
"state_id":44,
"start_time":"20130204181111",
"source_time":"20130204181111",
"source":"1-й пр-т \/Москва\/,",
"destination":"12-й мкр,",
"passenger":"маша",
"crew_id":0,
"prior_crew_id":0,
"driver_id":0
},
{
"id":20670,
"state_id":44,
"start_time":"20130207153022",
"source_time":"20130207153022",
"source":"11-й мкр,",
"destination":"1-й пр-т \/Москва\/,",
"passenger":"саша",
"crew_id":0,
"prior_crew_id":0,
"driver_id":0
}
]
}
}
</pre>

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

Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента (может отсутствовать, если phone заполнен)
|-
|phone
|Строка, <= 16 символов
|Телефон клиента (может отсутствовать, если client_id заполнен)
|-
|start_time
|ГГГГММДДччммсс
|Начало периода
|-
|finish_time
|ГГГГММДДччммсс
|Конец периода
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|id
|Целое
|ИД заказа
|-
|state_id
|Целое
|ИД состояния заказа
|-
|start_time
|ГГГГММДДччммсс
|Время создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|finish_time
|ГГГГММДДччммсс
|Время завершения заказа
|-
|source
|Строка
|Адрес подачи
|-
|destination
|Строка
|Адрес назначения
|-
|passenger
|Строка
|Пассажир
|-
|sum
|Дробное
|Стоимость заказа без учета скидок(наценок)
|-
|crew_id
|Целое
|ИД экипажа
|-
|prior_crew_id
|Целое
|ИД предварительного экипажа
|-
|driver_id
|Целое
|ИД водителя
|-
|car_id
|Целое
|ИД автомобиля
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_finished_orders?client_id=140&phone= HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"orders":[
{
"id":20651,
"state_id":34,
"source_time":"20130205110812",
"start_time":"20130205110812",
"finish_time":"20130205115618",
"source":"прпроп",
"destination":"рррррр",
"passenger":"вера",
"sum":"908",
"crew_id":"6",
"prior_crew_id":0,
"driver_id":"4",
"car_id":"6"
},
{
"id":20669,
"state_id":34,
"source_time":"20130205130500",
"start_time":"20130205130500",
"finish_time":"20130205134511",
"source":"1",
"destination":"2",
"passenger":"маша",
"sum":"454",
"crew_id":"6",
"prior_crew_id":0,
"driver_id":"4",
"car_id":"6"
}
]
}
}
</pre>

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

Метод: POST

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента
|-
|oper_time
|ГГГГММДДччммсс
|Время создания операции
|-
|sum
|Дробное
|Сумма
|-
|oper_type
|Целое
|Тип операции:
• "receipt" - приход

• "expense" - расход
|-
|pay_type
|Целое
|Тип оплаты:
• "cash" - наличный

• "nocash" - безналичный
|-
!colspan="3"|Необязательные параметры
|-
|comment
|Строка
|Комментарий
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|oper_id
|Целое
|ИД операции
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_client_operation HTTP/1.1

Signature: <...>

Content-Type: application/x-www-form-urlencoded

Content-Length: 127

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

Ответ:

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

}
}
</pre>

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

Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента (может отсутствовать, если phone заполнен)
|-
|phone
|Целое
|Телефон клиента (может отсутствовать, если client_id заполнен)
|-
|start_time
|ГГГГММДДччммсс
|Начало периода
|-
|finish_time
|ГГГГММДДччммсс
|Конец периода
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|oper_id
|Целое
|ИД операции
|-
|oper_time
|ГГГГММДДччммсс
|Время создания операции
|-
|sum
|Дробное
|Сумма
|-
|order_id
|Целое
|Заказ, связанный с операцией
|-
|oper_type
|Целое
|Тип операции:
• "receipt" - приход
• "expense" - расход
|-
|pay_type
|Целое
|Тип оплаты:
• "cash" - наличный
• "nocash" - безналичный
|}

Пример:

<pre>
Запрос:

GET

https://ip:port/common_api/1.0/get_client_operations?client_id=112&start_time=20130201092112&finish_time=20130221092112 HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"operations":[
{
"oper_id":112,
"oper_time":"20130219091328",
"sum":"21,8",
"order_id":11800,
"oper_type":"receipt",
"pay_type":"cash",
"comment":"jgznm"
},
{
"oper_id":112,
"oper_time":"20130220112245",
"sum":"4500",
"order_id":11801,
"oper_type":"receipt",
"pay_type":"cash",
"comment":"блин"
}
]
}
}
</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 HTTP/1.1
</pre>

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

Пример:

<pre>
GET https://ip:port/tm_tapi/1.0/get_info_by_phone?phone=89058800565&fields=PHONE_TYPEPHONE_
TO_DIAL&signature=661ce071eeefcb4f7fc8bc1f17bd520b HTTP/1.1
</pre>

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

Пример:

<pre>
POST https://ip:port/tm_tapi/1.0/change_order_state HTTP/1.1
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 HTTP/1.1

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

Signature = MD5("phone=89058800565&fields=PHONE_TYPE" + "321") = ef17ea682d09e452af544a5758dba396
HTTP/1.1
</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 - если звонит номер из справочника телефоны; 0 - неизвестный номер)
|-
|PHONE_TO_DIAL
|Строка, <= 16 символов
|Номер телефона для отзвона по заказу
|-
|CREW_ID
|Целое
|ИД экипажа
|-
|IS_PRIOR
|true или false
|Признак предварительного заказа
|-
|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
|Целое
|ИД группы экипажа
|-
|CLIENT_BALANCE
|Дробное
|Баланс клиента
|-
|DRIVER_TIMECOUNT
|Целое
|Время пути водителя до адреса подачи в минутах
|-
|SOURCE_TIMECOUNT
|Целое
|Время оставшееся до подачи в минутах
|-
|SOUND_COLOR
|Строка
|Запись с информацией о цвете
|-
|SOUND_GOSNUMBER
|Строка
|Запись с информацией о государственном номере автомобиля
|-
|SOUND_MARK
|Строка
|Запись с информацией о марке автомобиля
|-
|GOSNUMBER
|Строка
|Государственный номер автомобиля
|-
|CAR_COLOR
|Строка
|Цвет автомобиля
|-
|CAR_MARK
|Строка
|Марка автомобиля
|-
|ORDER_COORDS
|Строка
|Координаты места подачи
|-
|CREW_COORDS
|Строка
|Координаты назначенного экипажа
|}

Пример:

<pre>
Запрос:
GET https://ip:port/tm_tapi/1.0/get_info_by_phone?phone=89058800565l&fields=PHONE_TYPEPHONE_
TO_DIAL-CREW_ID-ORDER_ID&signature=d35ab2765f2968d48c096d5f5327db26 HTTP/1.1

Ответ:

<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>
</data>
</response>
</pre>

==== Запрос информации по ИД заказа ====

Метод: GET
Название запроса: get_info_by_order_id
Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|-
|fields
|Строка
|Список полей, которые необходимо вернуть. Поля перечисляются через ''-''
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

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

{|
!Параметр
!Тип
!Описание
|-
|DRIVER_TIMECOUNT
|Строка, <= 16 символов
|Время до подачи в минутах, указанное водителем
|-
|SOUND_COLOR
|Строка
|Запись с информацией о цвете
|-
|CAR_MARK
|Строка
|Марка автомобиля
|-
|CAR_COLOR
|Строка
|Цвет автомобиля
|-
|GOSNUMBER
|Строка
|Государственный номер автомобиля
|-
|SOUND_MARK
|Строка
|Запись с информацией о марке автомобиля
|-
|CREW_GROUP_ID
|Целое
|ИД группы экипажа
|-
|IS_PRIOR
|true или false
|Признак предварительного заказа
|-
|DISCOUNTEDSUMM
|Строка
|Сумма заказа с учетом всех скидок
|-
|DRIVER_PHONE
|Строка, <= 16 символов
|Номер телефона водителя
|-
|CATEGORYID
|Целое
|ИД категории телефона
|-
|SOURCE_TIMECOUNT
|Целое
|Время до подачи в минутах
|-
|ORDER_COORDS
|Строка
|Координаты места подачи
|-
|CREW_COORDS
|Строка
|Координаты назначенного экипажа
|-
|ORDER_STATE
|Целое
|ИД состояния заказа
|}

Пример:

<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
HTTP/1.1

Ответ:

<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></SOURCE_TIME>
</data>
</response>
</pre>

==== Смена состояния заказа ====
Метод: POST

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

Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|-
|need_state
|Целое
|Новое состояние заказа
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

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

{|
!Код
!Описание
|-
|100
|Заказ с таким ИД не найден.
|-
|101
|Изменение состояния не соответствует необходимым условиям.
|}

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

{|
!Параметр
!Тип
!Описание
|-
|ORDER_ID
|Целое
|ИД созданного заказа
|-
|NEW_STATE
|Целое
|Новое состояние заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/tm_tapi/1.0/change_order_state HTTP/1.1
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"|Обязательные параметры
|-
|RECORD_DATE
|ГГГГММДДччммсс
|Дата записи
|-
|RECORD_LENGTH
|Целое
|Продолжительность записи (в секундах)
|-
|PHONE
|Строка, <= 16 символов
|Номер телефона
|-
|FILE_PATH
|Строка,<=255 символов
|Путь к файлу записи
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Заказ по такому номеру телефона не найден.
|}

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

{|
!Параметр
!Тип
!Описание
|-
|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: 171
RECORD_DATE=20130122180949&RECORD_LENGTH=215&PHONE=8987564&FILE_PATH=d%3A%5Ctemp%5CTM%5Ctrunk
%5CSource%5CDevUtils%5CTMAPITest%5C&signature=56851c4e8d2d4bb9ba615615f76ad7f7

Ответ:
<response>
<code>0</code>
<descr>OK</descr>
<data>
<RECORD_ID>25</RECORD_ID>
</data>
</response>
</pre>

==== Создать новый заказ ====

Метод: POST

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

Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|PHONE
|Строка, <= 16 символов
|Номер телефона
|-
|ORDER_STATE_ID
|Целое
|ИД состояния заказа
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|-
|colspan="3"|Необязательные параметры
|-
|CREWGROUPID
|Целое
|ИД группы экипажа
|-
|TARIF_ID
|Целое
|ИД тарифа
|-
|DISCOUNTEDSUMM
|Дробное
|Фиксированная сумма за заказ
|-
|NAME
|Строка, <=80 символов
|Наименование (заказчик + адрес назначения)
|-
|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
|Дробное
|Бонусные баллы, начисленные водителю за заказ
|-
|STARTSMEN
|Целое
|Смена пользователей, в которой был создан заказ
|-
|FINISHSMEN
|Целое
|Смена пользователей, в которой заказ был завершен
|-
|DISTANCE
|Дробное
|Километраж по городу (в километрах)
|-
|HOURLY_LEN
|Целое
|Длительность исполнения почасового заказа (в минутах)
|-
|HOURLY_START
|ГГГГММДДччммсс
|Дата начала отсчета при почасовом заказе
|-
|HOURLY_PAY
|0 или 1 (false или true)
|Признак почасового заказа
|-
|PHONE_TO_DIAL
|Строка, <=16 символов
|Номер телефона для отзвона по заказу
|-
|STOPS
|Строка, <=80 символов
|Остановки
|-
|STOPS_COUNT
|Целое
|Количество остановок
|-
|SERVICEID
|Целое
|ИД услуги
|-
|STATE_TIME
|ГГГГММДДччммсс
|Дата смены состояния
|-
|IS_LOCKED
|0 или 1 (false или true)
|Признак блокировки заказа от редактирования
|-
|TIME_LOCKED
|ГГГГММДДччммсс
|Дата блокировки заказа
|-
|LOCKED_BY
|Целое
|Пользователь, заблокировавший заказ
|-
|FROMBORDER
|0 или 1 (false или true)
|Признак заказа "с бордюра"
|-
|DRIVERID
|Целое
|ИД водителя
|-
|CLIENT_NOTIFIED
|0 или 1 (false или true)
|Признак успешного отзвона клиенту колцентром
|-
|PREFERENTIAL
|0 или 1 (false или true)
|Признак льготного заказа
|-
|LAST_CREW
|Целое
|ИД предыдущего экипажа
|-
|FSUMM
|Дробное
|Часть стоимости заказа, которая оплачена наличными
|-
|OLDCREW
|Целое
|Предыдущий экипаж
|-
|TIMEOUT
|ГГГГММДДччммсс
|Период времени, прошедший с момента последней смены состояния
|-
|WAITING_START
|ГГГГММДДччммсс
|Дата начала ожидания заказчика водителем
|-
|WAITING_LENGTH
|Целое
|Общая длина периода ожидания заказчика водителем (в минутах)
|-
|BACKFREE
|Целое
|Признак применения скидки в 50% на обратный путь
|-
|INPUTTIME
|ГГГГММДДччммсс
|Дата принятия заказа [от даты создания заказа отличается тем, что может быть задана пользователем]
|-
|MONEY_RECEIVE
|0 или 1 (false или true)
|Подтверждение принятия денег наличными
|-
|NOTIFY_BEFORE
|Целое
|Период времени, за который пользователь оповещается о наступлении даты подачи
|-
|WANTCREWID
|Целое
|ИД желаемого экипажа
|-
|DRIVER_SOURCETIME
|ГГГГММДДччммсс
|Дата подачи, указанная водителем с мобильного устройства
|-
|DRIVE_TIME
|Целое
|Приблизительное время доезда до адреса подачи, указываемое водителем через мобильное устройство
|-
|DISTANCE_COUNTRY
|Дробное
|Километраж за границами города (в километрах)
|-
|STOPS_LEN
|Целое
|Общая продолжительность остановок в минутах
|-
|DISTANCE_CHECK
|0 или 1 (false или true)
|Разрешение ручного ввода километража
|-
|CLIENTID
|Целое
|ИД постоянного клиента
|-
|INFRA_STATE
|Целое
|Состояние заявки в исходящей кампании колцентра INFRA (1 - заявка передана в исходящую кампанию, 2 - отзвон успешно произведен, 3 - занято, 4 - не берут трубку)
|-
|INFRA_ORDER
|Целое
|INFRA-заказ [спец. поле для работы с колцентром компании Инфрател]
|}

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

{|
!Код
!Описание
|-
|100
|Клиент не найден
|}

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

{|
!Параметр
!Тип
!Описание
|-
|ORDER_ID
|Целое
|ИД созданного заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/tm_tapi/1.0/make_new_order HTTP/1.1
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>
</pre>

==== Поиск улицы в базе и создание нового заказа. ====
Метод: POST

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

Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|PHONE
|Строка, <= 16 символов
|Номер телефона
|-
|CALL_ID
|Целое
|ИД звонка
|-
|VOICE_STREET
|Строка, <= 60 символов
|Название улицы или пункта полученное через преобразование голоса в текст
|-
|FIND_STREET
|0 или 1 (false или true)
|Признак того, что улица найдена.
|-
|API_FIND_STREET
|Строка, <= 60 символов
|Наименование улицы или пункта найденное в базе данных.
|-
|NUM_HOUSE
|Строка,<=10 символов
|Номер дома
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

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

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

1) Если FIND_SREET = 0, тогда

{|
!Параметр
!Тип
!Описание
|-
|CALL_ID
|Целое
|ИД звонка
|-
|PHONE
|Строка, <= 16 символов
|Номер телефона
|-
|FIND_STREET
|0 или 1 (false или true)
|Признак того, что улица найдена
|-
|API_FIND_STREET
|Строка, <= 60 символов
|Наименование улицы или пункта найденное в базе данных
|}

2) Если FIND_SREET = 1, тогда

{|
!Параметр
!Тип
!Описание
|-
|ORDER_ID
|Целое
|ИД созданного заказа
|}

Пример:

1) FIND_STREET = 0

<pre>
Запрос:
POST https://ip:port/tm_tapi/1.0/new_order_by_voice HTTP/1.1
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>
</pre>

1) FIND_STREET = 1

<pre>
Запрос:
POST https://ip:port/tm_tapi/1.0/new_order_by_voice HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Content-Length: 244
PHONE=89058770593&CALL_ID=56&VOICE_STREET=пушкинск&FIND_STREET=1&API_FIND_STREET=Пушкинская&NUM_HOUSE=155&signature=6dd9edcb8284bf36f9856dd2018f42e5

Ответ:

<response>
<code>0</code>
<descr>OK</descr>
<data>
<order_id>114</order_id>
</data>
</response>
</pre>

== Пример формы для заказа такси ==
{{url|{{корень FTP|forms/zakaz_taxi.zip}}}}

Данная форма является примером, на основе которого можно построить собственную форму для принятия интернет-заказов. Форму можно использовать либо в исходном варианте, либо применяя запросы [[TM API#Описание запросов|TM API]].
Для того, чтобы данная форма функционировала, необходимо открыть файл в любом текстовом редакторе и указать корректные IP-адрес [[Сервер Такси-Мастер|сервера Такси-Мастер]], порт [[TM API#Параметры TM API|TM API]] и секретный ключ. Далее вам следует загрузить файл на хостинг.

Именно так будет выглядеть данная форма для заказа такси.
{{картинка|Форма для заказа такси.jpg}}

[[Категория:ТМ2]]

TMDriver старый (OLD) для Android

2013-10-02T09:01:28Z

AnnaNikolskih:

{{url|{{корень FTP|android/TMDriver_2_3_8.apk}}}}

{{info|Обратите внимание, что версия Android должна быть 2.1. или выше для корректной работы TMDriver. }}

'''{{PAGENAME}}''' — это версия [[TMDriver]] для мобильных устройств под управлением Android.

{{youtube|http://youtu.be/8LmiQgwPTcI|заголовок=Инструкция для водителей по работе с TMDriver для Android}}

== Рекомендованные модели мобильных устройств ==
Для работы TMDriver на устройстве под управлением Android подходят практически все телефоны с данной ОС, за исключением
брендированных телефонов Билайн и МТС на базе Android (например, Билайн E300 или МТС 916).

== Работа TMDriver для Android ==

В процессе работы с приложением TMDriver для Android водитель выполняет действия на какой-либо форме. TMDriver для Android содержит набор форм, с которыми работает водитель, каждая форма — то, что видит водитель; набор элементов управления. Каждая форма предоставляет особые инструменты для работы, представляющие из себя кнопки, поля ввода, флажки и другие объекты.

Начните работу приложения TMDriver для Android с запуска программы. Нажмите на иконку TMDriver в меню вашего мобильного устройства. После этого программа откроется, и у вас появится ее рабочая область, в которой будет отображаться состояние водителя. Если водитель не работает, то у вас появится следующее окно:

{{картинка|Водитель не на смене.png}}

=== Как задать взаимосвязь TMDriver для Android и Такси-Мастер? ===

Чтобы задать взаимосвязь TMDriver для Android и [[Такси-Мастер]], необходимо совершить следующие действия. Вызвать главное меню программы путем нажатия кнопки {{pda key|Меню}}, которая находится на вашем мобильном устройстве.

{{картинка|Меню TMDriver для Android.png}}

Нажмите на кнопку {{pda key|Настройки}}, после чего у вас появится форма ввода параметров взаимодействия:

{{картинка|Меню Настройки TMDriver для Android.png}}

Установите адрес [[GPRS-сервер|сервера]], нажав на стрелочку, которая находится рядом с пунктом {{pda key|Адрес сервера}}. После этого у вас выпадет форма, в которой вы должны будете указать адрес вашего сервера. После завершения ввода адреса нажмите {{pda key|Ок}}.

По такому же алгоритму действий заполните формы пунктов {{pda key|Порт сервера}}, {{pda key|ИД}}, {{pda key|Пароль}} водителя. После того, как вы заполните эти формы, то нажмите кнопку {{pda key|Назад}}, которая расположена на вашем мобильном устройстве, она приведет вас к открывшемуся списку стоянок. И автоматически поменяется статус водителя на {{pda key|"Свободен"}}

{{картинка|Список стоянок в TMDriver для Android.png}}

{{info|
Обратите внимание на то, что список стоянок может быть большим и размещаться на нескольких страницах, как показано на картинке выше (1/2). Чтобы переключиться на другую страницу, вам необходимо прокрутить страницу путем движения пальца по экрану.
}}

=== Работа со списком стоянок ===

Чтобы просмотреть информацию по любой из стоянок, которые находятся у вас в списке, необходимо активировать эту форму, путем нажатия на ту стоянку, которая вам необходима. После этого у вас выпадет меню, которое состоит из следующих форм:

# {{pda key|Заказы}} - приводит вас к списку действующих заказов на стоянке.
# {{pda key|Машины}} - приводит вас к списку экипажей, находящихся на данной стоянке.
# {{pda key|Регистрация}} - регистрация экипажа на стоянке.

{{картинка|Меню Стоянки в TMDriver для Android.png}}

Если водитель хочет принять какой-либо [[заказ]], то ему необходимо сначала зарегистрироваться на [[Окно «Стоянки» в Такси-Мастер 2|стоянке]]. После этого он должен выбрать заказ, который хочет принять. Это можно сделать в меню {{pda key|Заказ}} путем нажатия на кнопку желаемого заказа. Это действие приведет водителя к форме подробных данных о заказе, которые включают в себя [[Адрес подачи|адрес подачи]], имя заказчика и прочую информацию, необходимую для водителя.

{{картинка|Данные о заказе в TMDriver для Android.png}}

Вы можете редактировать список данных о заказе, которые будут отображаться в данной форме. Это производится в меню [[Настройка модуля Java#Водители|настройки]]. Чтобы взять заказ, водителю необходимо указать количество минут, в течение которых он прибудет по адресу подачи. Для этого он нажимает на кнопку {{pda key|Минуты}} и выбирает нужное количество времени. Указанное водителем количество минут автоматически отправляется в сервер связи с водителями и означает, что водитель заказ принял, после чего данный заказ снимается из списка.

{{картинка|Выбор количества минут в TMDriver для Android.png}}

После определения количества минут до подъезда к адресу подачи клиента, в TMDriver для Android пойдет обратный отсчет времени до подачи автомобиля.

=== Работа с картами в TMDriver для Android ===
С помощью встроенных в TMDriver для Android карт, водитель всегда сможет просмотреть маршрут выбранного им заказа, а также путь, который ему необходимо будет пройти до адреса подачи клиента. Благодаря этой функции водитель будет знать, где располагаются нужные точки маршрута и никогда не заблудится в городе.

Маршрут пути автоматически передается из программы Такси-Мастер в TMDriver для Android после подтверждения заказа водителем, о чем приложение сразу же его оповещает.

{{картинка|Получен маршрут заказа в TMDriver для Android.png}}

Для того, чтобы открыть карту и просмотреть маршрут, водитель должен нажать на кнопку {{кнопка|Навигация}}, которая располагается на панели управления TMDriver для Android. После этого откроется изображение карты.

{{картинка|Карта в TMDriver для Android.png}}

Иконка серой машины - это то место, где в данный момент располагается водитель. Пункт А - адрес подачи экипажа, соответственно пункт B - конечный адрес назначения.

В случае, если водитель хочет проложить маршрут заказа, то он должен нажать кнопку {{pda key|M}}, после чего появится меню, в котором можно будет выбрать следующие действия:
# Проложить маршрут заказа
# Проложить маршрут до места подачи

{{картинка|Проложить маршрут на карте в TMDriver для Android.png}}

Если водитель выберет действие {{pda key|Проложить маршрут заказа}}, то, соответственно, на карте отобразится полный путь, который должен будет пройти водитель при выполнении заказа, то есть от пункта А до пункта В.

{{картинка|Проложить маршрут заказа на карте в TMDriver для Android.png}}

Если водитель выберет действие {{pda key|Проложить маршрут до места подачи}}, то на карте отобразится путь, который должен будет пройти водитель до адреса подачи клиента. то есть от своего местонахождения до пункта А.

{{картинка|Проложить маршрут до места подачи на карте в TMDriver для Android.png}}

Для того, чтобы увидеть точные адреса пунктов маршрута, необходимо нажать на кнопку {{pda key|З}} или на само изображение пункта, после чего на карте появится отображение названия улицы и номера дома.

{{картинка|Информация по заказу на карте в TMDriver для Android.png}}

Чтобы увеличить или уменьшить масштаб карты, воспользуйтесь кнопками {{pda key|+}} или {{pda key|-}}.

Чтобы снова вернуться к форме выполнения заказа нажмите на кнопку "Назад" на своем мобильном устройстве.

==== Выбор карты для работы в TMDriver для Android ====
В TMDriver для Android вы можете выбирать, с какой картой будете работать. Для этого в приложении существует несколько встроенных карт. Чтобы совершить выбор, изначально необходимо зайти в меню карт. Для этого нужно нажать на кнопку с изображениям трех квадратиков на панели управления картами.

{{картинка|Меню карт в TMDriver для Android.png}}

В позиции {{tab|Карта для навигации}} нажмите стрелочку для открытия списка карт, с которыми есть возможность работать. Это карты:
# Яндекс
# Google
# Mapnik (карты производителя OpenStreetMap).

По функциональной составляющей все три карты не отличаются друг от друга. Принципиальная разница состоит лишь в их интерфейсе.

=== Выполнение заказа ===

Выполнение заказа водителем происходит следующим образом. Когда водитель прибывает к адресу подачи, то он должен нажать кнопку {{pda key|На месте}}, чтобы оповестить диспетчерскую о том, что он прибыл по адресу. Следующим его действием является нажатие на кнопку {{pda key|Поехали}}, это дает знать диспетчеру, что заказчик уже сел в экипаж и водитель готов начать движение.

{{картинка|Начало движения экипажа в TMDriver для Android.png}}

Когда [[Справочник «Экипажи»|экипаж]] приводится в [[Схемы работы с заказами (модуль Java)|состояние]] занят ({{tmdriver/индикатор/з}}) открывается [[таксометр]]:

{{картинка|Таксометр Android.png}}

Кнопкой {{pda key|Старт}} водитель приводит заказ в действие.

Форма работающего таксометра выглядит следующим образом:

{{картинка|Работающий таксометр в TMDriver Android.png}}

Как вы можете видеть, таксометр отображает все необходимые данные как для водителя и диспетчерской, так и для заказчика. Это стоимость поездки (по центру экрана большие черные цифры), время в пути, расстояние, которое проделал экипаж, точность, тариф и скорость движения автомобиля.

Когда экипаж прибудет к пункту назначения, следовательно, заказ завершиться. Водитель должен будет нажать на кнопку {{pda key|Расчет}}, что приведет к остановке таксометра и выводу подробных данных о поездке на экран.

{{картинка|Информация по заказу в TMDriver для Android.png}}

В окне имеются две кнопки, которые соответствуют расчету заказчика с водителем. Если заказчик рассчитался за поездку, то водитель нажимает кнопку {{pda key|Успешно}}, а если же нет - кнопку {{pda key|Не рассчитались}}, что свидетельствует о неудачном завершении заказа. Но при любом исходе после полного завершения заказа, водитель попадает вновь на список стоянок, где выбирает себе новый заказ.

== Сообщения ==

Сообщения нужны для связи водителей и диспетчерской службы. Чтобы написать какое-либо сообщение, необходимо, во-первых, разрешить отправку сообщения всем водителям в [[Настройка модуля Java#Общие|настройках модуля]], во-вторых, открыть форму для отправки сообщения в главном меню TMDriver для Android.

{{картинка|Меню "Сообщения" в TMDriver для Android.png}}

После открытия вы будете видеть следующую форму:

{{картинка|Форма ввода сообщения в TMDriver для Android.png}}

Диалог проходит в форме чата. Если вам пришло сообщение от диспетчера, который именуется "Администратор", то достаточно просто нажать на его сообщение, чтобы открылась форма ввода ответа на сообщение.

Если же вы хотите самостоятельно написать сообщения, начав чат, то действуйте по следующей схеме. В поле {{pda key|Кому}} необходимо указать получателя сообщения. Получатель сообщения именуется по его позывному. Чтобы отправить сообщение всем операторам, в качестве получателя укажите {{code|0}}. Чтобы отправить сообщение всем водителям, в качестве получателя укажите {{code|*}}. В поле {{pda key|Текст сообщения}} необходимо ввести текст сообщения. Также можно использовать шаблоны сообщений, нажав на кнопку {{pda key|Шаблоны}}.



[[Категория:Модуль Java]]
[[Категория:Клиентская часть]]
[[Категория:TMDriver]]
[[Категория:Настройка]]

TM API

2013-10-02T08:24:52Z

AnnaNikolskih: /* Создать новый заказ */

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

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

# Создать механизм приема заказов через интернет.
# Сделать ваш сайт более информативным: публиковать полезную для клиентов информацию прямо из системы - список ближайших [[Справочник «Экипажи»|экипажей]], предварительный расчет стоимости поездки, мониторинг движения автомобиля такси в процессе выполнения [[заказ]]а, [[Модуль «Интеграция с картами»|карты города]] и контактную информацию.
# Расширить возможности своей службы за счет популярного онлайн-сервиса Яндекс Такси.

== Параметры TM API ==
Задать настройки для корректной работы TM API вы сможете в программе [[Такси-Мастер]] в меню {{tab|Настройки}} в одноименной ветке {{tab|TM API}}.
Параметры организуют и контролируют работу [[Модуль «Интернет-заказы»|модуля «Интернет-заказы»]].
# Установите флажок {{checkbox|Использовать TM API}}, чтобы приступить к его использованию.
# В поле {{поле|Локальный порт}} введите номер порта подключения к интернету, на котором работает и будет ожидать запросы о новых заказах [[TMServer]]. Рекомендуется оставить номер порта по умолчанию.
# Установите флажок {{checkbox|Можно использовать данное рабочее место TMServer для распознавания адресов}} для того, чтобы конкретно с данного рабочего места происходило распознавание адресов модулем "Интернет-заказы".
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

=== Ветка «Открытое API» ===
В данной ветке регулируется доступ к синхронизации Такси-Мастер со сторонним сервисом (сайтом), с помощью которого клиенты будут создавать интернет-заказы. С примером кода для работы вы можете ознакомиться в данной статье в разделе [[TM API#Общее описание протокола|Общее описание протокола]].
# Установите флажок {{checkbox|Использовать открытое API}} для того, чтобы запустить работу по обслуживанию модуля «Интернет-заказы». При установленном флажке сервер [[Модуль «Интернет-заказы»|модуля «Интернет-заказы»]] запускается и ожидает запросы о новых заказах.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы с модулем «Интернет-заказы», который будет выслан вам в письме от менеджера.
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

=== Ветка «API для телефонии» ===
В данной ветке регулируются настройки API для телефонии, т.е. взаимодействие [[Такси-Мастер]] с call-центром через программный интерфейс. С его помощью [[Call-центр Oktell|call-центр]] может дать команду Такси-Мастер создать [[зака]]з или запросить информацию о [[Справочник «Состояния заказа»|статусе текущего заказа]].
# Установите флажок {{checkbox|Использовать открытое API для телефонии}} для того, чтобы запустить работу по обслуживанию телефонии через API.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы.
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

=== Ветка «Платежные терминалы» ===
{{info|Ранее для связи [[Модуль интеграции с платежными системами|платежных систем]] и [[Такси-Мастер]] служила такая утилита, как TMWeb. В данный момент мы отказались от ее использования, а функции были распределены между двумя компонентами системы: TM API и [[TMServer]].}}

Параметры этой ветки отвечают за работу [[Модуль интеграции с платежными терминалами|модуля интеграции с платежными системами]].
# Установите флажок {{checkbox|Включить прием терминальных платежей}}. Данная функция позволит отображать все платежные операции по приходу средств от водителей через терминалы в [[База данных Такси-Мастер 2|базе данных]] программы.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы с платежными системами и сверки платежей, который будет выслан вам в письме от менеджера. Секретный ключ - это определенный набор символов, необходимый для формирования подписи при передаче информации о платеже.
# В полях {{поле|Логин}} и {{поле|Пароль}} введите данные учетной записи на сайте http://term.bitmaster.ru.
# Кнопка {{кнопка|Задать всем водителям терминальный аккаунт по их ИД}} служит для соединения TM API с сервером Такси-Мастер. В результате соединения записи о терминальных аккаунтах генерируются, заносятся (для тех водителей, у которых они отсутствуют) и обновляются (для тех водителей, у которых уже существуют терминальные аккаунты) в Такси-Мастер.
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

{{info|Обратите внимание, что для платежных систем также существует открытый и свободно распространяемый API, с помощью которого есть возможность связать [[Такси-Мастер]] и [[Модуль интеграции с платежными системами|платежные системы]]. Обратитесь в отдел дополнительных услуг, написав на {{ящик ОДУ}}, за получением кода для данного компонента системы.}}

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

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

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

<pre>
GET https://ip:port/common_api/1.0/get_crew_groups_list HTTP/1.1
</pre>

Для получения данных из БД используются запросы типа GET. Для записи данных в [[База данных Такси-Мастер|базу данных]] используются запросы типа POST. В запросе типа GET параметры запроса передаются в URI. Пример:
<pre>
GET https://ip:port/common_api/1.0/calc_order_cost?tariff_id=1&distance_city=10 HTTP/1.1
Signature: <...>
</pre>

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

<pre>
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
</pre>

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

<pre>
Запрос:
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
</pre>

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

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

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

Существуют общие для всех запросов коды результатов:
{|
! Код
! Описание
|-
|0
|Успешное выполнение запроса
|-
|1
|Неизвестная ошибка
|-
|2
|Неизвестный тип API
|-
|3
|API отключено в настройках TMWeb
|-
|4
|Не совпадает секретный ключ
|-
|5
|Неподдерживаемая версия API
|-
|6
|Неизвестное название запроса
|-
|7
|Неверный тип запроса GET/POST
|-
|8
|Не хватает входного параметра (в доп. информации ответа будет название отсутствующего параметра)
|-
|9
|Некорректный входной параметр (в доп. информации ответа будет название некорректного параметра)
|-
|10
|Внутренняя ошибка обработки запроса
|}

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

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

Метод: GET или POST

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

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

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

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

Пример:

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

=== Запрос списка групп экипажей ===
Метод: GET

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

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

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

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crew_groups
|Массив
|Список групп экипажей
|-
|• id
|Целое
|ИД группы экипажей
|-
|• name
|Строка
|Название группы экипажей
|}

Пример:

<pre>
Запрос:

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

Ответ:

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

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

Метод: GET

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

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

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

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

{|
!Параметр
!Тип
!Описание
|-
|uds
|Массив
|Список служб [[Модуль «Единая диспетчерская служба»|ЕДС]]
|-
|• id
|Целое
|ИД службы [[Модуль «Единая диспетчерская служба»|ЕДС]]
|-
|• name
|Строка
|Название службы [[Модуль «Единая диспетчерская служба»|ЕДС]]
|}

Пример:

<pre>
Запрос:

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

Ответ:

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

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

Метод: GET

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

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

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

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

{|
!Параметр
!Тип
!Описание
|-
|tariffs
|Массив
|Список [[Справочник «Тарифы»|тарифов]]
|-
|• id
|Целое
|ИД [[Справочник «Тарифы»|тарифа]]
|-
|• name
|Строка
|Название [[Справочник «Тарифы»|тарифа]]
|-
|• is_active
|true или false
|Активный [[Справочник «Тарифы»|тариф]]
|}

Пример:

<pre>
Запрос:

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

Ответ:

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

=== Запрос списка услуг ===
Метод: GET

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

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

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

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

{|
!Параметр
!Тип
!Описание
|-
|services
|Массив
|Список [[Справочник «Услуги»|услуг]]
|-
|• id
|Целое
|ИД [[Справочник «Услуги»|услуги]]
|-
|• name
|Строка
|Название [[Справочник «Услуги»|услуги]]
|-
|• sum
|Дробное
|Абсолютная сумма [[Справочник «Услуги»|услуги]], руб
|-
|• percent
|Дробное
|Процент [[Справочник «Услуги»|услуги]] от стоимости заказа, %
|}

Пример:

<pre>
Запрос:

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

Ответ:

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

=== Запрос списка скидок ===
Метод: GET

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

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

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

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

{|
!Параметр
!Тип
!Описание
|-
|discounts
|Массив
|Список [[Справочник «Скидки клиентов»|скидок]]
|-
|• id
|Целое
|ИД [[Справочник «Скидки клиентов»|скидки]]
|-
|• name
|Строка
|Название [[Справочник «Скидки клиентов»|скидки]]
|-
|• sum
|Дробное
|Абсолютная сумма [[Справочник «Скидки клиентов»|скидки]], руб
|-
|• percent
|Дробное
|Процент [[Справочник «Скидки клиентов»|скидки]] от стоимости заказа, %
|}

Пример:

<pre>
Запрос:

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

Ответ:

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

=== Создание нового заказа ===
Метод: POST

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

Параметры:

{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|phone
|Строка, <= 16 символов
|Номер телефона
|-
|source
|Строка
|Адрес подачи
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
!colspan="3"|Необязательные параметры
|-
|dest
|Строка
|Адрес назначения
|-
|customer
|Строка
|Заказчик
|-
|comment
|Строка
|Комментарий
|-
|crew_group_id
|Целое
|ИД группы экипажей
|-
|uds_id
|Целое
|ИД службы ЕДС
|-
|tariff_id
|Целое
|ИД тарифа
|-
|is_prior
|true или false
|Предварительный заказ
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Заказ с такими параметрами уже создан
|-
|101
|Тариф не найден
|-
|102
|Группа экипажа не найдена
|-
|103
|Служба ЕДС не найдена
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|order_id
|Целое
|ИД созданного заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_order HTTP/1.1
Signature: <...>
Content-Type: application/x-www-form-urlencoded
Content-Length: 127
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

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"order_id":12345
}
}
</pre>

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

Метод: GET

Название запроса: calc_order_cost
{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|tariff_id
|Целое
|ИД тарифа
|-
Параметры:

!colspan="3"|Необязательные параметры
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|is_prior
|true или false
|Предварительный заказ
|-
|client_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»
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Тариф не найден
|-
|101
|Ошибка при расчете по тарифу
|-
|102
|Скидка не найдена
|-
|103
|Клиент не найден
|-
|104
|Район подачи не найден
|-
|105
|Район назначения не найден
|-
|106
|Дисконтная карта не найдена
|}

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

Пример:

<pre>
Запрос:

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

Ответ:

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

=== Запрос информации об экипаже ===
Метод: GET

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

Параметры:
{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|crew_id
|Целое
|ИД экипажа
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Экипаж не найден
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crew_id
|Целое
|ИД экипажа
|-
|code
|Строка
|Позывной экипажа
|-
|name
|Строка
|Наименование экипажа
|-
|driver_id
|Целое
|ИД водителя
|-
|car_id
|Целое
|ИД автомобиля
|-
|crew_group_id
|Целое
|ИД группы экипажа
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_crew_info?crew_id=1 HTTP/1.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
}
}
</pre>

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

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

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|driver_id
|Целое
|ИД водителя
|-
!colspan="3"|Необязательные параметры
|-
|need_photo
|true или false
|Нужна ли фотография водителя
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Водитель не найден
|}

Возвращаемые параметры в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|driver_id
|Целое
|ИД водителя
|-
|name
|Строка
|ФИО водителя
|-
|birthday
|ДД.ММ.ГГГГ
|День рождения водителя
|-
|car_id
|Целое
|ИД основного автомобиля водителя
|-
|license
|Строка
|Удостоверение водителя
|-
|home_phone
|Строка
|Домашний телефон водителя
|-
|mobile_phone
|Строка
|Мобильный телефон водителя
|-
|is_locked
|true или false
|Водитель заблокирован
|-
|is_dismissed
|true или false
|Водитель уволен
|-
|driver_photo
|Base64
|Фото водителя (только если need_photo = true)
|}

Пример:

<pre>
Запрос:

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",
"birthday":"01.01.1980",
"car_id":1,
"license":"1234567890",
"home_phone":"123456",
"mobile_phone":"+79123456789",
"is_locked":false,
"is_dismissed":false
}
}
</pre>

=== Запрос информации об автомобиле ===
Метод: GET

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

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|car_id
|Целое
|ИД автомобиля
|-
!colspan="3"|Необязательные параметры
|-
|need_photo
|true или false
|Нужна ли фотография автомобиля
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Автомобиль не найден
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|car_id
|Целое
|ИД автомобиля
|-
|name
|Строка
|Наименование автомобиля
|-
|code
|Строка
|Позывной автомобиля
|-
|gos_number
|Строка
|Государственный номер автомобиля
|-
|color
|Строка
|Цвет автомобиля
|-
|mark
|Строка
|Марка автомобиля
|-
|short_name
|Строка
|Краткое название автомобиля
|-
|production_year
|Целое
|Год выпуска автомобиля
|-
|car_photo
|Base64
|Фото автомобиля (только если need_photo = true)
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_car_info?car_id=1&need_photo=false HTTP/1.1
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
}
}
</pre>

=== Запрос координат экипажей ===
Метод: GET

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

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Необязательные параметры
|-
|crew_id
|Целое
|ИД экипажа, по которому нужно вернуть координаты. Если не задано, то будут возвращены координаты всех экипажей на линии.
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Координаты не найдены
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crews_coords
|Массив
|Список координат экипажей
|-
|• crew_id
|Целое
|ИД экипажа
|-
|• crew_code
|Строка
|Позывной экипажа
|-
|• coords_time
|ГГГГММДДччммсс
|Время получения координат
|-
|• lat
|Дробное
|Долгота
|-
|• lon
|Дробное
|Широта
|-
|• state_kind
|Строка
|Тип состояния экипажа. Может принимать значения:
• "not_available" — экипаж не на линии

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

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

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

Пример:

<pre>

Запрос:
GET https://ip:port/common_api/1.0/get_crews_coords HTTP/1.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"
},
{
"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 HTTP/1.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"
}
]
}
}
</pre>

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

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
! colspan="3"|Обязательные параметры
|-
|get_streets
|true или false
|Искать улицы
|-
|get_houses
|true или false
|Искать пункты
|-
|get_streets
|true или false
|Искать дома. Не может быть равно true, если get_streets = true или get_points = true.
|-
|street
|Строка
|Часть названия улицы или пункта, если идет поиск улиц или пунктов, или полное название улицы, если идет поиск домов
|-
!colspan="3"|Необязательные параметры
|-
|house
|Строка
|Часть номера дома. Нужно только если get_houses = true.
|-
|max_addresses_count
|Целое
|Максимальное количество адресов в ответе
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Подходящие адреса не найдены
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|addresses
|Массив
|Список подходящих адресов
|-
|• street
|Строка
|Название улицы или пункта
|-
|• house
|Строка
|Номер дома
|-
|• kind
|Строка
|Тип адреса. Может принимать значения:
• "street" — улица

• "house" — дом

• "point" — пункт
|-
|• comment
|Строка
|Комментарий
|}

Пример:

<pre>

Запрос:

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

Ответ:

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

Запрос:

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 HTTP/1.1
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":""
}
]
}
}
</pre>

=== Анализ маршрута ===
Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|source
|Строка
|Адрес подачи
|-
|dest
|Строка
|Адрес назначения
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Адрес подачи не распознан
|-
|101
|Адрес назначения не распознан
|-
|102
|Маршрут не распознан
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|source_lat
|Дробное
|Широта адреса подачи
|-
|source_lon
|Дробное
|Долгота адреса подачи
|-
|source_zone_id
|Целое
|ИД района подачи
|-
|dest_lat
|Дробное
|Широта адреса назначения
|-
|dest_lon
|Дробное
|Долгота адреса назначения
|-
|dest_zone_id
|Целое
|ИД района назначения
|-
|city_dist
|Дробное
|Километраж по городу
|-
|country_dist
|Дробное
|Километраж за городом
|-
|source_country_dist
|Дробное
|Километраж до адреса подачи, если адрес подачи за городом
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/analyze_route?source=STREET1,1&dest=STREET2,2 HTTP/1.1
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
}
}
</pre>

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

Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|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
|Целое
|ИД автомобиля
|-
|start_time
|ГГГГММДДччммсс
|Время создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|finish_time
|ГГГГММДДччммсс
|Время завершения заказа
|-
|source
|Строка
|Адрес подачи
|-
|destination
|Строка
|Адрес назначения
|-
|passenger
|Строка
|Пассажир
|-
|phone
|Строка
|Номер телефона
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_order_state?order_id=1 HTTP/1.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
"start_time":"17.01.2013 12:56:41",
"source_time":"17.01.2013 13:26:17",
"finish_time":"17.01.2013 13:03:43",
"source":"1",
"destination":"2",
"passenger":"Слепаков",
"phone":"8800"
}
}
</pre>

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

Метод: POST

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|phone
|Строка, <= 16 символов
|Номер телефона
|-
|message
|Строка
|Текст СМС
|}

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

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

Пример:

<pre>
Запрос:

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

Signature: <...>

message=SMSText&phone=89050057216

Ответ:

{
"code":0,
"descr":"OK",
"data":{}
}
</pre>

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

Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|login
|Строка, <= 60 символов
|Логин
|-
|password
|Строка, <= 60 символов
|Пароль
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент с логином LOGIN и/или неверный пароль
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|client_id
|Целое
|ИД клиента
|}

Пример:

<pre>
Запрос:

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

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"client_id":131
}
}
</pre>

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

Метод: POST

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

Параметры:

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

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

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Клиент с номером телефона=PHONE уже существует
|-
|101
|Клиент с логином=LOGIN уже существует
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|client_id
|Целое
|ИД созданного клиента
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_order HTTP/1.1

Signature: <...>

Content-Type: application/x-www-form-urlencoded

Content-Length: 127

name=NAME&phones=88,99&login=LOGIN&password=PASSWORD&birthday=19930218115517&gender=male&address=ADDRESS

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"client_id":140
}
}
</pre>

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

Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

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

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

• "female" - женский
|-
|birthday
|ДД.ММ.ГГГГ
|Дата рождения
|-
|phones
|Строка
|Номера телефонов (через запятую)
|-
|balance
|Дробное
|Баланс
|-
|login
|Строка
|Логин
|-
|password
|Строка
|Пароль
|}

Пример:

<pre>
Запрос:

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

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"client_id":140,
"name":"Васильев Артём",
"number":"000140",
"address":"Бутово,45",
"gender":"male",
"birthday":"18.02.1993",
"phones":"[\"88\",\"99\"]",
"balance":1467,
"login":"artem",
"password":"vasilev"
}
}
</pre>

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

Метод: POST

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

Параметры:

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

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

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Клиент с номером телефона=PHONE уже существует
|-
|101
|Клиент с логином=LOGIN уже существует

|}

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

Пример:

<pre>
Запрос:

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

client_id=140&name=NAME&phones=88,99&login=LOGIN&password=PASSWORD&birthday=19930218115517&gender=male&address=ADDRESS

Ответ:

{
"code":0,
"descr":"OK",
"data":{}
}
</pre>

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

Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента (может отсутствовать, если phone заполнен)
|-
|phone
|Строка, <= 16 символов
|Телефон клиента (может отсутствовать, если client_id заполнен)
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|id
|Целое
|ИД заказа
|-
|state_id
|Целое
|ИД состояния заказа
|-
|start_time
|ГГГГММДДччммсс
|Дата создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|source
|Строка
|Адрес подачи
|-
|destination
|Строка
|Адрес назначения
|-
|passenger
|Строка
|Пассажир
|-
|crew_id
|Целое
|ИД экипажа
|-
|prior_crew_id
|Целое
|ИД предварительного экипажа
|-
|driver_id
|Целое
|ИД водителя
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_current_orders?client_id=140&phone=18 HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"orders":[
{
"id":20648,
"state_id":44,
"start_time":"20130204181111",
"source_time":"20130204181111",
"source":"1-й пр-т \/Москва\/,",
"destination":"12-й мкр,",
"passenger":"маша",
"crew_id":0,
"prior_crew_id":0,
"driver_id":0
},
{
"id":20670,
"state_id":44,
"start_time":"20130207153022",
"source_time":"20130207153022",
"source":"11-й мкр,",
"destination":"1-й пр-т \/Москва\/,",
"passenger":"саша",
"crew_id":0,
"prior_crew_id":0,
"driver_id":0
}
]
}
}
</pre>

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

Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента (может отсутствовать, если phone заполнен)
|-
|phone
|Строка, <= 16 символов
|Телефон клиента (может отсутствовать, если client_id заполнен)
|-
|start_time
|ГГГГММДДччммсс
|Начало периода
|-
|finish_time
|ГГГГММДДччммсс
|Конец периода
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|id
|Целое
|ИД заказа
|-
|state_id
|Целое
|ИД состояния заказа
|-
|start_time
|ГГГГММДДччммсс
|Время создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|finish_time
|ГГГГММДДччммсс
|Время завершения заказа
|-
|source
|Строка
|Адрес подачи
|-
|destination
|Строка
|Адрес назначения
|-
|passenger
|Строка
|Пассажир
|-
|sum
|Дробное
|Стоимость заказа без учета скидок(наценок)
|-
|crew_id
|Целое
|ИД экипажа
|-
|prior_crew_id
|Целое
|ИД предварительного экипажа
|-
|driver_id
|Целое
|ИД водителя
|-
|car_id
|Целое
|ИД автомобиля
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_finished_orders?client_id=140&phone= HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"orders":[
{
"id":20651,
"state_id":34,
"source_time":"20130205110812",
"start_time":"20130205110812",
"finish_time":"20130205115618",
"source":"прпроп",
"destination":"рррррр",
"passenger":"вера",
"sum":"908",
"crew_id":"6",
"prior_crew_id":0,
"driver_id":"4",
"car_id":"6"
},
{
"id":20669,
"state_id":34,
"source_time":"20130205130500",
"start_time":"20130205130500",
"finish_time":"20130205134511",
"source":"1",
"destination":"2",
"passenger":"маша",
"sum":"454",
"crew_id":"6",
"prior_crew_id":0,
"driver_id":"4",
"car_id":"6"
}
]
}
}
</pre>

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

Метод: POST

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента
|-
|oper_time
|ГГГГММДДччммсс
|Время создания операции
|-
|sum
|Дробное
|Сумма
|-
|oper_type
|Целое
|Тип операции:
• "receipt" - приход

• "expense" - расход
|-
|pay_type
|Целое
|Тип оплаты:
• "cash" - наличный

• "nocash" - безналичный
|-
!colspan="3"|Необязательные параметры
|-
|comment
|Строка
|Комментарий
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|oper_id
|Целое
|ИД операции
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_client_operation HTTP/1.1

Signature: <...>

Content-Type: application/x-www-form-urlencoded

Content-Length: 127

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

Ответ:

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

}
}
</pre>

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

Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента (может отсутствовать, если phone заполнен)
|-
|phone
|Целое
|Телефон клиента (может отсутствовать, если client_id заполнен)
|-
|start_time
|ГГГГММДДччммсс
|Начало периода
|-
|finish_time
|ГГГГММДДччммсс
|Конец периода
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|oper_id
|Целое
|ИД операции
|-
|oper_time
|ГГГГММДДччммсс
|Время создания операции
|-
|sum
|Дробное
|Сумма
|-
|order_id
|Целое
|Заказ, связанный с операцией
|-
|oper_type
|Целое
|Тип операции:
• "receipt" - приход
• "expense" - расход
|-
|pay_type
|Целое
|Тип оплаты:
• "cash" - наличный
• "nocash" - безналичный
|}

Пример:

<pre>
Запрос:

GET

https://ip:port/common_api/1.0/get_client_operations?client_id=112&start_time=20130201092112&finish_time=20130221092112 HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"operations":[
{
"oper_id":112,
"oper_time":"20130219091328",
"sum":"21,8",
"order_id":11800,
"oper_type":"receipt",
"pay_type":"cash",
"comment":"jgznm"
},
{
"oper_id":112,
"oper_time":"20130220112245",
"sum":"4500",
"order_id":11801,
"oper_type":"receipt",
"pay_type":"cash",
"comment":"блин"
}
]
}
}
</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 HTTP/1.1
</pre>

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

Пример:

<pre>
GET https://ip:port/tm_tapi/1.0/get_info_by_phone?phone=89058800565&fields=PHONE_TYPEPHONE_
TO_DIAL&signature=661ce071eeefcb4f7fc8bc1f17bd520b HTTP/1.1
</pre>

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

Пример:

<pre>
POST https://ip:port/tm_tapi/1.0/change_order_state HTTP/1.1
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 HTTP/1.1

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

Signature = MD5("phone=89058800565&fields=PHONE_TYPE" + "321") = ef17ea682d09e452af544a5758dba396
HTTP/1.1
</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 - если звонит номер из справочника телефоны; 0 - неизвестный номер)
|-
|PHONE_TO_DIAL
|Строка, <= 16 символов
|Номер телефона для отзвона по заказу
|-
|CREW_ID
|Целое
|ИД экипажа
|-
|IS_PRIOR
|true или false
|Признак предварительного заказа
|-
|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
|Целое
|ИД группы экипажа
|-
|CLIENT_BALANCE
|Дробное
|Баланс клиента
|-
|DRIVER_TIMECOUNT
|Целое
|Время пути водителя до адреса подачи в минутах
|-
|SOURCE_TIMECOUNT
|Целое
|Время оставшееся до подачи в минутах
|-
|SOUND_COLOR
|Строка
|Запись с информацией о цвете
|-
|SOUND_GOSNUMBER
|Строка
|Запись с информацией о государственном номере автомобиля
|-
|SOUND_MARK
|Строка
|Запись с информацией о марке автомобиля
|-
|GOSNUMBER
|Строка
|Государственный номер автомобиля
|-
|CAR_COLOR
|Строка
|Цвет автомобиля
|-
|CAR_MARK
|Строка
|Марка автомобиля
|-
|ORDER_COORDS
|Строка
|Координаты места подачи
|-
|CREW_COORDS
|Строка
|Координаты назначенного экипажа
|}

Пример:

<pre>
Запрос:
GET https://ip:port/tm_tapi/1.0/get_info_by_phone?phone=89058800565l&fields=PHONE_TYPEPHONE_
TO_DIAL-CREW_ID-ORDER_ID&signature=d35ab2765f2968d48c096d5f5327db26 HTTP/1.1

Ответ:

<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>
</data>
</response>
</pre>

==== Запрос информации по ИД заказа ====

Метод: GET
Название запроса: get_info_by_order_id
Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|-
|fields
|Строка
|Список полей, которые необходимо вернуть. Поля перечисляются через ''-''
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

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

{|
!Параметр
!Тип
!Описание
|-
|DRIVER_TIMECOUNT
|Строка, <= 16 символов
|Время до подачи в минутах, указанное водителем
|-
|SOUND_COLOR
|Строка
|Запись с информацией о цвете
|-
|CAR_MARK
|Строка
|Марка автомобиля
|-
|CAR_COLOR
|Строка
|Цвет автомобиля
|-
|GOSNUMBER
|Строка
|Государственный номер автомобиля
|-
|SOUND_MARK
|Строка
|Запись с информацией о марке автомобиля
|-
|CREW_GROUP_ID
|Целое
|ИД группы экипажа
|-
|IS_PRIOR
|true или false
|Признак предварительного заказа
|-
|DISCOUNTEDSUMM
|Строка
|Сумма заказа с учетом всех скидок
|-
|DRIVER_PHONE
|Строка, <= 16 символов
|Номер телефона водителя
|-
|CATEGORYID
|Целое
|ИД категории телефона
|-
|SOURCE_TIMECOUNT
|Целое
|Время до подачи в минутах
|-
|ORDER_COORDS
|Строка
|Координаты места подачи
|-
|CREW_COORDS
|Строка
|Координаты назначенного экипажа
|-
|ORDER_STATE
|Целое
|ИД состояния заказа
|}

Пример:

<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
HTTP/1.1

Ответ:

<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></SOURCE_TIME>
</data>
</response>
</pre>

==== Смена состояния заказа ====
Метод: POST

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

Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|-
|need_state
|Целое
|Новое состояние заказа
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

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

{|
!Код
!Описание
|-
|100
|Заказ с таким ИД не найден.
|-
|101
|Изменение состояния не соответствует необходимым условиям.
|}

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

{|
!Параметр
!Тип
!Описание
|-
|ORDER_ID
|Целое
|ИД созданного заказа
|-
|NEW_STATE
|Целое
|Новое состояние заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/tm_tapi/1.0/change_order_state HTTP/1.1
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"|Обязательные параметры
|-
|RECORD_DATE
|ГГГГММДДччммсс
|Дата записи
|-
|RECORD_LENGTH
|Целое
|Продолжительность записи (в секундах)
|-
|PHONE
|Строка, <= 16 символов
|Номер телефона
|-
|FILE_PATH
|Строка,<=255 символов
|Путь к файлу записи
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Заказ по такому номеру телефона не найден.
|}

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

{|
!Параметр
!Тип
!Описание
|-
|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: 171
RECORD_DATE=20130122180949&RECORD_LENGTH=215&PHONE=8987564&FILE_PATH=d%3A%5Ctemp%5CTM%5Ctrunk
%5CSource%5CDevUtils%5CTMAPITest%5C&signature=56851c4e8d2d4bb9ba615615f76ad7f7

Ответ:
<response>
<code>0</code>
<descr>OK</descr>
<data>
<RECORD_ID>25</RECORD_ID>
</data>
</response>
</pre>

==== Создать новый заказ ====

Метод: POST

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

Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|PHONE
|Строка, <= 16 символов
|Номер телефона
|-
|ORDER_STATE_ID
|Целое
|ИД состояния заказа
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|-
|colspan="3"|Необязательные параметры
|-
|CREWGROUPID
|Целое
|ИД группы экипажа
|-
|TARIF_ID
|Целое
|ИД тарифа
|-
|DISCOUNTEDSUMM
|Дробное
|Фиксированная сумма за заказ
|-
|NAME
|Строка, <=80 символов
|Наименование (заказчик + адрес назначения)
|-
|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
|Дробное
|Бонусные баллы, начисленные водителю за заказ
|-
|STARTSMEN
|Целое
|Смена пользователей, в которой был создан заказ
|-
|FINISHSMEN
|Целое
|Смена пользователей, в которой заказ был завершен
|-
|DISTANCE
|Дробное
|Километраж по городу (в километрах)
|-
|HOURLY_LEN
|Целое
|Длительность исполнения почасового заказа (в минутах)
|-
|HOURLY_START
|ГГГГММДДччммсс
|Дата начала отсчета при почасовом заказе
|-
|HOURLY_PAY
|0 или 1 (false или true)
|Признак почасового заказа
|-
|PHONE_TO_DIAL
|Строка, <=16 символов
|Номер телефона для отзвона по заказу
|-
|STOPS
|Строка, <=80 символов
|Остановки
|-
|STOPS_COUNT
|Целое
|Количество остановок
|-
|SERVICEID
|Целое
|ИД услуги
|-
|STATE_TIME
|ГГГГММДДччммсс
|Дата смены состояния
|-
|IS_LOCKED
|0 или 1 (false или true)
|Признак блокировки заказа от редактирования
|-
|TIME_LOCKED
|ГГГГММДДччммсс
|Дата блокировки заказа
|-
|LOCKED_BY
|Целое
|Пользователь, заблокировавший заказ
|-
|FROMBORDER
|0 или 1 (false или true)
|Признак заказа "с бордюра"
|-
|DRIVERID
|Целое
|ИД водителя
|-
|CLIENT_NOTIFIED
|0 или 1 (false или true)
|Признак успешного отзвона клиенту колцентром
|-
|PREFERENTIAL
|0 или 1 (false или true)
|Признак льготного заказа
|-
|LAST_CREW
|Целое
|ИД предыдущего экипажа
|-
|FSUMM
|Дробное
|Часть стоимости заказа, которая оплачена наличными
|-
|OLDCREW
|Целое
|Предыдущий экипаж
|-
|TIMEOUT
|ГГГГММДДччммсс
|Период времени, прошедший с момента последней смены состояния
|-
|WAITING_START
|ГГГГММДДччммсс
|Дата начала ожидания заказчика водителем
|-
|WAITING_LENGTH
|Целое
|Общая длина периода ожидания заказчика водителем (в минутах)
|-
|BACKFREE
|Целое
|Признак применения скидки в 50% на обратный путь
|-
|INPUTTIME
|ГГГГММДДччммсс
|Дата принятия заказа [от даты создания заказа отличается тем, что может быть задана пользователем]
|-
|MONEY_RECEIVE
|0 или 1 (false или true)
|Подтверждение принятия денег наличными
|-
|NOTIFY_BEFORE
|Целое
|Период времени, за который пользователь оповещается о наступлении даты подачи
|-
|WANTCREWID
|Целое
|ИД желаемого экипажа
|-
|DRIVER_SOURCETIME
|ГГГГММДДччммсс
|Дата подачи, указанная водителем с мобильного устройства
|-
|DRIVE_TIME
|Целое
|Приблизительное время доезда до адреса подачи, указываемое водителем через мобильное устройство
|-
|DISTANCE_COUNTRY
|Дробное
|Километраж за границами города (в километрах)
|-
|STOPS_LEN
|Целое
|Общая продолжительность остановок в минутах
|-
|DISTANCE_CHECK
|0 или 1 (false или true)
|Разрешение ручного ввода километража
|-
|CLIENTID
|Целое
|ИД постоянного клиента
|-
|INFRA_STATE
|Целое
|Состояние заявки в исходящей кампании колцентра INFRA (1 - заявка передана в исходящую кампанию, 2 - отзвон успешно произведен, 3 - занято, 4 - не берут трубку)
|-
|INFRA_ORDER
|Целое
|INFRA-заказ [спец. поле для работы с колцентром компании Инфрател]
|}

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

{|
!Код
!Описание
|-
|100
|Клиент не найден
|}

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

{|
!Параметр
!Тип
!Описание
|-
|ORDER_ID
|Целое
|ИД созданного заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/tm_tapi/1.0/make_new_order HTTP/1.1
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>
</pre>

== Пример формы для заказа такси ==
{{url|{{корень FTP|forms/zakaz_taxi.zip}}}}

Данная форма является примером, на основе которого можно построить собственную форму для принятия интернет-заказов. Форму можно использовать либо в исходном варианте, либо применяя запросы [[TM API#Описание запросов|TM API]].
Для того, чтобы данная форма функционировала, необходимо открыть файл в любом текстовом редакторе и указать корректные IP-адрес [[Сервер Такси-Мастер|сервера Такси-Мастер]], порт [[TM API#Параметры TM API|TM API]] и секретный ключ. Далее вам следует загрузить файл на хостинг.

Именно так будет выглядеть данная форма для заказа такси.
{{картинка|Форма для заказа такси.jpg}}

[[Категория:ТМ2]]

TM API

2013-10-02T07:20:39Z

AnnaNikolskih: /* Запись пути к файлу разговора в базу данных */

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

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

# Создать механизм приема заказов через интернет.
# Сделать ваш сайт более информативным: публиковать полезную для клиентов информацию прямо из системы - список ближайших [[Справочник «Экипажи»|экипажей]], предварительный расчет стоимости поездки, мониторинг движения автомобиля такси в процессе выполнения [[заказ]]а, [[Модуль «Интеграция с картами»|карты города]] и контактную информацию.
# Расширить возможности своей службы за счет популярного онлайн-сервиса Яндекс Такси.

== Параметры TM API ==
Задать настройки для корректной работы TM API вы сможете в программе [[Такси-Мастер]] в меню {{tab|Настройки}} в одноименной ветке {{tab|TM API}}.
Параметры организуют и контролируют работу [[Модуль «Интернет-заказы»|модуля «Интернет-заказы»]].
# Установите флажок {{checkbox|Использовать TM API}}, чтобы приступить к его использованию.
# В поле {{поле|Локальный порт}} введите номер порта подключения к интернету, на котором работает и будет ожидать запросы о новых заказах [[TMServer]]. Рекомендуется оставить номер порта по умолчанию.
# Установите флажок {{checkbox|Можно использовать данное рабочее место TMServer для распознавания адресов}} для того, чтобы конкретно с данного рабочего места происходило распознавание адресов модулем "Интернет-заказы".
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

=== Ветка «Открытое API» ===
В данной ветке регулируется доступ к синхронизации Такси-Мастер со сторонним сервисом (сайтом), с помощью которого клиенты будут создавать интернет-заказы. С примером кода для работы вы можете ознакомиться в данной статье в разделе [[TM API#Общее описание протокола|Общее описание протокола]].
# Установите флажок {{checkbox|Использовать открытое API}} для того, чтобы запустить работу по обслуживанию модуля «Интернет-заказы». При установленном флажке сервер [[Модуль «Интернет-заказы»|модуля «Интернет-заказы»]] запускается и ожидает запросы о новых заказах.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы с модулем «Интернет-заказы», который будет выслан вам в письме от менеджера.
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

=== Ветка «API для телефонии» ===
В данной ветке регулируются настройки API для телефонии, т.е. взаимодействие [[Такси-Мастер]] с call-центром через программный интерфейс. С его помощью [[Call-центр Oktell|call-центр]] может дать команду Такси-Мастер создать [[зака]]з или запросить информацию о [[Справочник «Состояния заказа»|статусе текущего заказа]].
# Установите флажок {{checkbox|Использовать открытое API для телефонии}} для того, чтобы запустить работу по обслуживанию телефонии через API.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы.
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

=== Ветка «Платежные терминалы» ===
{{info|Ранее для связи [[Модуль интеграции с платежными системами|платежных систем]] и [[Такси-Мастер]] служила такая утилита, как TMWeb. В данный момент мы отказались от ее использования, а функции были распределены между двумя компонентами системы: TM API и [[TMServer]].}}

Параметры этой ветки отвечают за работу [[Модуль интеграции с платежными терминалами|модуля интеграции с платежными системами]].
# Установите флажок {{checkbox|Включить прием терминальных платежей}}. Данная функция позволит отображать все платежные операции по приходу средств от водителей через терминалы в [[База данных Такси-Мастер 2|базе данных]] программы.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы с платежными системами и сверки платежей, который будет выслан вам в письме от менеджера. Секретный ключ - это определенный набор символов, необходимый для формирования подписи при передаче информации о платеже.
# В полях {{поле|Логин}} и {{поле|Пароль}} введите данные учетной записи на сайте http://term.bitmaster.ru.
# Кнопка {{кнопка|Задать всем водителям терминальный аккаунт по их ИД}} служит для соединения TM API с сервером Такси-Мастер. В результате соединения записи о терминальных аккаунтах генерируются, заносятся (для тех водителей, у которых они отсутствуют) и обновляются (для тех водителей, у которых уже существуют терминальные аккаунты) в Такси-Мастер.
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

{{info|Обратите внимание, что для платежных систем также существует открытый и свободно распространяемый API, с помощью которого есть возможность связать [[Такси-Мастер]] и [[Модуль интеграции с платежными системами|платежные системы]]. Обратитесь в отдел дополнительных услуг, написав на {{ящик ОДУ}}, за получением кода для данного компонента системы.}}

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

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

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

<pre>
GET https://ip:port/common_api/1.0/get_crew_groups_list HTTP/1.1
</pre>

Для получения данных из БД используются запросы типа GET. Для записи данных в [[База данных Такси-Мастер|базу данных]] используются запросы типа POST. В запросе типа GET параметры запроса передаются в URI. Пример:
<pre>
GET https://ip:port/common_api/1.0/calc_order_cost?tariff_id=1&distance_city=10 HTTP/1.1
Signature: <...>
</pre>

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

<pre>
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
</pre>

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

<pre>
Запрос:
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
</pre>

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

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

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

Существуют общие для всех запросов коды результатов:
{|
! Код
! Описание
|-
|0
|Успешное выполнение запроса
|-
|1
|Неизвестная ошибка
|-
|2
|Неизвестный тип API
|-
|3
|API отключено в настройках TMWeb
|-
|4
|Не совпадает секретный ключ
|-
|5
|Неподдерживаемая версия API
|-
|6
|Неизвестное название запроса
|-
|7
|Неверный тип запроса GET/POST
|-
|8
|Не хватает входного параметра (в доп. информации ответа будет название отсутствующего параметра)
|-
|9
|Некорректный входной параметр (в доп. информации ответа будет название некорректного параметра)
|-
|10
|Внутренняя ошибка обработки запроса
|}

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

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

Метод: GET или POST

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

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

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

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

Пример:

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

=== Запрос списка групп экипажей ===
Метод: GET

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

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

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

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crew_groups
|Массив
|Список групп экипажей
|-
|• id
|Целое
|ИД группы экипажей
|-
|• name
|Строка
|Название группы экипажей
|}

Пример:

<pre>
Запрос:

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

Ответ:

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

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

Метод: GET

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

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

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

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

{|
!Параметр
!Тип
!Описание
|-
|uds
|Массив
|Список служб [[Модуль «Единая диспетчерская служба»|ЕДС]]
|-
|• id
|Целое
|ИД службы [[Модуль «Единая диспетчерская служба»|ЕДС]]
|-
|• name
|Строка
|Название службы [[Модуль «Единая диспетчерская служба»|ЕДС]]
|}

Пример:

<pre>
Запрос:

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

Ответ:

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

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

Метод: GET

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

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

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

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

{|
!Параметр
!Тип
!Описание
|-
|tariffs
|Массив
|Список [[Справочник «Тарифы»|тарифов]]
|-
|• id
|Целое
|ИД [[Справочник «Тарифы»|тарифа]]
|-
|• name
|Строка
|Название [[Справочник «Тарифы»|тарифа]]
|-
|• is_active
|true или false
|Активный [[Справочник «Тарифы»|тариф]]
|}

Пример:

<pre>
Запрос:

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

Ответ:

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

=== Запрос списка услуг ===
Метод: GET

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

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

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

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

{|
!Параметр
!Тип
!Описание
|-
|services
|Массив
|Список [[Справочник «Услуги»|услуг]]
|-
|• id
|Целое
|ИД [[Справочник «Услуги»|услуги]]
|-
|• name
|Строка
|Название [[Справочник «Услуги»|услуги]]
|-
|• sum
|Дробное
|Абсолютная сумма [[Справочник «Услуги»|услуги]], руб
|-
|• percent
|Дробное
|Процент [[Справочник «Услуги»|услуги]] от стоимости заказа, %
|}

Пример:

<pre>
Запрос:

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

Ответ:

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

=== Запрос списка скидок ===
Метод: GET

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

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

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

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

{|
!Параметр
!Тип
!Описание
|-
|discounts
|Массив
|Список [[Справочник «Скидки клиентов»|скидок]]
|-
|• id
|Целое
|ИД [[Справочник «Скидки клиентов»|скидки]]
|-
|• name
|Строка
|Название [[Справочник «Скидки клиентов»|скидки]]
|-
|• sum
|Дробное
|Абсолютная сумма [[Справочник «Скидки клиентов»|скидки]], руб
|-
|• percent
|Дробное
|Процент [[Справочник «Скидки клиентов»|скидки]] от стоимости заказа, %
|}

Пример:

<pre>
Запрос:

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

Ответ:

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

=== Создание нового заказа ===
Метод: POST

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

Параметры:

{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|phone
|Строка, <= 16 символов
|Номер телефона
|-
|source
|Строка
|Адрес подачи
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
!colspan="3"|Необязательные параметры
|-
|dest
|Строка
|Адрес назначения
|-
|customer
|Строка
|Заказчик
|-
|comment
|Строка
|Комментарий
|-
|crew_group_id
|Целое
|ИД группы экипажей
|-
|uds_id
|Целое
|ИД службы ЕДС
|-
|tariff_id
|Целое
|ИД тарифа
|-
|is_prior
|true или false
|Предварительный заказ
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Заказ с такими параметрами уже создан
|-
|101
|Тариф не найден
|-
|102
|Группа экипажа не найдена
|-
|103
|Служба ЕДС не найдена
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|order_id
|Целое
|ИД созданного заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_order HTTP/1.1
Signature: <...>
Content-Type: application/x-www-form-urlencoded
Content-Length: 127
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

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"order_id":12345
}
}
</pre>

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

Метод: GET

Название запроса: calc_order_cost
{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|tariff_id
|Целое
|ИД тарифа
|-
Параметры:

!colspan="3"|Необязательные параметры
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|is_prior
|true или false
|Предварительный заказ
|-
|client_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»
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Тариф не найден
|-
|101
|Ошибка при расчете по тарифу
|-
|102
|Скидка не найдена
|-
|103
|Клиент не найден
|-
|104
|Район подачи не найден
|-
|105
|Район назначения не найден
|-
|106
|Дисконтная карта не найдена
|}

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

Пример:

<pre>
Запрос:

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

Ответ:

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

=== Запрос информации об экипаже ===
Метод: GET

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

Параметры:
{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|crew_id
|Целое
|ИД экипажа
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Экипаж не найден
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crew_id
|Целое
|ИД экипажа
|-
|code
|Строка
|Позывной экипажа
|-
|name
|Строка
|Наименование экипажа
|-
|driver_id
|Целое
|ИД водителя
|-
|car_id
|Целое
|ИД автомобиля
|-
|crew_group_id
|Целое
|ИД группы экипажа
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_crew_info?crew_id=1 HTTP/1.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
}
}
</pre>

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

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

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|driver_id
|Целое
|ИД водителя
|-
!colspan="3"|Необязательные параметры
|-
|need_photo
|true или false
|Нужна ли фотография водителя
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Водитель не найден
|}

Возвращаемые параметры в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|driver_id
|Целое
|ИД водителя
|-
|name
|Строка
|ФИО водителя
|-
|birthday
|ДД.ММ.ГГГГ
|День рождения водителя
|-
|car_id
|Целое
|ИД основного автомобиля водителя
|-
|license
|Строка
|Удостоверение водителя
|-
|home_phone
|Строка
|Домашний телефон водителя
|-
|mobile_phone
|Строка
|Мобильный телефон водителя
|-
|is_locked
|true или false
|Водитель заблокирован
|-
|is_dismissed
|true или false
|Водитель уволен
|-
|driver_photo
|Base64
|Фото водителя (только если need_photo = true)
|}

Пример:

<pre>
Запрос:

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",
"birthday":"01.01.1980",
"car_id":1,
"license":"1234567890",
"home_phone":"123456",
"mobile_phone":"+79123456789",
"is_locked":false,
"is_dismissed":false
}
}
</pre>

=== Запрос информации об автомобиле ===
Метод: GET

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

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|car_id
|Целое
|ИД автомобиля
|-
!colspan="3"|Необязательные параметры
|-
|need_photo
|true или false
|Нужна ли фотография автомобиля
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Автомобиль не найден
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|car_id
|Целое
|ИД автомобиля
|-
|name
|Строка
|Наименование автомобиля
|-
|code
|Строка
|Позывной автомобиля
|-
|gos_number
|Строка
|Государственный номер автомобиля
|-
|color
|Строка
|Цвет автомобиля
|-
|mark
|Строка
|Марка автомобиля
|-
|short_name
|Строка
|Краткое название автомобиля
|-
|production_year
|Целое
|Год выпуска автомобиля
|-
|car_photo
|Base64
|Фото автомобиля (только если need_photo = true)
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_car_info?car_id=1&need_photo=false HTTP/1.1
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
}
}
</pre>

=== Запрос координат экипажей ===
Метод: GET

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

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Необязательные параметры
|-
|crew_id
|Целое
|ИД экипажа, по которому нужно вернуть координаты. Если не задано, то будут возвращены координаты всех экипажей на линии.
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Координаты не найдены
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crews_coords
|Массив
|Список координат экипажей
|-
|• crew_id
|Целое
|ИД экипажа
|-
|• crew_code
|Строка
|Позывной экипажа
|-
|• coords_time
|ГГГГММДДччммсс
|Время получения координат
|-
|• lat
|Дробное
|Долгота
|-
|• lon
|Дробное
|Широта
|-
|• state_kind
|Строка
|Тип состояния экипажа. Может принимать значения:
• "not_available" — экипаж не на линии

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

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

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

Пример:

<pre>

Запрос:
GET https://ip:port/common_api/1.0/get_crews_coords HTTP/1.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"
},
{
"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 HTTP/1.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"
}
]
}
}
</pre>

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

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
! colspan="3"|Обязательные параметры
|-
|get_streets
|true или false
|Искать улицы
|-
|get_houses
|true или false
|Искать пункты
|-
|get_streets
|true или false
|Искать дома. Не может быть равно true, если get_streets = true или get_points = true.
|-
|street
|Строка
|Часть названия улицы или пункта, если идет поиск улиц или пунктов, или полное название улицы, если идет поиск домов
|-
!colspan="3"|Необязательные параметры
|-
|house
|Строка
|Часть номера дома. Нужно только если get_houses = true.
|-
|max_addresses_count
|Целое
|Максимальное количество адресов в ответе
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Подходящие адреса не найдены
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|addresses
|Массив
|Список подходящих адресов
|-
|• street
|Строка
|Название улицы или пункта
|-
|• house
|Строка
|Номер дома
|-
|• kind
|Строка
|Тип адреса. Может принимать значения:
• "street" — улица

• "house" — дом

• "point" — пункт
|-
|• comment
|Строка
|Комментарий
|}

Пример:

<pre>

Запрос:

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

Ответ:

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

Запрос:

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 HTTP/1.1
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":""
}
]
}
}
</pre>

=== Анализ маршрута ===
Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|source
|Строка
|Адрес подачи
|-
|dest
|Строка
|Адрес назначения
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Адрес подачи не распознан
|-
|101
|Адрес назначения не распознан
|-
|102
|Маршрут не распознан
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|source_lat
|Дробное
|Широта адреса подачи
|-
|source_lon
|Дробное
|Долгота адреса подачи
|-
|source_zone_id
|Целое
|ИД района подачи
|-
|dest_lat
|Дробное
|Широта адреса назначения
|-
|dest_lon
|Дробное
|Долгота адреса назначения
|-
|dest_zone_id
|Целое
|ИД района назначения
|-
|city_dist
|Дробное
|Километраж по городу
|-
|country_dist
|Дробное
|Километраж за городом
|-
|source_country_dist
|Дробное
|Километраж до адреса подачи, если адрес подачи за городом
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/analyze_route?source=STREET1,1&dest=STREET2,2 HTTP/1.1
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
}
}
</pre>

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

Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|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
|Целое
|ИД автомобиля
|-
|start_time
|ГГГГММДДччммсс
|Время создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|finish_time
|ГГГГММДДччммсс
|Время завершения заказа
|-
|source
|Строка
|Адрес подачи
|-
|destination
|Строка
|Адрес назначения
|-
|passenger
|Строка
|Пассажир
|-
|phone
|Строка
|Номер телефона
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_order_state?order_id=1 HTTP/1.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
"start_time":"17.01.2013 12:56:41",
"source_time":"17.01.2013 13:26:17",
"finish_time":"17.01.2013 13:03:43",
"source":"1",
"destination":"2",
"passenger":"Слепаков",
"phone":"8800"
}
}
</pre>

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

Метод: POST

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|phone
|Строка, <= 16 символов
|Номер телефона
|-
|message
|Строка
|Текст СМС
|}

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

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

Пример:

<pre>
Запрос:

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

Signature: <...>

message=SMSText&phone=89050057216

Ответ:

{
"code":0,
"descr":"OK",
"data":{}
}
</pre>

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

Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|login
|Строка, <= 60 символов
|Логин
|-
|password
|Строка, <= 60 символов
|Пароль
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент с логином LOGIN и/или неверный пароль
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|client_id
|Целое
|ИД клиента
|}

Пример:

<pre>
Запрос:

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

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"client_id":131
}
}
</pre>

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

Метод: POST

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

Параметры:

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

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

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Клиент с номером телефона=PHONE уже существует
|-
|101
|Клиент с логином=LOGIN уже существует
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|client_id
|Целое
|ИД созданного клиента
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_order HTTP/1.1

Signature: <...>

Content-Type: application/x-www-form-urlencoded

Content-Length: 127

name=NAME&phones=88,99&login=LOGIN&password=PASSWORD&birthday=19930218115517&gender=male&address=ADDRESS

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"client_id":140
}
}
</pre>

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

Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

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

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

• "female" - женский
|-
|birthday
|ДД.ММ.ГГГГ
|Дата рождения
|-
|phones
|Строка
|Номера телефонов (через запятую)
|-
|balance
|Дробное
|Баланс
|-
|login
|Строка
|Логин
|-
|password
|Строка
|Пароль
|}

Пример:

<pre>
Запрос:

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

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"client_id":140,
"name":"Васильев Артём",
"number":"000140",
"address":"Бутово,45",
"gender":"male",
"birthday":"18.02.1993",
"phones":"[\"88\",\"99\"]",
"balance":1467,
"login":"artem",
"password":"vasilev"
}
}
</pre>

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

Метод: POST

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

Параметры:

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

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

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Клиент с номером телефона=PHONE уже существует
|-
|101
|Клиент с логином=LOGIN уже существует

|}

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

Пример:

<pre>
Запрос:

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

client_id=140&name=NAME&phones=88,99&login=LOGIN&password=PASSWORD&birthday=19930218115517&gender=male&address=ADDRESS

Ответ:

{
"code":0,
"descr":"OK",
"data":{}
}
</pre>

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

Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента (может отсутствовать, если phone заполнен)
|-
|phone
|Строка, <= 16 символов
|Телефон клиента (может отсутствовать, если client_id заполнен)
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|id
|Целое
|ИД заказа
|-
|state_id
|Целое
|ИД состояния заказа
|-
|start_time
|ГГГГММДДччммсс
|Дата создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|source
|Строка
|Адрес подачи
|-
|destination
|Строка
|Адрес назначения
|-
|passenger
|Строка
|Пассажир
|-
|crew_id
|Целое
|ИД экипажа
|-
|prior_crew_id
|Целое
|ИД предварительного экипажа
|-
|driver_id
|Целое
|ИД водителя
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_current_orders?client_id=140&phone=18 HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"orders":[
{
"id":20648,
"state_id":44,
"start_time":"20130204181111",
"source_time":"20130204181111",
"source":"1-й пр-т \/Москва\/,",
"destination":"12-й мкр,",
"passenger":"маша",
"crew_id":0,
"prior_crew_id":0,
"driver_id":0
},
{
"id":20670,
"state_id":44,
"start_time":"20130207153022",
"source_time":"20130207153022",
"source":"11-й мкр,",
"destination":"1-й пр-т \/Москва\/,",
"passenger":"саша",
"crew_id":0,
"prior_crew_id":0,
"driver_id":0
}
]
}
}
</pre>

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

Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента (может отсутствовать, если phone заполнен)
|-
|phone
|Строка, <= 16 символов
|Телефон клиента (может отсутствовать, если client_id заполнен)
|-
|start_time
|ГГГГММДДччммсс
|Начало периода
|-
|finish_time
|ГГГГММДДччммсс
|Конец периода
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|id
|Целое
|ИД заказа
|-
|state_id
|Целое
|ИД состояния заказа
|-
|start_time
|ГГГГММДДччммсс
|Время создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|finish_time
|ГГГГММДДччммсс
|Время завершения заказа
|-
|source
|Строка
|Адрес подачи
|-
|destination
|Строка
|Адрес назначения
|-
|passenger
|Строка
|Пассажир
|-
|sum
|Дробное
|Стоимость заказа без учета скидок(наценок)
|-
|crew_id
|Целое
|ИД экипажа
|-
|prior_crew_id
|Целое
|ИД предварительного экипажа
|-
|driver_id
|Целое
|ИД водителя
|-
|car_id
|Целое
|ИД автомобиля
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_finished_orders?client_id=140&phone= HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"orders":[
{
"id":20651,
"state_id":34,
"source_time":"20130205110812",
"start_time":"20130205110812",
"finish_time":"20130205115618",
"source":"прпроп",
"destination":"рррррр",
"passenger":"вера",
"sum":"908",
"crew_id":"6",
"prior_crew_id":0,
"driver_id":"4",
"car_id":"6"
},
{
"id":20669,
"state_id":34,
"source_time":"20130205130500",
"start_time":"20130205130500",
"finish_time":"20130205134511",
"source":"1",
"destination":"2",
"passenger":"маша",
"sum":"454",
"crew_id":"6",
"prior_crew_id":0,
"driver_id":"4",
"car_id":"6"
}
]
}
}
</pre>

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

Метод: POST

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента
|-
|oper_time
|ГГГГММДДччммсс
|Время создания операции
|-
|sum
|Дробное
|Сумма
|-
|oper_type
|Целое
|Тип операции:
• "receipt" - приход

• "expense" - расход
|-
|pay_type
|Целое
|Тип оплаты:
• "cash" - наличный

• "nocash" - безналичный
|-
!colspan="3"|Необязательные параметры
|-
|comment
|Строка
|Комментарий
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|oper_id
|Целое
|ИД операции
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_client_operation HTTP/1.1

Signature: <...>

Content-Type: application/x-www-form-urlencoded

Content-Length: 127

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

Ответ:

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

}
}
</pre>

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

Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента (может отсутствовать, если phone заполнен)
|-
|phone
|Целое
|Телефон клиента (может отсутствовать, если client_id заполнен)
|-
|start_time
|ГГГГММДДччммсс
|Начало периода
|-
|finish_time
|ГГГГММДДччммсс
|Конец периода
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|oper_id
|Целое
|ИД операции
|-
|oper_time
|ГГГГММДДччммсс
|Время создания операции
|-
|sum
|Дробное
|Сумма
|-
|order_id
|Целое
|Заказ, связанный с операцией
|-
|oper_type
|Целое
|Тип операции:
• "receipt" - приход
• "expense" - расход
|-
|pay_type
|Целое
|Тип оплаты:
• "cash" - наличный
• "nocash" - безналичный
|}

Пример:

<pre>
Запрос:

GET

https://ip:port/common_api/1.0/get_client_operations?client_id=112&start_time=20130201092112&finish_time=20130221092112 HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"operations":[
{
"oper_id":112,
"oper_time":"20130219091328",
"sum":"21,8",
"order_id":11800,
"oper_type":"receipt",
"pay_type":"cash",
"comment":"jgznm"
},
{
"oper_id":112,
"oper_time":"20130220112245",
"sum":"4500",
"order_id":11801,
"oper_type":"receipt",
"pay_type":"cash",
"comment":"блин"
}
]
}
}
</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 HTTP/1.1
</pre>

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

Пример:

<pre>
GET https://ip:port/tm_tapi/1.0/get_info_by_phone?phone=89058800565&fields=PHONE_TYPEPHONE_
TO_DIAL&signature=661ce071eeefcb4f7fc8bc1f17bd520b HTTP/1.1
</pre>

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

Пример:

<pre>
POST https://ip:port/tm_tapi/1.0/change_order_state HTTP/1.1
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 HTTP/1.1

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

Signature = MD5("phone=89058800565&fields=PHONE_TYPE" + "321") = ef17ea682d09e452af544a5758dba396
HTTP/1.1
</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 - если звонит номер из справочника телефоны; 0 - неизвестный номер)
|-
|PHONE_TO_DIAL
|Строка, <= 16 символов
|Номер телефона для отзвона по заказу
|-
|CREW_ID
|Целое
|ИД экипажа
|-
|IS_PRIOR
|true или false
|Признак предварительного заказа
|-
|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
|Целое
|ИД группы экипажа
|-
|CLIENT_BALANCE
|Дробное
|Баланс клиента
|-
|DRIVER_TIMECOUNT
|Целое
|Время пути водителя до адреса подачи в минутах
|-
|SOURCE_TIMECOUNT
|Целое
|Время оставшееся до подачи в минутах
|-
|SOUND_COLOR
|Строка
|Запись с информацией о цвете
|-
|SOUND_GOSNUMBER
|Строка
|Запись с информацией о государственном номере автомобиля
|-
|SOUND_MARK
|Строка
|Запись с информацией о марке автомобиля
|-
|GOSNUMBER
|Строка
|Государственный номер автомобиля
|-
|CAR_COLOR
|Строка
|Цвет автомобиля
|-
|CAR_MARK
|Строка
|Марка автомобиля
|-
|ORDER_COORDS
|Строка
|Координаты места подачи
|-
|CREW_COORDS
|Строка
|Координаты назначенного экипажа
|}

Пример:

<pre>
Запрос:
GET https://ip:port/tm_tapi/1.0/get_info_by_phone?phone=89058800565l&fields=PHONE_TYPEPHONE_
TO_DIAL-CREW_ID-ORDER_ID&signature=d35ab2765f2968d48c096d5f5327db26 HTTP/1.1

Ответ:

<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>
</data>
</response>
</pre>

==== Запрос информации по ИД заказа ====

Метод: GET
Название запроса: get_info_by_order_id
Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|-
|fields
|Строка
|Список полей, которые необходимо вернуть. Поля перечисляются через ''-''
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

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

{|
!Параметр
!Тип
!Описание
|-
|DRIVER_TIMECOUNT
|Строка, <= 16 символов
|Время до подачи в минутах, указанное водителем
|-
|SOUND_COLOR
|Строка
|Запись с информацией о цвете
|-
|CAR_MARK
|Строка
|Марка автомобиля
|-
|CAR_COLOR
|Строка
|Цвет автомобиля
|-
|GOSNUMBER
|Строка
|Государственный номер автомобиля
|-
|SOUND_MARK
|Строка
|Запись с информацией о марке автомобиля
|-
|CREW_GROUP_ID
|Целое
|ИД группы экипажа
|-
|IS_PRIOR
|true или false
|Признак предварительного заказа
|-
|DISCOUNTEDSUMM
|Строка
|Сумма заказа с учетом всех скидок
|-
|DRIVER_PHONE
|Строка, <= 16 символов
|Номер телефона водителя
|-
|CATEGORYID
|Целое
|ИД категории телефона
|-
|SOURCE_TIMECOUNT
|Целое
|Время до подачи в минутах
|-
|ORDER_COORDS
|Строка
|Координаты места подачи
|-
|CREW_COORDS
|Строка
|Координаты назначенного экипажа
|-
|ORDER_STATE
|Целое
|ИД состояния заказа
|}

Пример:

<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
HTTP/1.1

Ответ:

<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></SOURCE_TIME>
</data>
</response>
</pre>

==== Смена состояния заказа ====
Метод: POST

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

Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|-
|need_state
|Целое
|Новое состояние заказа
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

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

{|
!Код
!Описание
|-
|100
|Заказ с таким ИД не найден.
|-
|101
|Изменение состояния не соответствует необходимым условиям.
|}

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

{|
!Параметр
!Тип
!Описание
|-
|ORDER_ID
|Целое
|ИД созданного заказа
|-
|NEW_STATE
|Целое
|Новое состояние заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/tm_tapi/1.0/change_order_state HTTP/1.1
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"|Обязательные параметры
|-
|RECORD_DATE
|ГГГГММДДччммсс
|Дата записи
|-
|RECORD_LENGTH
|Целое
|Продолжительность записи (в секундах)
|-
|PHONE
|Строка, <= 16 символов
|Номер телефона
|-
|FILE_PATH
|Строка,<=255 символов
|Путь к файлу записи
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Заказ по такому номеру телефона не найден.
|}

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

{|
!Параметр
!Тип
!Описание
|-
|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: 171
RECORD_DATE=20130122180949&RECORD_LENGTH=215&PHONE=8987564&FILE_PATH=d%3A%5Ctemp%5CTM%5Ctrunk
%5CSource%5CDevUtils%5CTMAPITest%5C&signature=56851c4e8d2d4bb9ba615615f76ad7f7

Ответ:
<response>
<code>0</code>
<descr>OK</descr>
<data>
<RECORD_ID>25</RECORD_ID>
</data>
</response>
</pre>

==== Создать новый заказ ====

Метод: POST

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

Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|PHONE
|Строка, <= 16 символов
|Номер телефона
|-
|ORDER_STATE_ID
|Целое
|ИД состояния заказа
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|-
|colspan="3"|Необязательные параметры
|-
|CREW_GROUP_ID
|Целое
|ИД группы экипажа
|-
|TARIFF_ID
|Целое
|ИД тарифа
|-
|PHONE_PREFIX
|Строка
|Префикс, отрезаемый от номера телефона при поиске в базе данных. Для входящих звонков это код города с префиксом входящих номеров, обычно "8". Например, "83412"
|-
|DISCOUNTED_SU MM
|Строка
|Фиксированная сумма за заказ
|}

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

{|
!Код
!Описание
|-
|100
|Клиент не найден
|}

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

{|
!Параметр
!Тип
!Описание
|-
|ORDER_ID
|Целое
|ИД созданного заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/tm_tapi/1.0/make_new_order HTTP/1.1
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>
</pre>

== Пример формы для заказа такси ==
{{url|{{корень FTP|forms/zakaz_taxi.zip}}}}

Данная форма является примером, на основе которого можно построить собственную форму для принятия интернет-заказов. Форму можно использовать либо в исходном варианте, либо применяя запросы [[TM API#Описание запросов|TM API]].
Для того, чтобы данная форма функционировала, необходимо открыть файл в любом текстовом редакторе и указать корректные IP-адрес [[Сервер Такси-Мастер|сервера Такси-Мастер]], порт [[TM API#Параметры TM API|TM API]] и секретный ключ. Далее вам следует загрузить файл на хостинг.

Именно так будет выглядеть данная форма для заказа такси.
{{картинка|Форма для заказа такси.jpg}}

[[Категория:ТМ2]]

TM API

2013-10-02T07:17:59Z

AnnaNikolskih: /* Запись пути к файлу разговора в базу данных */

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

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

# Создать механизм приема заказов через интернет.
# Сделать ваш сайт более информативным: публиковать полезную для клиентов информацию прямо из системы - список ближайших [[Справочник «Экипажи»|экипажей]], предварительный расчет стоимости поездки, мониторинг движения автомобиля такси в процессе выполнения [[заказ]]а, [[Модуль «Интеграция с картами»|карты города]] и контактную информацию.
# Расширить возможности своей службы за счет популярного онлайн-сервиса Яндекс Такси.

== Параметры TM API ==
Задать настройки для корректной работы TM API вы сможете в программе [[Такси-Мастер]] в меню {{tab|Настройки}} в одноименной ветке {{tab|TM API}}.
Параметры организуют и контролируют работу [[Модуль «Интернет-заказы»|модуля «Интернет-заказы»]].
# Установите флажок {{checkbox|Использовать TM API}}, чтобы приступить к его использованию.
# В поле {{поле|Локальный порт}} введите номер порта подключения к интернету, на котором работает и будет ожидать запросы о новых заказах [[TMServer]]. Рекомендуется оставить номер порта по умолчанию.
# Установите флажок {{checkbox|Можно использовать данное рабочее место TMServer для распознавания адресов}} для того, чтобы конкретно с данного рабочего места происходило распознавание адресов модулем "Интернет-заказы".
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

=== Ветка «Открытое API» ===
В данной ветке регулируется доступ к синхронизации Такси-Мастер со сторонним сервисом (сайтом), с помощью которого клиенты будут создавать интернет-заказы. С примером кода для работы вы можете ознакомиться в данной статье в разделе [[TM API#Общее описание протокола|Общее описание протокола]].
# Установите флажок {{checkbox|Использовать открытое API}} для того, чтобы запустить работу по обслуживанию модуля «Интернет-заказы». При установленном флажке сервер [[Модуль «Интернет-заказы»|модуля «Интернет-заказы»]] запускается и ожидает запросы о новых заказах.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы с модулем «Интернет-заказы», который будет выслан вам в письме от менеджера.
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

=== Ветка «API для телефонии» ===
В данной ветке регулируются настройки API для телефонии, т.е. взаимодействие [[Такси-Мастер]] с call-центром через программный интерфейс. С его помощью [[Call-центр Oktell|call-центр]] может дать команду Такси-Мастер создать [[зака]]з или запросить информацию о [[Справочник «Состояния заказа»|статусе текущего заказа]].
# Установите флажок {{checkbox|Использовать открытое API для телефонии}} для того, чтобы запустить работу по обслуживанию телефонии через API.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы.
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

=== Ветка «Платежные терминалы» ===
{{info|Ранее для связи [[Модуль интеграции с платежными системами|платежных систем]] и [[Такси-Мастер]] служила такая утилита, как TMWeb. В данный момент мы отказались от ее использования, а функции были распределены между двумя компонентами системы: TM API и [[TMServer]].}}

Параметры этой ветки отвечают за работу [[Модуль интеграции с платежными терминалами|модуля интеграции с платежными системами]].
# Установите флажок {{checkbox|Включить прием терминальных платежей}}. Данная функция позволит отображать все платежные операции по приходу средств от водителей через терминалы в [[База данных Такси-Мастер 2|базе данных]] программы.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы с платежными системами и сверки платежей, который будет выслан вам в письме от менеджера. Секретный ключ - это определенный набор символов, необходимый для формирования подписи при передаче информации о платеже.
# В полях {{поле|Логин}} и {{поле|Пароль}} введите данные учетной записи на сайте http://term.bitmaster.ru.
# Кнопка {{кнопка|Задать всем водителям терминальный аккаунт по их ИД}} служит для соединения TM API с сервером Такси-Мастер. В результате соединения записи о терминальных аккаунтах генерируются, заносятся (для тех водителей, у которых они отсутствуют) и обновляются (для тех водителей, у которых уже существуют терминальные аккаунты) в Такси-Мастер.
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

{{info|Обратите внимание, что для платежных систем также существует открытый и свободно распространяемый API, с помощью которого есть возможность связать [[Такси-Мастер]] и [[Модуль интеграции с платежными системами|платежные системы]]. Обратитесь в отдел дополнительных услуг, написав на {{ящик ОДУ}}, за получением кода для данного компонента системы.}}

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

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

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

<pre>
GET https://ip:port/common_api/1.0/get_crew_groups_list HTTP/1.1
</pre>

Для получения данных из БД используются запросы типа GET. Для записи данных в [[База данных Такси-Мастер|базу данных]] используются запросы типа POST. В запросе типа GET параметры запроса передаются в URI. Пример:
<pre>
GET https://ip:port/common_api/1.0/calc_order_cost?tariff_id=1&distance_city=10 HTTP/1.1
Signature: <...>
</pre>

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

<pre>
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
</pre>

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

<pre>
Запрос:
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
</pre>

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

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

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

Существуют общие для всех запросов коды результатов:
{|
! Код
! Описание
|-
|0
|Успешное выполнение запроса
|-
|1
|Неизвестная ошибка
|-
|2
|Неизвестный тип API
|-
|3
|API отключено в настройках TMWeb
|-
|4
|Не совпадает секретный ключ
|-
|5
|Неподдерживаемая версия API
|-
|6
|Неизвестное название запроса
|-
|7
|Неверный тип запроса GET/POST
|-
|8
|Не хватает входного параметра (в доп. информации ответа будет название отсутствующего параметра)
|-
|9
|Некорректный входной параметр (в доп. информации ответа будет название некорректного параметра)
|-
|10
|Внутренняя ошибка обработки запроса
|}

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

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

Метод: GET или POST

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

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

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

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

Пример:

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

=== Запрос списка групп экипажей ===
Метод: GET

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

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

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

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crew_groups
|Массив
|Список групп экипажей
|-
|• id
|Целое
|ИД группы экипажей
|-
|• name
|Строка
|Название группы экипажей
|}

Пример:

<pre>
Запрос:

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

Ответ:

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

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

Метод: GET

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

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

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

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

{|
!Параметр
!Тип
!Описание
|-
|uds
|Массив
|Список служб [[Модуль «Единая диспетчерская служба»|ЕДС]]
|-
|• id
|Целое
|ИД службы [[Модуль «Единая диспетчерская служба»|ЕДС]]
|-
|• name
|Строка
|Название службы [[Модуль «Единая диспетчерская служба»|ЕДС]]
|}

Пример:

<pre>
Запрос:

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

Ответ:

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

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

Метод: GET

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

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

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

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

{|
!Параметр
!Тип
!Описание
|-
|tariffs
|Массив
|Список [[Справочник «Тарифы»|тарифов]]
|-
|• id
|Целое
|ИД [[Справочник «Тарифы»|тарифа]]
|-
|• name
|Строка
|Название [[Справочник «Тарифы»|тарифа]]
|-
|• is_active
|true или false
|Активный [[Справочник «Тарифы»|тариф]]
|}

Пример:

<pre>
Запрос:

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

Ответ:

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

=== Запрос списка услуг ===
Метод: GET

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

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

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

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

{|
!Параметр
!Тип
!Описание
|-
|services
|Массив
|Список [[Справочник «Услуги»|услуг]]
|-
|• id
|Целое
|ИД [[Справочник «Услуги»|услуги]]
|-
|• name
|Строка
|Название [[Справочник «Услуги»|услуги]]
|-
|• sum
|Дробное
|Абсолютная сумма [[Справочник «Услуги»|услуги]], руб
|-
|• percent
|Дробное
|Процент [[Справочник «Услуги»|услуги]] от стоимости заказа, %
|}

Пример:

<pre>
Запрос:

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

Ответ:

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

=== Запрос списка скидок ===
Метод: GET

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

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

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

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

{|
!Параметр
!Тип
!Описание
|-
|discounts
|Массив
|Список [[Справочник «Скидки клиентов»|скидок]]
|-
|• id
|Целое
|ИД [[Справочник «Скидки клиентов»|скидки]]
|-
|• name
|Строка
|Название [[Справочник «Скидки клиентов»|скидки]]
|-
|• sum
|Дробное
|Абсолютная сумма [[Справочник «Скидки клиентов»|скидки]], руб
|-
|• percent
|Дробное
|Процент [[Справочник «Скидки клиентов»|скидки]] от стоимости заказа, %
|}

Пример:

<pre>
Запрос:

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

Ответ:

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

=== Создание нового заказа ===
Метод: POST

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

Параметры:

{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|phone
|Строка, <= 16 символов
|Номер телефона
|-
|source
|Строка
|Адрес подачи
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
!colspan="3"|Необязательные параметры
|-
|dest
|Строка
|Адрес назначения
|-
|customer
|Строка
|Заказчик
|-
|comment
|Строка
|Комментарий
|-
|crew_group_id
|Целое
|ИД группы экипажей
|-
|uds_id
|Целое
|ИД службы ЕДС
|-
|tariff_id
|Целое
|ИД тарифа
|-
|is_prior
|true или false
|Предварительный заказ
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Заказ с такими параметрами уже создан
|-
|101
|Тариф не найден
|-
|102
|Группа экипажа не найдена
|-
|103
|Служба ЕДС не найдена
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|order_id
|Целое
|ИД созданного заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_order HTTP/1.1
Signature: <...>
Content-Type: application/x-www-form-urlencoded
Content-Length: 127
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

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"order_id":12345
}
}
</pre>

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

Метод: GET

Название запроса: calc_order_cost
{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|tariff_id
|Целое
|ИД тарифа
|-
Параметры:

!colspan="3"|Необязательные параметры
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|is_prior
|true или false
|Предварительный заказ
|-
|client_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»
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Тариф не найден
|-
|101
|Ошибка при расчете по тарифу
|-
|102
|Скидка не найдена
|-
|103
|Клиент не найден
|-
|104
|Район подачи не найден
|-
|105
|Район назначения не найден
|-
|106
|Дисконтная карта не найдена
|}

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

Пример:

<pre>
Запрос:

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

Ответ:

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

=== Запрос информации об экипаже ===
Метод: GET

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

Параметры:
{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|crew_id
|Целое
|ИД экипажа
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Экипаж не найден
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crew_id
|Целое
|ИД экипажа
|-
|code
|Строка
|Позывной экипажа
|-
|name
|Строка
|Наименование экипажа
|-
|driver_id
|Целое
|ИД водителя
|-
|car_id
|Целое
|ИД автомобиля
|-
|crew_group_id
|Целое
|ИД группы экипажа
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_crew_info?crew_id=1 HTTP/1.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
}
}
</pre>

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

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

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|driver_id
|Целое
|ИД водителя
|-
!colspan="3"|Необязательные параметры
|-
|need_photo
|true или false
|Нужна ли фотография водителя
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Водитель не найден
|}

Возвращаемые параметры в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|driver_id
|Целое
|ИД водителя
|-
|name
|Строка
|ФИО водителя
|-
|birthday
|ДД.ММ.ГГГГ
|День рождения водителя
|-
|car_id
|Целое
|ИД основного автомобиля водителя
|-
|license
|Строка
|Удостоверение водителя
|-
|home_phone
|Строка
|Домашний телефон водителя
|-
|mobile_phone
|Строка
|Мобильный телефон водителя
|-
|is_locked
|true или false
|Водитель заблокирован
|-
|is_dismissed
|true или false
|Водитель уволен
|-
|driver_photo
|Base64
|Фото водителя (только если need_photo = true)
|}

Пример:

<pre>
Запрос:

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",
"birthday":"01.01.1980",
"car_id":1,
"license":"1234567890",
"home_phone":"123456",
"mobile_phone":"+79123456789",
"is_locked":false,
"is_dismissed":false
}
}
</pre>

=== Запрос информации об автомобиле ===
Метод: GET

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

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|car_id
|Целое
|ИД автомобиля
|-
!colspan="3"|Необязательные параметры
|-
|need_photo
|true или false
|Нужна ли фотография автомобиля
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Автомобиль не найден
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|car_id
|Целое
|ИД автомобиля
|-
|name
|Строка
|Наименование автомобиля
|-
|code
|Строка
|Позывной автомобиля
|-
|gos_number
|Строка
|Государственный номер автомобиля
|-
|color
|Строка
|Цвет автомобиля
|-
|mark
|Строка
|Марка автомобиля
|-
|short_name
|Строка
|Краткое название автомобиля
|-
|production_year
|Целое
|Год выпуска автомобиля
|-
|car_photo
|Base64
|Фото автомобиля (только если need_photo = true)
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_car_info?car_id=1&need_photo=false HTTP/1.1
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
}
}
</pre>

=== Запрос координат экипажей ===
Метод: GET

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

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Необязательные параметры
|-
|crew_id
|Целое
|ИД экипажа, по которому нужно вернуть координаты. Если не задано, то будут возвращены координаты всех экипажей на линии.
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Координаты не найдены
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crews_coords
|Массив
|Список координат экипажей
|-
|• crew_id
|Целое
|ИД экипажа
|-
|• crew_code
|Строка
|Позывной экипажа
|-
|• coords_time
|ГГГГММДДччммсс
|Время получения координат
|-
|• lat
|Дробное
|Долгота
|-
|• lon
|Дробное
|Широта
|-
|• state_kind
|Строка
|Тип состояния экипажа. Может принимать значения:
• "not_available" — экипаж не на линии

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

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

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

Пример:

<pre>

Запрос:
GET https://ip:port/common_api/1.0/get_crews_coords HTTP/1.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"
},
{
"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 HTTP/1.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"
}
]
}
}
</pre>

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

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
! colspan="3"|Обязательные параметры
|-
|get_streets
|true или false
|Искать улицы
|-
|get_houses
|true или false
|Искать пункты
|-
|get_streets
|true или false
|Искать дома. Не может быть равно true, если get_streets = true или get_points = true.
|-
|street
|Строка
|Часть названия улицы или пункта, если идет поиск улиц или пунктов, или полное название улицы, если идет поиск домов
|-
!colspan="3"|Необязательные параметры
|-
|house
|Строка
|Часть номера дома. Нужно только если get_houses = true.
|-
|max_addresses_count
|Целое
|Максимальное количество адресов в ответе
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Подходящие адреса не найдены
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|addresses
|Массив
|Список подходящих адресов
|-
|• street
|Строка
|Название улицы или пункта
|-
|• house
|Строка
|Номер дома
|-
|• kind
|Строка
|Тип адреса. Может принимать значения:
• "street" — улица

• "house" — дом

• "point" — пункт
|-
|• comment
|Строка
|Комментарий
|}

Пример:

<pre>

Запрос:

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

Ответ:

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

Запрос:

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 HTTP/1.1
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":""
}
]
}
}
</pre>

=== Анализ маршрута ===
Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|source
|Строка
|Адрес подачи
|-
|dest
|Строка
|Адрес назначения
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Адрес подачи не распознан
|-
|101
|Адрес назначения не распознан
|-
|102
|Маршрут не распознан
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|source_lat
|Дробное
|Широта адреса подачи
|-
|source_lon
|Дробное
|Долгота адреса подачи
|-
|source_zone_id
|Целое
|ИД района подачи
|-
|dest_lat
|Дробное
|Широта адреса назначения
|-
|dest_lon
|Дробное
|Долгота адреса назначения
|-
|dest_zone_id
|Целое
|ИД района назначения
|-
|city_dist
|Дробное
|Километраж по городу
|-
|country_dist
|Дробное
|Километраж за городом
|-
|source_country_dist
|Дробное
|Километраж до адреса подачи, если адрес подачи за городом
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/analyze_route?source=STREET1,1&dest=STREET2,2 HTTP/1.1
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
}
}
</pre>

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

Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|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
|Целое
|ИД автомобиля
|-
|start_time
|ГГГГММДДччммсс
|Время создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|finish_time
|ГГГГММДДччммсс
|Время завершения заказа
|-
|source
|Строка
|Адрес подачи
|-
|destination
|Строка
|Адрес назначения
|-
|passenger
|Строка
|Пассажир
|-
|phone
|Строка
|Номер телефона
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_order_state?order_id=1 HTTP/1.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
"start_time":"17.01.2013 12:56:41",
"source_time":"17.01.2013 13:26:17",
"finish_time":"17.01.2013 13:03:43",
"source":"1",
"destination":"2",
"passenger":"Слепаков",
"phone":"8800"
}
}
</pre>

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

Метод: POST

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|phone
|Строка, <= 16 символов
|Номер телефона
|-
|message
|Строка
|Текст СМС
|}

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

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

Пример:

<pre>
Запрос:

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

Signature: <...>

message=SMSText&phone=89050057216

Ответ:

{
"code":0,
"descr":"OK",
"data":{}
}
</pre>

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

Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|login
|Строка, <= 60 символов
|Логин
|-
|password
|Строка, <= 60 символов
|Пароль
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент с логином LOGIN и/или неверный пароль
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|client_id
|Целое
|ИД клиента
|}

Пример:

<pre>
Запрос:

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

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"client_id":131
}
}
</pre>

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

Метод: POST

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

Параметры:

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

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

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Клиент с номером телефона=PHONE уже существует
|-
|101
|Клиент с логином=LOGIN уже существует
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|client_id
|Целое
|ИД созданного клиента
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_order HTTP/1.1

Signature: <...>

Content-Type: application/x-www-form-urlencoded

Content-Length: 127

name=NAME&phones=88,99&login=LOGIN&password=PASSWORD&birthday=19930218115517&gender=male&address=ADDRESS

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"client_id":140
}
}
</pre>

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

Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

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

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

• "female" - женский
|-
|birthday
|ДД.ММ.ГГГГ
|Дата рождения
|-
|phones
|Строка
|Номера телефонов (через запятую)
|-
|balance
|Дробное
|Баланс
|-
|login
|Строка
|Логин
|-
|password
|Строка
|Пароль
|}

Пример:

<pre>
Запрос:

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

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"client_id":140,
"name":"Васильев Артём",
"number":"000140",
"address":"Бутово,45",
"gender":"male",
"birthday":"18.02.1993",
"phones":"[\"88\",\"99\"]",
"balance":1467,
"login":"artem",
"password":"vasilev"
}
}
</pre>

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

Метод: POST

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

Параметры:

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

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

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Клиент с номером телефона=PHONE уже существует
|-
|101
|Клиент с логином=LOGIN уже существует

|}

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

Пример:

<pre>
Запрос:

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

client_id=140&name=NAME&phones=88,99&login=LOGIN&password=PASSWORD&birthday=19930218115517&gender=male&address=ADDRESS

Ответ:

{
"code":0,
"descr":"OK",
"data":{}
}
</pre>

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

Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента (может отсутствовать, если phone заполнен)
|-
|phone
|Строка, <= 16 символов
|Телефон клиента (может отсутствовать, если client_id заполнен)
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|id
|Целое
|ИД заказа
|-
|state_id
|Целое
|ИД состояния заказа
|-
|start_time
|ГГГГММДДччммсс
|Дата создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|source
|Строка
|Адрес подачи
|-
|destination
|Строка
|Адрес назначения
|-
|passenger
|Строка
|Пассажир
|-
|crew_id
|Целое
|ИД экипажа
|-
|prior_crew_id
|Целое
|ИД предварительного экипажа
|-
|driver_id
|Целое
|ИД водителя
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_current_orders?client_id=140&phone=18 HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"orders":[
{
"id":20648,
"state_id":44,
"start_time":"20130204181111",
"source_time":"20130204181111",
"source":"1-й пр-т \/Москва\/,",
"destination":"12-й мкр,",
"passenger":"маша",
"crew_id":0,
"prior_crew_id":0,
"driver_id":0
},
{
"id":20670,
"state_id":44,
"start_time":"20130207153022",
"source_time":"20130207153022",
"source":"11-й мкр,",
"destination":"1-й пр-т \/Москва\/,",
"passenger":"саша",
"crew_id":0,
"prior_crew_id":0,
"driver_id":0
}
]
}
}
</pre>

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

Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента (может отсутствовать, если phone заполнен)
|-
|phone
|Строка, <= 16 символов
|Телефон клиента (может отсутствовать, если client_id заполнен)
|-
|start_time
|ГГГГММДДччммсс
|Начало периода
|-
|finish_time
|ГГГГММДДччммсс
|Конец периода
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|id
|Целое
|ИД заказа
|-
|state_id
|Целое
|ИД состояния заказа
|-
|start_time
|ГГГГММДДччммсс
|Время создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|finish_time
|ГГГГММДДччммсс
|Время завершения заказа
|-
|source
|Строка
|Адрес подачи
|-
|destination
|Строка
|Адрес назначения
|-
|passenger
|Строка
|Пассажир
|-
|sum
|Дробное
|Стоимость заказа без учета скидок(наценок)
|-
|crew_id
|Целое
|ИД экипажа
|-
|prior_crew_id
|Целое
|ИД предварительного экипажа
|-
|driver_id
|Целое
|ИД водителя
|-
|car_id
|Целое
|ИД автомобиля
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_finished_orders?client_id=140&phone= HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"orders":[
{
"id":20651,
"state_id":34,
"source_time":"20130205110812",
"start_time":"20130205110812",
"finish_time":"20130205115618",
"source":"прпроп",
"destination":"рррррр",
"passenger":"вера",
"sum":"908",
"crew_id":"6",
"prior_crew_id":0,
"driver_id":"4",
"car_id":"6"
},
{
"id":20669,
"state_id":34,
"source_time":"20130205130500",
"start_time":"20130205130500",
"finish_time":"20130205134511",
"source":"1",
"destination":"2",
"passenger":"маша",
"sum":"454",
"crew_id":"6",
"prior_crew_id":0,
"driver_id":"4",
"car_id":"6"
}
]
}
}
</pre>

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

Метод: POST

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента
|-
|oper_time
|ГГГГММДДччммсс
|Время создания операции
|-
|sum
|Дробное
|Сумма
|-
|oper_type
|Целое
|Тип операции:
• "receipt" - приход

• "expense" - расход
|-
|pay_type
|Целое
|Тип оплаты:
• "cash" - наличный

• "nocash" - безналичный
|-
!colspan="3"|Необязательные параметры
|-
|comment
|Строка
|Комментарий
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|oper_id
|Целое
|ИД операции
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_client_operation HTTP/1.1

Signature: <...>

Content-Type: application/x-www-form-urlencoded

Content-Length: 127

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

Ответ:

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

}
}
</pre>

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

Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента (может отсутствовать, если phone заполнен)
|-
|phone
|Целое
|Телефон клиента (может отсутствовать, если client_id заполнен)
|-
|start_time
|ГГГГММДДччммсс
|Начало периода
|-
|finish_time
|ГГГГММДДччммсс
|Конец периода
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|oper_id
|Целое
|ИД операции
|-
|oper_time
|ГГГГММДДччммсс
|Время создания операции
|-
|sum
|Дробное
|Сумма
|-
|order_id
|Целое
|Заказ, связанный с операцией
|-
|oper_type
|Целое
|Тип операции:
• "receipt" - приход
• "expense" - расход
|-
|pay_type
|Целое
|Тип оплаты:
• "cash" - наличный
• "nocash" - безналичный
|}

Пример:

<pre>
Запрос:

GET

https://ip:port/common_api/1.0/get_client_operations?client_id=112&start_time=20130201092112&finish_time=20130221092112 HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"operations":[
{
"oper_id":112,
"oper_time":"20130219091328",
"sum":"21,8",
"order_id":11800,
"oper_type":"receipt",
"pay_type":"cash",
"comment":"jgznm"
},
{
"oper_id":112,
"oper_time":"20130220112245",
"sum":"4500",
"order_id":11801,
"oper_type":"receipt",
"pay_type":"cash",
"comment":"блин"
}
]
}
}
</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 HTTP/1.1
</pre>

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

Пример:

<pre>
GET https://ip:port/tm_tapi/1.0/get_info_by_phone?phone=89058800565&fields=PHONE_TYPEPHONE_
TO_DIAL&signature=661ce071eeefcb4f7fc8bc1f17bd520b HTTP/1.1
</pre>

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

Пример:

<pre>
POST https://ip:port/tm_tapi/1.0/change_order_state HTTP/1.1
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 HTTP/1.1

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

Signature = MD5("phone=89058800565&fields=PHONE_TYPE" + "321") = ef17ea682d09e452af544a5758dba396
HTTP/1.1
</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 - если звонит номер из справочника телефоны; 0 - неизвестный номер)
|-
|PHONE_TO_DIAL
|Строка, <= 16 символов
|Номер телефона для отзвона по заказу
|-
|CREW_ID
|Целое
|ИД экипажа
|-
|IS_PRIOR
|true или false
|Признак предварительного заказа
|-
|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
|Целое
|ИД группы экипажа
|-
|CLIENT_BALANCE
|Дробное
|Баланс клиента
|-
|DRIVER_TIMECOUNT
|Целое
|Время пути водителя до адреса подачи в минутах
|-
|SOURCE_TIMECOUNT
|Целое
|Время оставшееся до подачи в минутах
|-
|SOUND_COLOR
|Строка
|Запись с информацией о цвете
|-
|SOUND_GOSNUMBER
|Строка
|Запись с информацией о государственном номере автомобиля
|-
|SOUND_MARK
|Строка
|Запись с информацией о марке автомобиля
|-
|GOSNUMBER
|Строка
|Государственный номер автомобиля
|-
|CAR_COLOR
|Строка
|Цвет автомобиля
|-
|CAR_MARK
|Строка
|Марка автомобиля
|-
|ORDER_COORDS
|Строка
|Координаты места подачи
|-
|CREW_COORDS
|Строка
|Координаты назначенного экипажа
|}

Пример:

<pre>
Запрос:
GET https://ip:port/tm_tapi/1.0/get_info_by_phone?phone=89058800565l&fields=PHONE_TYPEPHONE_
TO_DIAL-CREW_ID-ORDER_ID&signature=d35ab2765f2968d48c096d5f5327db26 HTTP/1.1

Ответ:

<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>
</data>
</response>
</pre>

==== Запрос информации по ИД заказа ====

Метод: GET
Название запроса: get_info_by_order_id
Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|-
|fields
|Строка
|Список полей, которые необходимо вернуть. Поля перечисляются через ''-''
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

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

{|
!Параметр
!Тип
!Описание
|-
|DRIVER_TIMECOUNT
|Строка, <= 16 символов
|Время до подачи в минутах, указанное водителем
|-
|SOUND_COLOR
|Строка
|Запись с информацией о цвете
|-
|CAR_MARK
|Строка
|Марка автомобиля
|-
|CAR_COLOR
|Строка
|Цвет автомобиля
|-
|GOSNUMBER
|Строка
|Государственный номер автомобиля
|-
|SOUND_MARK
|Строка
|Запись с информацией о марке автомобиля
|-
|CREW_GROUP_ID
|Целое
|ИД группы экипажа
|-
|IS_PRIOR
|true или false
|Признак предварительного заказа
|-
|DISCOUNTEDSUMM
|Строка
|Сумма заказа с учетом всех скидок
|-
|DRIVER_PHONE
|Строка, <= 16 символов
|Номер телефона водителя
|-
|CATEGORYID
|Целое
|ИД категории телефона
|-
|SOURCE_TIMECOUNT
|Целое
|Время до подачи в минутах
|-
|ORDER_COORDS
|Строка
|Координаты места подачи
|-
|CREW_COORDS
|Строка
|Координаты назначенного экипажа
|-
|ORDER_STATE
|Целое
|ИД состояния заказа
|}

Пример:

<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
HTTP/1.1

Ответ:

<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></SOURCE_TIME>
</data>
</response>
</pre>

==== Смена состояния заказа ====
Метод: POST

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

Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|-
|need_state
|Целое
|Новое состояние заказа
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

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

{|
!Код
!Описание
|-
|100
|Заказ с таким ИД не найден.
|-
|101
|Изменение состояния не соответствует необходимым условиям.
|}

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

{|
!Параметр
!Тип
!Описание
|-
|ORDER_ID
|Целое
|ИД созданного заказа
|-
|NEW_STATE
|Целое
|Новое состояние заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/tm_tapi/1.0/change_order_state HTTP/1.1
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"|Обязательные параметры
|-
|RECORD_DATE
|ГГГГММДДччммсс
|Дата записи
|-
|RECORD_LENGTH
|Целое
|Продолжительность записи (в секундах)
|-
|PHONE
|Строка, <= 16 символов
|Номер телефона
|-
|FILE_PATH
|Строка,<=255 символов
|Путь к файлу записи
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Заказ по такому номеру телефона не найден.
|}
Возвращаемые данные в случае успешного выполнения запроса

{|
!Параметр
!Тип
!Описание
|-
|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: 171
RECORD_DATE=20130122180949&RECORD_LENGTH=215&PHONE=8987564&FILE_PATH=d%3A%5Ctemp%5CTM%5Ctrunk
%5CSource%5CDevUtils%5CTMAPITest%5C&signature=56851c4e8d2d4bb9ba615615f76ad7f7

Ответ:
<response>
<code>0</code>
<descr>OK</descr>
<data>
<RECORD_ID>25</RECORD_ID>
</data>
</response>
</pre>

==== Создать новый заказ ====

Метод: POST

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

Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|PHONE
|Строка, <= 16 символов
|Номер телефона
|-
|ORDER_STATE_ID
|Целое
|ИД состояния заказа
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|-
|colspan="3"|Необязательные параметры
|-
|CREW_GROUP_ID
|Целое
|ИД группы экипажа
|-
|TARIFF_ID
|Целое
|ИД тарифа
|-
|PHONE_PREFIX
|Строка
|Префикс, отрезаемый от номера телефона при поиске в базе данных. Для входящих звонков это код города с префиксом входящих номеров, обычно "8". Например, "83412"
|-
|DISCOUNTED_SU MM
|Строка
|Фиксированная сумма за заказ
|}

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

{|
!Код
!Описание
|-
|100
|Клиент не найден
|}

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

{|
!Параметр
!Тип
!Описание
|-
|ORDER_ID
|Целое
|ИД созданного заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/tm_tapi/1.0/make_new_order HTTP/1.1
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>
</pre>

== Пример формы для заказа такси ==
{{url|{{корень FTP|forms/zakaz_taxi.zip}}}}

Данная форма является примером, на основе которого можно построить собственную форму для принятия интернет-заказов. Форму можно использовать либо в исходном варианте, либо применяя запросы [[TM API#Описание запросов|TM API]].
Для того, чтобы данная форма функционировала, необходимо открыть файл в любом текстовом редакторе и указать корректные IP-адрес [[Сервер Такси-Мастер|сервера Такси-Мастер]], порт [[TM API#Параметры TM API|TM API]] и секретный ключ. Далее вам следует загрузить файл на хостинг.

Именно так будет выглядеть данная форма для заказа такси.
{{картинка|Форма для заказа такси.jpg}}

[[Категория:ТМ2]]

TM API

2013-10-02T07:07:31Z

AnnaNikolskih: /* Запрос информации по ИД заказа */

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

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

# Создать механизм приема заказов через интернет.
# Сделать ваш сайт более информативным: публиковать полезную для клиентов информацию прямо из системы - список ближайших [[Справочник «Экипажи»|экипажей]], предварительный расчет стоимости поездки, мониторинг движения автомобиля такси в процессе выполнения [[заказ]]а, [[Модуль «Интеграция с картами»|карты города]] и контактную информацию.
# Расширить возможности своей службы за счет популярного онлайн-сервиса Яндекс Такси.

== Параметры TM API ==
Задать настройки для корректной работы TM API вы сможете в программе [[Такси-Мастер]] в меню {{tab|Настройки}} в одноименной ветке {{tab|TM API}}.
Параметры организуют и контролируют работу [[Модуль «Интернет-заказы»|модуля «Интернет-заказы»]].
# Установите флажок {{checkbox|Использовать TM API}}, чтобы приступить к его использованию.
# В поле {{поле|Локальный порт}} введите номер порта подключения к интернету, на котором работает и будет ожидать запросы о новых заказах [[TMServer]]. Рекомендуется оставить номер порта по умолчанию.
# Установите флажок {{checkbox|Можно использовать данное рабочее место TMServer для распознавания адресов}} для того, чтобы конкретно с данного рабочего места происходило распознавание адресов модулем "Интернет-заказы".
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

=== Ветка «Открытое API» ===
В данной ветке регулируется доступ к синхронизации Такси-Мастер со сторонним сервисом (сайтом), с помощью которого клиенты будут создавать интернет-заказы. С примером кода для работы вы можете ознакомиться в данной статье в разделе [[TM API#Общее описание протокола|Общее описание протокола]].
# Установите флажок {{checkbox|Использовать открытое API}} для того, чтобы запустить работу по обслуживанию модуля «Интернет-заказы». При установленном флажке сервер [[Модуль «Интернет-заказы»|модуля «Интернет-заказы»]] запускается и ожидает запросы о новых заказах.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы с модулем «Интернет-заказы», который будет выслан вам в письме от менеджера.
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

=== Ветка «API для телефонии» ===
В данной ветке регулируются настройки API для телефонии, т.е. взаимодействие [[Такси-Мастер]] с call-центром через программный интерфейс. С его помощью [[Call-центр Oktell|call-центр]] может дать команду Такси-Мастер создать [[зака]]з или запросить информацию о [[Справочник «Состояния заказа»|статусе текущего заказа]].
# Установите флажок {{checkbox|Использовать открытое API для телефонии}} для того, чтобы запустить работу по обслуживанию телефонии через API.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы.
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

=== Ветка «Платежные терминалы» ===
{{info|Ранее для связи [[Модуль интеграции с платежными системами|платежных систем]] и [[Такси-Мастер]] служила такая утилита, как TMWeb. В данный момент мы отказались от ее использования, а функции были распределены между двумя компонентами системы: TM API и [[TMServer]].}}

Параметры этой ветки отвечают за работу [[Модуль интеграции с платежными терминалами|модуля интеграции с платежными системами]].
# Установите флажок {{checkbox|Включить прием терминальных платежей}}. Данная функция позволит отображать все платежные операции по приходу средств от водителей через терминалы в [[База данных Такси-Мастер 2|базе данных]] программы.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы с платежными системами и сверки платежей, который будет выслан вам в письме от менеджера. Секретный ключ - это определенный набор символов, необходимый для формирования подписи при передаче информации о платеже.
# В полях {{поле|Логин}} и {{поле|Пароль}} введите данные учетной записи на сайте http://term.bitmaster.ru.
# Кнопка {{кнопка|Задать всем водителям терминальный аккаунт по их ИД}} служит для соединения TM API с сервером Такси-Мастер. В результате соединения записи о терминальных аккаунтах генерируются, заносятся (для тех водителей, у которых они отсутствуют) и обновляются (для тех водителей, у которых уже существуют терминальные аккаунты) в Такси-Мастер.
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

{{info|Обратите внимание, что для платежных систем также существует открытый и свободно распространяемый API, с помощью которого есть возможность связать [[Такси-Мастер]] и [[Модуль интеграции с платежными системами|платежные системы]]. Обратитесь в отдел дополнительных услуг, написав на {{ящик ОДУ}}, за получением кода для данного компонента системы.}}

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

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

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

<pre>
GET https://ip:port/common_api/1.0/get_crew_groups_list HTTP/1.1
</pre>

Для получения данных из БД используются запросы типа GET. Для записи данных в [[База данных Такси-Мастер|базу данных]] используются запросы типа POST. В запросе типа GET параметры запроса передаются в URI. Пример:
<pre>
GET https://ip:port/common_api/1.0/calc_order_cost?tariff_id=1&distance_city=10 HTTP/1.1
Signature: <...>
</pre>

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

<pre>
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
</pre>

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

<pre>
Запрос:
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
</pre>

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

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

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

Существуют общие для всех запросов коды результатов:
{|
! Код
! Описание
|-
|0
|Успешное выполнение запроса
|-
|1
|Неизвестная ошибка
|-
|2
|Неизвестный тип API
|-
|3
|API отключено в настройках TMWeb
|-
|4
|Не совпадает секретный ключ
|-
|5
|Неподдерживаемая версия API
|-
|6
|Неизвестное название запроса
|-
|7
|Неверный тип запроса GET/POST
|-
|8
|Не хватает входного параметра (в доп. информации ответа будет название отсутствующего параметра)
|-
|9
|Некорректный входной параметр (в доп. информации ответа будет название некорректного параметра)
|-
|10
|Внутренняя ошибка обработки запроса
|}

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

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

Метод: GET или POST

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

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

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

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

Пример:

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

=== Запрос списка групп экипажей ===
Метод: GET

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

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

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

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crew_groups
|Массив
|Список групп экипажей
|-
|• id
|Целое
|ИД группы экипажей
|-
|• name
|Строка
|Название группы экипажей
|}

Пример:

<pre>
Запрос:

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

Ответ:

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

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

Метод: GET

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

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

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

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

{|
!Параметр
!Тип
!Описание
|-
|uds
|Массив
|Список служб [[Модуль «Единая диспетчерская служба»|ЕДС]]
|-
|• id
|Целое
|ИД службы [[Модуль «Единая диспетчерская служба»|ЕДС]]
|-
|• name
|Строка
|Название службы [[Модуль «Единая диспетчерская служба»|ЕДС]]
|}

Пример:

<pre>
Запрос:

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

Ответ:

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

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

Метод: GET

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

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

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

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

{|
!Параметр
!Тип
!Описание
|-
|tariffs
|Массив
|Список [[Справочник «Тарифы»|тарифов]]
|-
|• id
|Целое
|ИД [[Справочник «Тарифы»|тарифа]]
|-
|• name
|Строка
|Название [[Справочник «Тарифы»|тарифа]]
|-
|• is_active
|true или false
|Активный [[Справочник «Тарифы»|тариф]]
|}

Пример:

<pre>
Запрос:

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

Ответ:

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

=== Запрос списка услуг ===
Метод: GET

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

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

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

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

{|
!Параметр
!Тип
!Описание
|-
|services
|Массив
|Список [[Справочник «Услуги»|услуг]]
|-
|• id
|Целое
|ИД [[Справочник «Услуги»|услуги]]
|-
|• name
|Строка
|Название [[Справочник «Услуги»|услуги]]
|-
|• sum
|Дробное
|Абсолютная сумма [[Справочник «Услуги»|услуги]], руб
|-
|• percent
|Дробное
|Процент [[Справочник «Услуги»|услуги]] от стоимости заказа, %
|}

Пример:

<pre>
Запрос:

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

Ответ:

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

=== Запрос списка скидок ===
Метод: GET

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

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

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

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

{|
!Параметр
!Тип
!Описание
|-
|discounts
|Массив
|Список [[Справочник «Скидки клиентов»|скидок]]
|-
|• id
|Целое
|ИД [[Справочник «Скидки клиентов»|скидки]]
|-
|• name
|Строка
|Название [[Справочник «Скидки клиентов»|скидки]]
|-
|• sum
|Дробное
|Абсолютная сумма [[Справочник «Скидки клиентов»|скидки]], руб
|-
|• percent
|Дробное
|Процент [[Справочник «Скидки клиентов»|скидки]] от стоимости заказа, %
|}

Пример:

<pre>
Запрос:

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

Ответ:

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

=== Создание нового заказа ===
Метод: POST

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

Параметры:

{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|phone
|Строка, <= 16 символов
|Номер телефона
|-
|source
|Строка
|Адрес подачи
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
!colspan="3"|Необязательные параметры
|-
|dest
|Строка
|Адрес назначения
|-
|customer
|Строка
|Заказчик
|-
|comment
|Строка
|Комментарий
|-
|crew_group_id
|Целое
|ИД группы экипажей
|-
|uds_id
|Целое
|ИД службы ЕДС
|-
|tariff_id
|Целое
|ИД тарифа
|-
|is_prior
|true или false
|Предварительный заказ
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Заказ с такими параметрами уже создан
|-
|101
|Тариф не найден
|-
|102
|Группа экипажа не найдена
|-
|103
|Служба ЕДС не найдена
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|order_id
|Целое
|ИД созданного заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_order HTTP/1.1
Signature: <...>
Content-Type: application/x-www-form-urlencoded
Content-Length: 127
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

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"order_id":12345
}
}
</pre>

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

Метод: GET

Название запроса: calc_order_cost
{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|tariff_id
|Целое
|ИД тарифа
|-
Параметры:

!colspan="3"|Необязательные параметры
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|is_prior
|true или false
|Предварительный заказ
|-
|client_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»
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Тариф не найден
|-
|101
|Ошибка при расчете по тарифу
|-
|102
|Скидка не найдена
|-
|103
|Клиент не найден
|-
|104
|Район подачи не найден
|-
|105
|Район назначения не найден
|-
|106
|Дисконтная карта не найдена
|}

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

Пример:

<pre>
Запрос:

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

Ответ:

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

=== Запрос информации об экипаже ===
Метод: GET

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

Параметры:
{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|crew_id
|Целое
|ИД экипажа
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Экипаж не найден
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crew_id
|Целое
|ИД экипажа
|-
|code
|Строка
|Позывной экипажа
|-
|name
|Строка
|Наименование экипажа
|-
|driver_id
|Целое
|ИД водителя
|-
|car_id
|Целое
|ИД автомобиля
|-
|crew_group_id
|Целое
|ИД группы экипажа
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_crew_info?crew_id=1 HTTP/1.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
}
}
</pre>

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

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

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|driver_id
|Целое
|ИД водителя
|-
!colspan="3"|Необязательные параметры
|-
|need_photo
|true или false
|Нужна ли фотография водителя
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Водитель не найден
|}

Возвращаемые параметры в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|driver_id
|Целое
|ИД водителя
|-
|name
|Строка
|ФИО водителя
|-
|birthday
|ДД.ММ.ГГГГ
|День рождения водителя
|-
|car_id
|Целое
|ИД основного автомобиля водителя
|-
|license
|Строка
|Удостоверение водителя
|-
|home_phone
|Строка
|Домашний телефон водителя
|-
|mobile_phone
|Строка
|Мобильный телефон водителя
|-
|is_locked
|true или false
|Водитель заблокирован
|-
|is_dismissed
|true или false
|Водитель уволен
|-
|driver_photo
|Base64
|Фото водителя (только если need_photo = true)
|}

Пример:

<pre>
Запрос:

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",
"birthday":"01.01.1980",
"car_id":1,
"license":"1234567890",
"home_phone":"123456",
"mobile_phone":"+79123456789",
"is_locked":false,
"is_dismissed":false
}
}
</pre>

=== Запрос информации об автомобиле ===
Метод: GET

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

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|car_id
|Целое
|ИД автомобиля
|-
!colspan="3"|Необязательные параметры
|-
|need_photo
|true или false
|Нужна ли фотография автомобиля
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Автомобиль не найден
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|car_id
|Целое
|ИД автомобиля
|-
|name
|Строка
|Наименование автомобиля
|-
|code
|Строка
|Позывной автомобиля
|-
|gos_number
|Строка
|Государственный номер автомобиля
|-
|color
|Строка
|Цвет автомобиля
|-
|mark
|Строка
|Марка автомобиля
|-
|short_name
|Строка
|Краткое название автомобиля
|-
|production_year
|Целое
|Год выпуска автомобиля
|-
|car_photo
|Base64
|Фото автомобиля (только если need_photo = true)
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_car_info?car_id=1&need_photo=false HTTP/1.1
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
}
}
</pre>

=== Запрос координат экипажей ===
Метод: GET

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

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Необязательные параметры
|-
|crew_id
|Целое
|ИД экипажа, по которому нужно вернуть координаты. Если не задано, то будут возвращены координаты всех экипажей на линии.
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Координаты не найдены
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crews_coords
|Массив
|Список координат экипажей
|-
|• crew_id
|Целое
|ИД экипажа
|-
|• crew_code
|Строка
|Позывной экипажа
|-
|• coords_time
|ГГГГММДДччммсс
|Время получения координат
|-
|• lat
|Дробное
|Долгота
|-
|• lon
|Дробное
|Широта
|-
|• state_kind
|Строка
|Тип состояния экипажа. Может принимать значения:
• "not_available" — экипаж не на линии

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

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

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

Пример:

<pre>

Запрос:
GET https://ip:port/common_api/1.0/get_crews_coords HTTP/1.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"
},
{
"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 HTTP/1.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"
}
]
}
}
</pre>

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

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
! colspan="3"|Обязательные параметры
|-
|get_streets
|true или false
|Искать улицы
|-
|get_houses
|true или false
|Искать пункты
|-
|get_streets
|true или false
|Искать дома. Не может быть равно true, если get_streets = true или get_points = true.
|-
|street
|Строка
|Часть названия улицы или пункта, если идет поиск улиц или пунктов, или полное название улицы, если идет поиск домов
|-
!colspan="3"|Необязательные параметры
|-
|house
|Строка
|Часть номера дома. Нужно только если get_houses = true.
|-
|max_addresses_count
|Целое
|Максимальное количество адресов в ответе
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Подходящие адреса не найдены
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|addresses
|Массив
|Список подходящих адресов
|-
|• street
|Строка
|Название улицы или пункта
|-
|• house
|Строка
|Номер дома
|-
|• kind
|Строка
|Тип адреса. Может принимать значения:
• "street" — улица

• "house" — дом

• "point" — пункт
|-
|• comment
|Строка
|Комментарий
|}

Пример:

<pre>

Запрос:

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

Ответ:

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

Запрос:

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 HTTP/1.1
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":""
}
]
}
}
</pre>

=== Анализ маршрута ===
Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|source
|Строка
|Адрес подачи
|-
|dest
|Строка
|Адрес назначения
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Адрес подачи не распознан
|-
|101
|Адрес назначения не распознан
|-
|102
|Маршрут не распознан
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|source_lat
|Дробное
|Широта адреса подачи
|-
|source_lon
|Дробное
|Долгота адреса подачи
|-
|source_zone_id
|Целое
|ИД района подачи
|-
|dest_lat
|Дробное
|Широта адреса назначения
|-
|dest_lon
|Дробное
|Долгота адреса назначения
|-
|dest_zone_id
|Целое
|ИД района назначения
|-
|city_dist
|Дробное
|Километраж по городу
|-
|country_dist
|Дробное
|Километраж за городом
|-
|source_country_dist
|Дробное
|Километраж до адреса подачи, если адрес подачи за городом
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/analyze_route?source=STREET1,1&dest=STREET2,2 HTTP/1.1
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
}
}
</pre>

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

Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|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
|Целое
|ИД автомобиля
|-
|start_time
|ГГГГММДДччммсс
|Время создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|finish_time
|ГГГГММДДччммсс
|Время завершения заказа
|-
|source
|Строка
|Адрес подачи
|-
|destination
|Строка
|Адрес назначения
|-
|passenger
|Строка
|Пассажир
|-
|phone
|Строка
|Номер телефона
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_order_state?order_id=1 HTTP/1.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
"start_time":"17.01.2013 12:56:41",
"source_time":"17.01.2013 13:26:17",
"finish_time":"17.01.2013 13:03:43",
"source":"1",
"destination":"2",
"passenger":"Слепаков",
"phone":"8800"
}
}
</pre>

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

Метод: POST

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|phone
|Строка, <= 16 символов
|Номер телефона
|-
|message
|Строка
|Текст СМС
|}

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

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

Пример:

<pre>
Запрос:

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

Signature: <...>

message=SMSText&phone=89050057216

Ответ:

{
"code":0,
"descr":"OK",
"data":{}
}
</pre>

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

Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|login
|Строка, <= 60 символов
|Логин
|-
|password
|Строка, <= 60 символов
|Пароль
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент с логином LOGIN и/или неверный пароль
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|client_id
|Целое
|ИД клиента
|}

Пример:

<pre>
Запрос:

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

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"client_id":131
}
}
</pre>

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

Метод: POST

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

Параметры:

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

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

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Клиент с номером телефона=PHONE уже существует
|-
|101
|Клиент с логином=LOGIN уже существует
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|client_id
|Целое
|ИД созданного клиента
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_order HTTP/1.1

Signature: <...>

Content-Type: application/x-www-form-urlencoded

Content-Length: 127

name=NAME&phones=88,99&login=LOGIN&password=PASSWORD&birthday=19930218115517&gender=male&address=ADDRESS

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"client_id":140
}
}
</pre>

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

Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

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

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

• "female" - женский
|-
|birthday
|ДД.ММ.ГГГГ
|Дата рождения
|-
|phones
|Строка
|Номера телефонов (через запятую)
|-
|balance
|Дробное
|Баланс
|-
|login
|Строка
|Логин
|-
|password
|Строка
|Пароль
|}

Пример:

<pre>
Запрос:

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

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"client_id":140,
"name":"Васильев Артём",
"number":"000140",
"address":"Бутово,45",
"gender":"male",
"birthday":"18.02.1993",
"phones":"[\"88\",\"99\"]",
"balance":1467,
"login":"artem",
"password":"vasilev"
}
}
</pre>

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

Метод: POST

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

Параметры:

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

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

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Клиент с номером телефона=PHONE уже существует
|-
|101
|Клиент с логином=LOGIN уже существует

|}

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

Пример:

<pre>
Запрос:

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

client_id=140&name=NAME&phones=88,99&login=LOGIN&password=PASSWORD&birthday=19930218115517&gender=male&address=ADDRESS

Ответ:

{
"code":0,
"descr":"OK",
"data":{}
}
</pre>

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

Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента (может отсутствовать, если phone заполнен)
|-
|phone
|Строка, <= 16 символов
|Телефон клиента (может отсутствовать, если client_id заполнен)
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|id
|Целое
|ИД заказа
|-
|state_id
|Целое
|ИД состояния заказа
|-
|start_time
|ГГГГММДДччммсс
|Дата создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|source
|Строка
|Адрес подачи
|-
|destination
|Строка
|Адрес назначения
|-
|passenger
|Строка
|Пассажир
|-
|crew_id
|Целое
|ИД экипажа
|-
|prior_crew_id
|Целое
|ИД предварительного экипажа
|-
|driver_id
|Целое
|ИД водителя
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_current_orders?client_id=140&phone=18 HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"orders":[
{
"id":20648,
"state_id":44,
"start_time":"20130204181111",
"source_time":"20130204181111",
"source":"1-й пр-т \/Москва\/,",
"destination":"12-й мкр,",
"passenger":"маша",
"crew_id":0,
"prior_crew_id":0,
"driver_id":0
},
{
"id":20670,
"state_id":44,
"start_time":"20130207153022",
"source_time":"20130207153022",
"source":"11-й мкр,",
"destination":"1-й пр-т \/Москва\/,",
"passenger":"саша",
"crew_id":0,
"prior_crew_id":0,
"driver_id":0
}
]
}
}
</pre>

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

Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента (может отсутствовать, если phone заполнен)
|-
|phone
|Строка, <= 16 символов
|Телефон клиента (может отсутствовать, если client_id заполнен)
|-
|start_time
|ГГГГММДДччммсс
|Начало периода
|-
|finish_time
|ГГГГММДДччммсс
|Конец периода
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|id
|Целое
|ИД заказа
|-
|state_id
|Целое
|ИД состояния заказа
|-
|start_time
|ГГГГММДДччммсс
|Время создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|finish_time
|ГГГГММДДччммсс
|Время завершения заказа
|-
|source
|Строка
|Адрес подачи
|-
|destination
|Строка
|Адрес назначения
|-
|passenger
|Строка
|Пассажир
|-
|sum
|Дробное
|Стоимость заказа без учета скидок(наценок)
|-
|crew_id
|Целое
|ИД экипажа
|-
|prior_crew_id
|Целое
|ИД предварительного экипажа
|-
|driver_id
|Целое
|ИД водителя
|-
|car_id
|Целое
|ИД автомобиля
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_finished_orders?client_id=140&phone= HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"orders":[
{
"id":20651,
"state_id":34,
"source_time":"20130205110812",
"start_time":"20130205110812",
"finish_time":"20130205115618",
"source":"прпроп",
"destination":"рррррр",
"passenger":"вера",
"sum":"908",
"crew_id":"6",
"prior_crew_id":0,
"driver_id":"4",
"car_id":"6"
},
{
"id":20669,
"state_id":34,
"source_time":"20130205130500",
"start_time":"20130205130500",
"finish_time":"20130205134511",
"source":"1",
"destination":"2",
"passenger":"маша",
"sum":"454",
"crew_id":"6",
"prior_crew_id":0,
"driver_id":"4",
"car_id":"6"
}
]
}
}
</pre>

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

Метод: POST

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента
|-
|oper_time
|ГГГГММДДччммсс
|Время создания операции
|-
|sum
|Дробное
|Сумма
|-
|oper_type
|Целое
|Тип операции:
• "receipt" - приход

• "expense" - расход
|-
|pay_type
|Целое
|Тип оплаты:
• "cash" - наличный

• "nocash" - безналичный
|-
!colspan="3"|Необязательные параметры
|-
|comment
|Строка
|Комментарий
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|oper_id
|Целое
|ИД операции
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_client_operation HTTP/1.1

Signature: <...>

Content-Type: application/x-www-form-urlencoded

Content-Length: 127

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

Ответ:

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

}
}
</pre>

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

Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента (может отсутствовать, если phone заполнен)
|-
|phone
|Целое
|Телефон клиента (может отсутствовать, если client_id заполнен)
|-
|start_time
|ГГГГММДДччммсс
|Начало периода
|-
|finish_time
|ГГГГММДДччммсс
|Конец периода
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|oper_id
|Целое
|ИД операции
|-
|oper_time
|ГГГГММДДччммсс
|Время создания операции
|-
|sum
|Дробное
|Сумма
|-
|order_id
|Целое
|Заказ, связанный с операцией
|-
|oper_type
|Целое
|Тип операции:
• "receipt" - приход
• "expense" - расход
|-
|pay_type
|Целое
|Тип оплаты:
• "cash" - наличный
• "nocash" - безналичный
|}

Пример:

<pre>
Запрос:

GET

https://ip:port/common_api/1.0/get_client_operations?client_id=112&start_time=20130201092112&finish_time=20130221092112 HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"operations":[
{
"oper_id":112,
"oper_time":"20130219091328",
"sum":"21,8",
"order_id":11800,
"oper_type":"receipt",
"pay_type":"cash",
"comment":"jgznm"
},
{
"oper_id":112,
"oper_time":"20130220112245",
"sum":"4500",
"order_id":11801,
"oper_type":"receipt",
"pay_type":"cash",
"comment":"блин"
}
]
}
}
</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 HTTP/1.1
</pre>

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

Пример:

<pre>
GET https://ip:port/tm_tapi/1.0/get_info_by_phone?phone=89058800565&fields=PHONE_TYPEPHONE_
TO_DIAL&signature=661ce071eeefcb4f7fc8bc1f17bd520b HTTP/1.1
</pre>

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

Пример:

<pre>
POST https://ip:port/tm_tapi/1.0/change_order_state HTTP/1.1
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 HTTP/1.1

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

Signature = MD5("phone=89058800565&fields=PHONE_TYPE" + "321") = ef17ea682d09e452af544a5758dba396
HTTP/1.1
</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 - если звонит номер из справочника телефоны; 0 - неизвестный номер)
|-
|PHONE_TO_DIAL
|Строка, <= 16 символов
|Номер телефона для отзвона по заказу
|-
|CREW_ID
|Целое
|ИД экипажа
|-
|IS_PRIOR
|true или false
|Признак предварительного заказа
|-
|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
|Целое
|ИД группы экипажа
|-
|CLIENT_BALANCE
|Дробное
|Баланс клиента
|-
|DRIVER_TIMECOUNT
|Целое
|Время пути водителя до адреса подачи в минутах
|-
|SOURCE_TIMECOUNT
|Целое
|Время оставшееся до подачи в минутах
|-
|SOUND_COLOR
|Строка
|Запись с информацией о цвете
|-
|SOUND_GOSNUMBER
|Строка
|Запись с информацией о государственном номере автомобиля
|-
|SOUND_MARK
|Строка
|Запись с информацией о марке автомобиля
|-
|GOSNUMBER
|Строка
|Государственный номер автомобиля
|-
|CAR_COLOR
|Строка
|Цвет автомобиля
|-
|CAR_MARK
|Строка
|Марка автомобиля
|-
|ORDER_COORDS
|Строка
|Координаты места подачи
|-
|CREW_COORDS
|Строка
|Координаты назначенного экипажа
|}

Пример:

<pre>
Запрос:
GET https://ip:port/tm_tapi/1.0/get_info_by_phone?phone=89058800565l&fields=PHONE_TYPEPHONE_
TO_DIAL-CREW_ID-ORDER_ID&signature=d35ab2765f2968d48c096d5f5327db26 HTTP/1.1

Ответ:

<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>
</data>
</response>
</pre>

==== Запрос информации по ИД заказа ====

Метод: GET
Название запроса: get_info_by_order_id
Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|-
|fields
|Строка
|Список полей, которые необходимо вернуть. Поля перечисляются через ''-''
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

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

{|
!Параметр
!Тип
!Описание
|-
|DRIVER_TIMECOUNT
|Строка, <= 16 символов
|Время до подачи в минутах, указанное водителем
|-
|SOUND_COLOR
|Строка
|Запись с информацией о цвете
|-
|CAR_MARK
|Строка
|Марка автомобиля
|-
|CAR_COLOR
|Строка
|Цвет автомобиля
|-
|GOSNUMBER
|Строка
|Государственный номер автомобиля
|-
|SOUND_MARK
|Строка
|Запись с информацией о марке автомобиля
|-
|CREW_GROUP_ID
|Целое
|ИД группы экипажа
|-
|IS_PRIOR
|true или false
|Признак предварительного заказа
|-
|DISCOUNTEDSUMM
|Строка
|Сумма заказа с учетом всех скидок
|-
|DRIVER_PHONE
|Строка, <= 16 символов
|Номер телефона водителя
|-
|CATEGORYID
|Целое
|ИД категории телефона
|-
|SOURCE_TIMECOUNT
|Целое
|Время до подачи в минутах
|-
|ORDER_COORDS
|Строка
|Координаты места подачи
|-
|CREW_COORDS
|Строка
|Координаты назначенного экипажа
|-
|ORDER_STATE
|Целое
|ИД состояния заказа
|}

Пример:

<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
HTTP/1.1

Ответ:

<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></SOURCE_TIME>
</data>
</response>
</pre>

==== Смена состояния заказа ====
Метод: POST

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

Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|-
|need_state
|Целое
|Новое состояние заказа
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

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

{|
!Код
!Описание
|-
|100
|Заказ с таким ИД не найден.
|-
|101
|Изменение состояния не соответствует необходимым условиям.
|}

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

{|
!Параметр
!Тип
!Описание
|-
|ORDER_ID
|Целое
|ИД созданного заказа
|-
|NEW_STATE
|Целое
|Новое состояние заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/tm_tapi/1.0/change_order_state HTTP/1.1
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"|Обязательные параметры
|-
|RECORD_DATE
|ГГГГММДДччммсс
|Дата записи
|-
|RECORD_LENGTH
|Целое
|Продолжительность записи (в секундах)
|-
|PHONE
|Строка, <= 16 символов
|Номер телефона
|-
|ORDERID
|Целое
|Заказ, с которого сделана запись
|-
|USERID
|Целое
|Пользователь, сделавший запись
|-
|FILE_PATH
|Строка,<=255 символов
|Путь к файлу записи
|-
|RECORD_GUID
|Строка,<= 80 символов
|GUID звонка
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

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

{|
!Параметр
!Тип
!Описание
|-
|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: 206
RECORD_DATE=20121108145953&RECORD_LENGTH=6546&PHONE=654321&ORDERID=654&USERID=564&FILE_PATH=d%3A
%5CProjects%5Ctrunk%5C%5Ftrunk%5CTM%5CBin
%5C&RECORD_GUID=GUID456258&signature=cd11d50d65fa7e8ad73f80cdc7d296c7

Ответ:

<response>
<code>0</code>
<descr>OK</descr>
<data>
<RECORD_ID>25</RECORD_ID>
</data>
</response>
</pre>

==== Создать новый заказ ====

Метод: POST

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

Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|PHONE
|Строка, <= 16 символов
|Номер телефона
|-
|ORDER_STATE_ID
|Целое
|ИД состояния заказа
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|-
|colspan="3"|Необязательные параметры
|-
|CREW_GROUP_ID
|Целое
|ИД группы экипажа
|-
|TARIFF_ID
|Целое
|ИД тарифа
|-
|PHONE_PREFIX
|Строка
|Префикс, отрезаемый от номера телефона при поиске в базе данных. Для входящих звонков это код города с префиксом входящих номеров, обычно "8". Например, "83412"
|-
|DISCOUNTED_SU MM
|Строка
|Фиксированная сумма за заказ
|}

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

{|
!Код
!Описание
|-
|100
|Клиент не найден
|}

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

{|
!Параметр
!Тип
!Описание
|-
|ORDER_ID
|Целое
|ИД созданного заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/tm_tapi/1.0/make_new_order HTTP/1.1
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>
</pre>

== Пример формы для заказа такси ==
{{url|{{корень FTP|forms/zakaz_taxi.zip}}}}

Данная форма является примером, на основе которого можно построить собственную форму для принятия интернет-заказов. Форму можно использовать либо в исходном варианте, либо применяя запросы [[TM API#Описание запросов|TM API]].
Для того, чтобы данная форма функционировала, необходимо открыть файл в любом текстовом редакторе и указать корректные IP-адрес [[Сервер Такси-Мастер|сервера Такси-Мастер]], порт [[TM API#Параметры TM API|TM API]] и секретный ключ. Далее вам следует загрузить файл на хостинг.

Именно так будет выглядеть данная форма для заказа такси.
{{картинка|Форма для заказа такси.jpg}}

[[Категория:ТМ2]]

TM API

2013-10-02T06:52:35Z

AnnaNikolskih: /* Запрос информации по номеру телефона */

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

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

# Создать механизм приема заказов через интернет.
# Сделать ваш сайт более информативным: публиковать полезную для клиентов информацию прямо из системы - список ближайших [[Справочник «Экипажи»|экипажей]], предварительный расчет стоимости поездки, мониторинг движения автомобиля такси в процессе выполнения [[заказ]]а, [[Модуль «Интеграция с картами»|карты города]] и контактную информацию.
# Расширить возможности своей службы за счет популярного онлайн-сервиса Яндекс Такси.

== Параметры TM API ==
Задать настройки для корректной работы TM API вы сможете в программе [[Такси-Мастер]] в меню {{tab|Настройки}} в одноименной ветке {{tab|TM API}}.
Параметры организуют и контролируют работу [[Модуль «Интернет-заказы»|модуля «Интернет-заказы»]].
# Установите флажок {{checkbox|Использовать TM API}}, чтобы приступить к его использованию.
# В поле {{поле|Локальный порт}} введите номер порта подключения к интернету, на котором работает и будет ожидать запросы о новых заказах [[TMServer]]. Рекомендуется оставить номер порта по умолчанию.
# Установите флажок {{checkbox|Можно использовать данное рабочее место TMServer для распознавания адресов}} для того, чтобы конкретно с данного рабочего места происходило распознавание адресов модулем "Интернет-заказы".
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

=== Ветка «Открытое API» ===
В данной ветке регулируется доступ к синхронизации Такси-Мастер со сторонним сервисом (сайтом), с помощью которого клиенты будут создавать интернет-заказы. С примером кода для работы вы можете ознакомиться в данной статье в разделе [[TM API#Общее описание протокола|Общее описание протокола]].
# Установите флажок {{checkbox|Использовать открытое API}} для того, чтобы запустить работу по обслуживанию модуля «Интернет-заказы». При установленном флажке сервер [[Модуль «Интернет-заказы»|модуля «Интернет-заказы»]] запускается и ожидает запросы о новых заказах.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы с модулем «Интернет-заказы», который будет выслан вам в письме от менеджера.
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

=== Ветка «API для телефонии» ===
В данной ветке регулируются настройки API для телефонии, т.е. взаимодействие [[Такси-Мастер]] с call-центром через программный интерфейс. С его помощью [[Call-центр Oktell|call-центр]] может дать команду Такси-Мастер создать [[зака]]з или запросить информацию о [[Справочник «Состояния заказа»|статусе текущего заказа]].
# Установите флажок {{checkbox|Использовать открытое API для телефонии}} для того, чтобы запустить работу по обслуживанию телефонии через API.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы.
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

=== Ветка «Платежные терминалы» ===
{{info|Ранее для связи [[Модуль интеграции с платежными системами|платежных систем]] и [[Такси-Мастер]] служила такая утилита, как TMWeb. В данный момент мы отказались от ее использования, а функции были распределены между двумя компонентами системы: TM API и [[TMServer]].}}

Параметры этой ветки отвечают за работу [[Модуль интеграции с платежными терминалами|модуля интеграции с платежными системами]].
# Установите флажок {{checkbox|Включить прием терминальных платежей}}. Данная функция позволит отображать все платежные операции по приходу средств от водителей через терминалы в [[База данных Такси-Мастер 2|базе данных]] программы.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы с платежными системами и сверки платежей, который будет выслан вам в письме от менеджера. Секретный ключ - это определенный набор символов, необходимый для формирования подписи при передаче информации о платеже.
# В полях {{поле|Логин}} и {{поле|Пароль}} введите данные учетной записи на сайте http://term.bitmaster.ru.
# Кнопка {{кнопка|Задать всем водителям терминальный аккаунт по их ИД}} служит для соединения TM API с сервером Такси-Мастер. В результате соединения записи о терминальных аккаунтах генерируются, заносятся (для тех водителей, у которых они отсутствуют) и обновляются (для тех водителей, у которых уже существуют терминальные аккаунты) в Такси-Мастер.
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

{{info|Обратите внимание, что для платежных систем также существует открытый и свободно распространяемый API, с помощью которого есть возможность связать [[Такси-Мастер]] и [[Модуль интеграции с платежными системами|платежные системы]]. Обратитесь в отдел дополнительных услуг, написав на {{ящик ОДУ}}, за получением кода для данного компонента системы.}}

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

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

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

<pre>
GET https://ip:port/common_api/1.0/get_crew_groups_list HTTP/1.1
</pre>

Для получения данных из БД используются запросы типа GET. Для записи данных в [[База данных Такси-Мастер|базу данных]] используются запросы типа POST. В запросе типа GET параметры запроса передаются в URI. Пример:
<pre>
GET https://ip:port/common_api/1.0/calc_order_cost?tariff_id=1&distance_city=10 HTTP/1.1
Signature: <...>
</pre>

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

<pre>
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
</pre>

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

<pre>
Запрос:
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
</pre>

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

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

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

Существуют общие для всех запросов коды результатов:
{|
! Код
! Описание
|-
|0
|Успешное выполнение запроса
|-
|1
|Неизвестная ошибка
|-
|2
|Неизвестный тип API
|-
|3
|API отключено в настройках TMWeb
|-
|4
|Не совпадает секретный ключ
|-
|5
|Неподдерживаемая версия API
|-
|6
|Неизвестное название запроса
|-
|7
|Неверный тип запроса GET/POST
|-
|8
|Не хватает входного параметра (в доп. информации ответа будет название отсутствующего параметра)
|-
|9
|Некорректный входной параметр (в доп. информации ответа будет название некорректного параметра)
|-
|10
|Внутренняя ошибка обработки запроса
|}

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

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

Метод: GET или POST

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

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

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

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

Пример:

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

=== Запрос списка групп экипажей ===
Метод: GET

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

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

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

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crew_groups
|Массив
|Список групп экипажей
|-
|• id
|Целое
|ИД группы экипажей
|-
|• name
|Строка
|Название группы экипажей
|}

Пример:

<pre>
Запрос:

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

Ответ:

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

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

Метод: GET

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

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

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

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

{|
!Параметр
!Тип
!Описание
|-
|uds
|Массив
|Список служб [[Модуль «Единая диспетчерская служба»|ЕДС]]
|-
|• id
|Целое
|ИД службы [[Модуль «Единая диспетчерская служба»|ЕДС]]
|-
|• name
|Строка
|Название службы [[Модуль «Единая диспетчерская служба»|ЕДС]]
|}

Пример:

<pre>
Запрос:

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

Ответ:

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

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

Метод: GET

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

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

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

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

{|
!Параметр
!Тип
!Описание
|-
|tariffs
|Массив
|Список [[Справочник «Тарифы»|тарифов]]
|-
|• id
|Целое
|ИД [[Справочник «Тарифы»|тарифа]]
|-
|• name
|Строка
|Название [[Справочник «Тарифы»|тарифа]]
|-
|• is_active
|true или false
|Активный [[Справочник «Тарифы»|тариф]]
|}

Пример:

<pre>
Запрос:

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

Ответ:

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

=== Запрос списка услуг ===
Метод: GET

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

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

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

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

{|
!Параметр
!Тип
!Описание
|-
|services
|Массив
|Список [[Справочник «Услуги»|услуг]]
|-
|• id
|Целое
|ИД [[Справочник «Услуги»|услуги]]
|-
|• name
|Строка
|Название [[Справочник «Услуги»|услуги]]
|-
|• sum
|Дробное
|Абсолютная сумма [[Справочник «Услуги»|услуги]], руб
|-
|• percent
|Дробное
|Процент [[Справочник «Услуги»|услуги]] от стоимости заказа, %
|}

Пример:

<pre>
Запрос:

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

Ответ:

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

=== Запрос списка скидок ===
Метод: GET

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

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

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

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

{|
!Параметр
!Тип
!Описание
|-
|discounts
|Массив
|Список [[Справочник «Скидки клиентов»|скидок]]
|-
|• id
|Целое
|ИД [[Справочник «Скидки клиентов»|скидки]]
|-
|• name
|Строка
|Название [[Справочник «Скидки клиентов»|скидки]]
|-
|• sum
|Дробное
|Абсолютная сумма [[Справочник «Скидки клиентов»|скидки]], руб
|-
|• percent
|Дробное
|Процент [[Справочник «Скидки клиентов»|скидки]] от стоимости заказа, %
|}

Пример:

<pre>
Запрос:

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

Ответ:

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

=== Создание нового заказа ===
Метод: POST

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

Параметры:

{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|phone
|Строка, <= 16 символов
|Номер телефона
|-
|source
|Строка
|Адрес подачи
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
!colspan="3"|Необязательные параметры
|-
|dest
|Строка
|Адрес назначения
|-
|customer
|Строка
|Заказчик
|-
|comment
|Строка
|Комментарий
|-
|crew_group_id
|Целое
|ИД группы экипажей
|-
|uds_id
|Целое
|ИД службы ЕДС
|-
|tariff_id
|Целое
|ИД тарифа
|-
|is_prior
|true или false
|Предварительный заказ
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Заказ с такими параметрами уже создан
|-
|101
|Тариф не найден
|-
|102
|Группа экипажа не найдена
|-
|103
|Служба ЕДС не найдена
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|order_id
|Целое
|ИД созданного заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_order HTTP/1.1
Signature: <...>
Content-Type: application/x-www-form-urlencoded
Content-Length: 127
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

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"order_id":12345
}
}
</pre>

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

Метод: GET

Название запроса: calc_order_cost
{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|tariff_id
|Целое
|ИД тарифа
|-
Параметры:

!colspan="3"|Необязательные параметры
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|is_prior
|true или false
|Предварительный заказ
|-
|client_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»
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Тариф не найден
|-
|101
|Ошибка при расчете по тарифу
|-
|102
|Скидка не найдена
|-
|103
|Клиент не найден
|-
|104
|Район подачи не найден
|-
|105
|Район назначения не найден
|-
|106
|Дисконтная карта не найдена
|}

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

Пример:

<pre>
Запрос:

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

Ответ:

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

=== Запрос информации об экипаже ===
Метод: GET

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

Параметры:
{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|crew_id
|Целое
|ИД экипажа
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Экипаж не найден
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crew_id
|Целое
|ИД экипажа
|-
|code
|Строка
|Позывной экипажа
|-
|name
|Строка
|Наименование экипажа
|-
|driver_id
|Целое
|ИД водителя
|-
|car_id
|Целое
|ИД автомобиля
|-
|crew_group_id
|Целое
|ИД группы экипажа
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_crew_info?crew_id=1 HTTP/1.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
}
}
</pre>

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

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

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|driver_id
|Целое
|ИД водителя
|-
!colspan="3"|Необязательные параметры
|-
|need_photo
|true или false
|Нужна ли фотография водителя
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Водитель не найден
|}

Возвращаемые параметры в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|driver_id
|Целое
|ИД водителя
|-
|name
|Строка
|ФИО водителя
|-
|birthday
|ДД.ММ.ГГГГ
|День рождения водителя
|-
|car_id
|Целое
|ИД основного автомобиля водителя
|-
|license
|Строка
|Удостоверение водителя
|-
|home_phone
|Строка
|Домашний телефон водителя
|-
|mobile_phone
|Строка
|Мобильный телефон водителя
|-
|is_locked
|true или false
|Водитель заблокирован
|-
|is_dismissed
|true или false
|Водитель уволен
|-
|driver_photo
|Base64
|Фото водителя (только если need_photo = true)
|}

Пример:

<pre>
Запрос:

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",
"birthday":"01.01.1980",
"car_id":1,
"license":"1234567890",
"home_phone":"123456",
"mobile_phone":"+79123456789",
"is_locked":false,
"is_dismissed":false
}
}
</pre>

=== Запрос информации об автомобиле ===
Метод: GET

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

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|car_id
|Целое
|ИД автомобиля
|-
!colspan="3"|Необязательные параметры
|-
|need_photo
|true или false
|Нужна ли фотография автомобиля
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Автомобиль не найден
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|car_id
|Целое
|ИД автомобиля
|-
|name
|Строка
|Наименование автомобиля
|-
|code
|Строка
|Позывной автомобиля
|-
|gos_number
|Строка
|Государственный номер автомобиля
|-
|color
|Строка
|Цвет автомобиля
|-
|mark
|Строка
|Марка автомобиля
|-
|short_name
|Строка
|Краткое название автомобиля
|-
|production_year
|Целое
|Год выпуска автомобиля
|-
|car_photo
|Base64
|Фото автомобиля (только если need_photo = true)
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_car_info?car_id=1&need_photo=false HTTP/1.1
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
}
}
</pre>

=== Запрос координат экипажей ===
Метод: GET

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

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Необязательные параметры
|-
|crew_id
|Целое
|ИД экипажа, по которому нужно вернуть координаты. Если не задано, то будут возвращены координаты всех экипажей на линии.
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Координаты не найдены
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crews_coords
|Массив
|Список координат экипажей
|-
|• crew_id
|Целое
|ИД экипажа
|-
|• crew_code
|Строка
|Позывной экипажа
|-
|• coords_time
|ГГГГММДДччммсс
|Время получения координат
|-
|• lat
|Дробное
|Долгота
|-
|• lon
|Дробное
|Широта
|-
|• state_kind
|Строка
|Тип состояния экипажа. Может принимать значения:
• "not_available" — экипаж не на линии

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

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

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

Пример:

<pre>

Запрос:
GET https://ip:port/common_api/1.0/get_crews_coords HTTP/1.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"
},
{
"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 HTTP/1.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"
}
]
}
}
</pre>

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

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
! colspan="3"|Обязательные параметры
|-
|get_streets
|true или false
|Искать улицы
|-
|get_houses
|true или false
|Искать пункты
|-
|get_streets
|true или false
|Искать дома. Не может быть равно true, если get_streets = true или get_points = true.
|-
|street
|Строка
|Часть названия улицы или пункта, если идет поиск улиц или пунктов, или полное название улицы, если идет поиск домов
|-
!colspan="3"|Необязательные параметры
|-
|house
|Строка
|Часть номера дома. Нужно только если get_houses = true.
|-
|max_addresses_count
|Целое
|Максимальное количество адресов в ответе
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Подходящие адреса не найдены
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|addresses
|Массив
|Список подходящих адресов
|-
|• street
|Строка
|Название улицы или пункта
|-
|• house
|Строка
|Номер дома
|-
|• kind
|Строка
|Тип адреса. Может принимать значения:
• "street" — улица

• "house" — дом

• "point" — пункт
|-
|• comment
|Строка
|Комментарий
|}

Пример:

<pre>

Запрос:

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

Ответ:

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

Запрос:

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 HTTP/1.1
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":""
}
]
}
}
</pre>

=== Анализ маршрута ===
Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|source
|Строка
|Адрес подачи
|-
|dest
|Строка
|Адрес назначения
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Адрес подачи не распознан
|-
|101
|Адрес назначения не распознан
|-
|102
|Маршрут не распознан
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|source_lat
|Дробное
|Широта адреса подачи
|-
|source_lon
|Дробное
|Долгота адреса подачи
|-
|source_zone_id
|Целое
|ИД района подачи
|-
|dest_lat
|Дробное
|Широта адреса назначения
|-
|dest_lon
|Дробное
|Долгота адреса назначения
|-
|dest_zone_id
|Целое
|ИД района назначения
|-
|city_dist
|Дробное
|Километраж по городу
|-
|country_dist
|Дробное
|Километраж за городом
|-
|source_country_dist
|Дробное
|Километраж до адреса подачи, если адрес подачи за городом
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/analyze_route?source=STREET1,1&dest=STREET2,2 HTTP/1.1
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
}
}
</pre>

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

Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|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
|Целое
|ИД автомобиля
|-
|start_time
|ГГГГММДДччммсс
|Время создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|finish_time
|ГГГГММДДччммсс
|Время завершения заказа
|-
|source
|Строка
|Адрес подачи
|-
|destination
|Строка
|Адрес назначения
|-
|passenger
|Строка
|Пассажир
|-
|phone
|Строка
|Номер телефона
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_order_state?order_id=1 HTTP/1.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
"start_time":"17.01.2013 12:56:41",
"source_time":"17.01.2013 13:26:17",
"finish_time":"17.01.2013 13:03:43",
"source":"1",
"destination":"2",
"passenger":"Слепаков",
"phone":"8800"
}
}
</pre>

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

Метод: POST

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|phone
|Строка, <= 16 символов
|Номер телефона
|-
|message
|Строка
|Текст СМС
|}

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

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

Пример:

<pre>
Запрос:

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

Signature: <...>

message=SMSText&phone=89050057216

Ответ:

{
"code":0,
"descr":"OK",
"data":{}
}
</pre>

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

Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|login
|Строка, <= 60 символов
|Логин
|-
|password
|Строка, <= 60 символов
|Пароль
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент с логином LOGIN и/или неверный пароль
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|client_id
|Целое
|ИД клиента
|}

Пример:

<pre>
Запрос:

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

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"client_id":131
}
}
</pre>

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

Метод: POST

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

Параметры:

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

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

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Клиент с номером телефона=PHONE уже существует
|-
|101
|Клиент с логином=LOGIN уже существует
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|client_id
|Целое
|ИД созданного клиента
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_order HTTP/1.1

Signature: <...>

Content-Type: application/x-www-form-urlencoded

Content-Length: 127

name=NAME&phones=88,99&login=LOGIN&password=PASSWORD&birthday=19930218115517&gender=male&address=ADDRESS

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"client_id":140
}
}
</pre>

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

Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

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

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

• "female" - женский
|-
|birthday
|ДД.ММ.ГГГГ
|Дата рождения
|-
|phones
|Строка
|Номера телефонов (через запятую)
|-
|balance
|Дробное
|Баланс
|-
|login
|Строка
|Логин
|-
|password
|Строка
|Пароль
|}

Пример:

<pre>
Запрос:

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

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"client_id":140,
"name":"Васильев Артём",
"number":"000140",
"address":"Бутово,45",
"gender":"male",
"birthday":"18.02.1993",
"phones":"[\"88\",\"99\"]",
"balance":1467,
"login":"artem",
"password":"vasilev"
}
}
</pre>

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

Метод: POST

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

Параметры:

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

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

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Клиент с номером телефона=PHONE уже существует
|-
|101
|Клиент с логином=LOGIN уже существует

|}

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

Пример:

<pre>
Запрос:

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

client_id=140&name=NAME&phones=88,99&login=LOGIN&password=PASSWORD&birthday=19930218115517&gender=male&address=ADDRESS

Ответ:

{
"code":0,
"descr":"OK",
"data":{}
}
</pre>

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

Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента (может отсутствовать, если phone заполнен)
|-
|phone
|Строка, <= 16 символов
|Телефон клиента (может отсутствовать, если client_id заполнен)
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|id
|Целое
|ИД заказа
|-
|state_id
|Целое
|ИД состояния заказа
|-
|start_time
|ГГГГММДДччммсс
|Дата создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|source
|Строка
|Адрес подачи
|-
|destination
|Строка
|Адрес назначения
|-
|passenger
|Строка
|Пассажир
|-
|crew_id
|Целое
|ИД экипажа
|-
|prior_crew_id
|Целое
|ИД предварительного экипажа
|-
|driver_id
|Целое
|ИД водителя
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_current_orders?client_id=140&phone=18 HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"orders":[
{
"id":20648,
"state_id":44,
"start_time":"20130204181111",
"source_time":"20130204181111",
"source":"1-й пр-т \/Москва\/,",
"destination":"12-й мкр,",
"passenger":"маша",
"crew_id":0,
"prior_crew_id":0,
"driver_id":0
},
{
"id":20670,
"state_id":44,
"start_time":"20130207153022",
"source_time":"20130207153022",
"source":"11-й мкр,",
"destination":"1-й пр-т \/Москва\/,",
"passenger":"саша",
"crew_id":0,
"prior_crew_id":0,
"driver_id":0
}
]
}
}
</pre>

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

Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента (может отсутствовать, если phone заполнен)
|-
|phone
|Строка, <= 16 символов
|Телефон клиента (может отсутствовать, если client_id заполнен)
|-
|start_time
|ГГГГММДДччммсс
|Начало периода
|-
|finish_time
|ГГГГММДДччммсс
|Конец периода
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|id
|Целое
|ИД заказа
|-
|state_id
|Целое
|ИД состояния заказа
|-
|start_time
|ГГГГММДДччммсс
|Время создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|finish_time
|ГГГГММДДччммсс
|Время завершения заказа
|-
|source
|Строка
|Адрес подачи
|-
|destination
|Строка
|Адрес назначения
|-
|passenger
|Строка
|Пассажир
|-
|sum
|Дробное
|Стоимость заказа без учета скидок(наценок)
|-
|crew_id
|Целое
|ИД экипажа
|-
|prior_crew_id
|Целое
|ИД предварительного экипажа
|-
|driver_id
|Целое
|ИД водителя
|-
|car_id
|Целое
|ИД автомобиля
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_finished_orders?client_id=140&phone= HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"orders":[
{
"id":20651,
"state_id":34,
"source_time":"20130205110812",
"start_time":"20130205110812",
"finish_time":"20130205115618",
"source":"прпроп",
"destination":"рррррр",
"passenger":"вера",
"sum":"908",
"crew_id":"6",
"prior_crew_id":0,
"driver_id":"4",
"car_id":"6"
},
{
"id":20669,
"state_id":34,
"source_time":"20130205130500",
"start_time":"20130205130500",
"finish_time":"20130205134511",
"source":"1",
"destination":"2",
"passenger":"маша",
"sum":"454",
"crew_id":"6",
"prior_crew_id":0,
"driver_id":"4",
"car_id":"6"
}
]
}
}
</pre>

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

Метод: POST

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента
|-
|oper_time
|ГГГГММДДччммсс
|Время создания операции
|-
|sum
|Дробное
|Сумма
|-
|oper_type
|Целое
|Тип операции:
• "receipt" - приход

• "expense" - расход
|-
|pay_type
|Целое
|Тип оплаты:
• "cash" - наличный

• "nocash" - безналичный
|-
!colspan="3"|Необязательные параметры
|-
|comment
|Строка
|Комментарий
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|oper_id
|Целое
|ИД операции
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_client_operation HTTP/1.1

Signature: <...>

Content-Type: application/x-www-form-urlencoded

Content-Length: 127

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

Ответ:

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

}
}
</pre>

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

Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента (может отсутствовать, если phone заполнен)
|-
|phone
|Целое
|Телефон клиента (может отсутствовать, если client_id заполнен)
|-
|start_time
|ГГГГММДДччммсс
|Начало периода
|-
|finish_time
|ГГГГММДДччммсс
|Конец периода
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|oper_id
|Целое
|ИД операции
|-
|oper_time
|ГГГГММДДччммсс
|Время создания операции
|-
|sum
|Дробное
|Сумма
|-
|order_id
|Целое
|Заказ, связанный с операцией
|-
|oper_type
|Целое
|Тип операции:
• "receipt" - приход
• "expense" - расход
|-
|pay_type
|Целое
|Тип оплаты:
• "cash" - наличный
• "nocash" - безналичный
|}

Пример:

<pre>
Запрос:

GET

https://ip:port/common_api/1.0/get_client_operations?client_id=112&start_time=20130201092112&finish_time=20130221092112 HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"operations":[
{
"oper_id":112,
"oper_time":"20130219091328",
"sum":"21,8",
"order_id":11800,
"oper_type":"receipt",
"pay_type":"cash",
"comment":"jgznm"
},
{
"oper_id":112,
"oper_time":"20130220112245",
"sum":"4500",
"order_id":11801,
"oper_type":"receipt",
"pay_type":"cash",
"comment":"блин"
}
]
}
}
</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 HTTP/1.1
</pre>

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

Пример:

<pre>
GET https://ip:port/tm_tapi/1.0/get_info_by_phone?phone=89058800565&fields=PHONE_TYPEPHONE_
TO_DIAL&signature=661ce071eeefcb4f7fc8bc1f17bd520b HTTP/1.1
</pre>

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

Пример:

<pre>
POST https://ip:port/tm_tapi/1.0/change_order_state HTTP/1.1
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 HTTP/1.1

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

Signature = MD5("phone=89058800565&fields=PHONE_TYPE" + "321") = ef17ea682d09e452af544a5758dba396
HTTP/1.1
</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 - если звонит номер из справочника телефоны; 0 - неизвестный номер)
|-
|PHONE_TO_DIAL
|Строка, <= 16 символов
|Номер телефона для отзвона по заказу
|-
|CREW_ID
|Целое
|ИД экипажа
|-
|IS_PRIOR
|true или false
|Признак предварительного заказа
|-
|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
|Целое
|ИД группы экипажа
|-
|CLIENT_BALANCE
|Дробное
|Баланс клиента
|-
|DRIVER_TIMECOUNT
|Целое
|Время пути водителя до адреса подачи в минутах
|-
|SOURCE_TIMECOUNT
|Целое
|Время оставшееся до подачи в минутах
|-
|SOUND_COLOR
|Строка
|Запись с информацией о цвете
|-
|SOUND_GOSNUMBER
|Строка
|Запись с информацией о государственном номере автомобиля
|-
|SOUND_MARK
|Строка
|Запись с информацией о марке автомобиля
|-
|GOSNUMBER
|Строка
|Государственный номер автомобиля
|-
|CAR_COLOR
|Строка
|Цвет автомобиля
|-
|CAR_MARK
|Строка
|Марка автомобиля
|-
|ORDER_COORDS
|Строка
|Координаты места подачи
|-
|CREW_COORDS
|Строка
|Координаты назначенного экипажа
|}

Пример:

<pre>
Запрос:
GET https://ip:port/tm_tapi/1.0/get_info_by_phone?phone=89058800565l&fields=PHONE_TYPEPHONE_
TO_DIAL-CREW_ID-ORDER_ID&signature=d35ab2765f2968d48c096d5f5327db26 HTTP/1.1

Ответ:

<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>
</data>
</response>
</pre>

==== Запрос информации по ИД заказа ====

Метод: GET
Название запроса: get_info_by_order_id
Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|-
|fields
|Строка
|Список полей, которые необходимо вернуть. Поля перечисляются через ''-''
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

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

{|
!Параметр
!Тип
!Описание
|-
|DRIVER_SOURCETIME
|Строка, <= 16 символов
|Время до подачи в минутах, указанное водителем
|-
|SOUND_COLOR
|Строка
|Запись с информацией о цвете
|-
|MARK
|Строка
|Марка автомобиля
|-
|COLOR
|Строка
|Цвет автомобиля
|-
|GOSNUMBER
|Строка
|Государственный номер автомобиля
|-
|SOUND_MARK
|Строка
|Запись с информацией о марке автомобиля
|-
|CREWGROUPID
|Целое
|ИД группы экипажа
|-
|IS_PRIOR
|true или false
|Признак предварительного заказа
|-
|DISCOUNTEDSUMM
|Строка
|Сумма заказа с учетом всех скидок
|-
|MOBILE_PHONE
|Строка, <= 16 символов
|Номер телефона водителя
|-
|CATEGORYID
|Целое
|ИД категории телефона
|-
|SOURCE_TIME
|Целое
|Время до подачи в минутах
|}

Пример:

<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
HTTP/1.1

Ответ:

<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></SOURCE_TIME>
</data>
</response>
</pre>

==== Смена состояния заказа ====
Метод: POST

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

Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|-
|need_state
|Целое
|Новое состояние заказа
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

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

{|
!Код
!Описание
|-
|100
|Заказ с таким ИД не найден.
|-
|101
|Изменение состояния не соответствует необходимым условиям.
|}

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

{|
!Параметр
!Тип
!Описание
|-
|ORDER_ID
|Целое
|ИД созданного заказа
|-
|NEW_STATE
|Целое
|Новое состояние заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/tm_tapi/1.0/change_order_state HTTP/1.1
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"|Обязательные параметры
|-
|RECORD_DATE
|ГГГГММДДччммсс
|Дата записи
|-
|RECORD_LENGTH
|Целое
|Продолжительность записи (в секундах)
|-
|PHONE
|Строка, <= 16 символов
|Номер телефона
|-
|ORDERID
|Целое
|Заказ, с которого сделана запись
|-
|USERID
|Целое
|Пользователь, сделавший запись
|-
|FILE_PATH
|Строка,<=255 символов
|Путь к файлу записи
|-
|RECORD_GUID
|Строка,<= 80 символов
|GUID звонка
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

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

{|
!Параметр
!Тип
!Описание
|-
|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: 206
RECORD_DATE=20121108145953&RECORD_LENGTH=6546&PHONE=654321&ORDERID=654&USERID=564&FILE_PATH=d%3A
%5CProjects%5Ctrunk%5C%5Ftrunk%5CTM%5CBin
%5C&RECORD_GUID=GUID456258&signature=cd11d50d65fa7e8ad73f80cdc7d296c7

Ответ:

<response>
<code>0</code>
<descr>OK</descr>
<data>
<RECORD_ID>25</RECORD_ID>
</data>
</response>
</pre>

==== Создать новый заказ ====

Метод: POST

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

Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|PHONE
|Строка, <= 16 символов
|Номер телефона
|-
|ORDER_STATE_ID
|Целое
|ИД состояния заказа
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|-
|colspan="3"|Необязательные параметры
|-
|CREW_GROUP_ID
|Целое
|ИД группы экипажа
|-
|TARIFF_ID
|Целое
|ИД тарифа
|-
|PHONE_PREFIX
|Строка
|Префикс, отрезаемый от номера телефона при поиске в базе данных. Для входящих звонков это код города с префиксом входящих номеров, обычно "8". Например, "83412"
|-
|DISCOUNTED_SU MM
|Строка
|Фиксированная сумма за заказ
|}

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

{|
!Код
!Описание
|-
|100
|Клиент не найден
|}

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

{|
!Параметр
!Тип
!Описание
|-
|ORDER_ID
|Целое
|ИД созданного заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/tm_tapi/1.0/make_new_order HTTP/1.1
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>
</pre>

== Пример формы для заказа такси ==
{{url|{{корень FTP|forms/zakaz_taxi.zip}}}}

Данная форма является примером, на основе которого можно построить собственную форму для принятия интернет-заказов. Форму можно использовать либо в исходном варианте, либо применяя запросы [[TM API#Описание запросов|TM API]].
Для того, чтобы данная форма функционировала, необходимо открыть файл в любом текстовом редакторе и указать корректные IP-адрес [[Сервер Такси-Мастер|сервера Такси-Мастер]], порт [[TM API#Параметры TM API|TM API]] и секретный ключ. Далее вам следует загрузить файл на хостинг.

Именно так будет выглядеть данная форма для заказа такси.
{{картинка|Форма для заказа такси.jpg}}

[[Категория:ТМ2]]

TM API

2013-10-01T15:29:13Z

AnnaNikolskih: /* Запрос операций по клиенту */

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

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

# Создать механизм приема заказов через интернет.
# Сделать ваш сайт более информативным: публиковать полезную для клиентов информацию прямо из системы - список ближайших [[Справочник «Экипажи»|экипажей]], предварительный расчет стоимости поездки, мониторинг движения автомобиля такси в процессе выполнения [[заказ]]а, [[Модуль «Интеграция с картами»|карты города]] и контактную информацию.
# Расширить возможности своей службы за счет популярного онлайн-сервиса Яндекс Такси.

== Параметры TM API ==
Задать настройки для корректной работы TM API вы сможете в программе [[Такси-Мастер]] в меню {{tab|Настройки}} в одноименной ветке {{tab|TM API}}.
Параметры организуют и контролируют работу [[Модуль «Интернет-заказы»|модуля «Интернет-заказы»]].
# Установите флажок {{checkbox|Использовать TM API}}, чтобы приступить к его использованию.
# В поле {{поле|Локальный порт}} введите номер порта подключения к интернету, на котором работает и будет ожидать запросы о новых заказах [[TMServer]]. Рекомендуется оставить номер порта по умолчанию.
# Установите флажок {{checkbox|Можно использовать данное рабочее место TMServer для распознавания адресов}} для того, чтобы конкретно с данного рабочего места происходило распознавание адресов модулем "Интернет-заказы".
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

=== Ветка «Открытое API» ===
В данной ветке регулируется доступ к синхронизации Такси-Мастер со сторонним сервисом (сайтом), с помощью которого клиенты будут создавать интернет-заказы. С примером кода для работы вы можете ознакомиться в данной статье в разделе [[TM API#Общее описание протокола|Общее описание протокола]].
# Установите флажок {{checkbox|Использовать открытое API}} для того, чтобы запустить работу по обслуживанию модуля «Интернет-заказы». При установленном флажке сервер [[Модуль «Интернет-заказы»|модуля «Интернет-заказы»]] запускается и ожидает запросы о новых заказах.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы с модулем «Интернет-заказы», который будет выслан вам в письме от менеджера.
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

=== Ветка «API для телефонии» ===
В данной ветке регулируются настройки API для телефонии, т.е. взаимодействие [[Такси-Мастер]] с call-центром через программный интерфейс. С его помощью [[Call-центр Oktell|call-центр]] может дать команду Такси-Мастер создать [[зака]]з или запросить информацию о [[Справочник «Состояния заказа»|статусе текущего заказа]].
# Установите флажок {{checkbox|Использовать открытое API для телефонии}} для того, чтобы запустить работу по обслуживанию телефонии через API.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы.
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

=== Ветка «Платежные терминалы» ===
{{info|Ранее для связи [[Модуль интеграции с платежными системами|платежных систем]] и [[Такси-Мастер]] служила такая утилита, как TMWeb. В данный момент мы отказались от ее использования, а функции были распределены между двумя компонентами системы: TM API и [[TMServer]].}}

Параметры этой ветки отвечают за работу [[Модуль интеграции с платежными терминалами|модуля интеграции с платежными системами]].
# Установите флажок {{checkbox|Включить прием терминальных платежей}}. Данная функция позволит отображать все платежные операции по приходу средств от водителей через терминалы в [[База данных Такси-Мастер 2|базе данных]] программы.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы с платежными системами и сверки платежей, который будет выслан вам в письме от менеджера. Секретный ключ - это определенный набор символов, необходимый для формирования подписи при передаче информации о платеже.
# В полях {{поле|Логин}} и {{поле|Пароль}} введите данные учетной записи на сайте http://term.bitmaster.ru.
# Кнопка {{кнопка|Задать всем водителям терминальный аккаунт по их ИД}} служит для соединения TM API с сервером Такси-Мастер. В результате соединения записи о терминальных аккаунтах генерируются, заносятся (для тех водителей, у которых они отсутствуют) и обновляются (для тех водителей, у которых уже существуют терминальные аккаунты) в Такси-Мастер.
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

{{info|Обратите внимание, что для платежных систем также существует открытый и свободно распространяемый API, с помощью которого есть возможность связать [[Такси-Мастер]] и [[Модуль интеграции с платежными системами|платежные системы]]. Обратитесь в отдел дополнительных услуг, написав на {{ящик ОДУ}}, за получением кода для данного компонента системы.}}

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

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

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

<pre>
GET https://ip:port/common_api/1.0/get_crew_groups_list HTTP/1.1
</pre>

Для получения данных из БД используются запросы типа GET. Для записи данных в [[База данных Такси-Мастер|базу данных]] используются запросы типа POST. В запросе типа GET параметры запроса передаются в URI. Пример:
<pre>
GET https://ip:port/common_api/1.0/calc_order_cost?tariff_id=1&distance_city=10 HTTP/1.1
Signature: <...>
</pre>

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

<pre>
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
</pre>

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

<pre>
Запрос:
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
</pre>

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

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

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

Существуют общие для всех запросов коды результатов:
{|
! Код
! Описание
|-
|0
|Успешное выполнение запроса
|-
|1
|Неизвестная ошибка
|-
|2
|Неизвестный тип API
|-
|3
|API отключено в настройках TMWeb
|-
|4
|Не совпадает секретный ключ
|-
|5
|Неподдерживаемая версия API
|-
|6
|Неизвестное название запроса
|-
|7
|Неверный тип запроса GET/POST
|-
|8
|Не хватает входного параметра (в доп. информации ответа будет название отсутствующего параметра)
|-
|9
|Некорректный входной параметр (в доп. информации ответа будет название некорректного параметра)
|-
|10
|Внутренняя ошибка обработки запроса
|}

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

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

Метод: GET или POST

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

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

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

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

Пример:

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

=== Запрос списка групп экипажей ===
Метод: GET

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

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

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

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crew_groups
|Массив
|Список групп экипажей
|-
|• id
|Целое
|ИД группы экипажей
|-
|• name
|Строка
|Название группы экипажей
|}

Пример:

<pre>
Запрос:

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

Ответ:

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

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

Метод: GET

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

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

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

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

{|
!Параметр
!Тип
!Описание
|-
|uds
|Массив
|Список служб [[Модуль «Единая диспетчерская служба»|ЕДС]]
|-
|• id
|Целое
|ИД службы [[Модуль «Единая диспетчерская служба»|ЕДС]]
|-
|• name
|Строка
|Название службы [[Модуль «Единая диспетчерская служба»|ЕДС]]
|}

Пример:

<pre>
Запрос:

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

Ответ:

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

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

Метод: GET

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

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

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

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

{|
!Параметр
!Тип
!Описание
|-
|tariffs
|Массив
|Список [[Справочник «Тарифы»|тарифов]]
|-
|• id
|Целое
|ИД [[Справочник «Тарифы»|тарифа]]
|-
|• name
|Строка
|Название [[Справочник «Тарифы»|тарифа]]
|-
|• is_active
|true или false
|Активный [[Справочник «Тарифы»|тариф]]
|}

Пример:

<pre>
Запрос:

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

Ответ:

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

=== Запрос списка услуг ===
Метод: GET

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

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

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

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

{|
!Параметр
!Тип
!Описание
|-
|services
|Массив
|Список [[Справочник «Услуги»|услуг]]
|-
|• id
|Целое
|ИД [[Справочник «Услуги»|услуги]]
|-
|• name
|Строка
|Название [[Справочник «Услуги»|услуги]]
|-
|• sum
|Дробное
|Абсолютная сумма [[Справочник «Услуги»|услуги]], руб
|-
|• percent
|Дробное
|Процент [[Справочник «Услуги»|услуги]] от стоимости заказа, %
|}

Пример:

<pre>
Запрос:

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

Ответ:

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

=== Запрос списка скидок ===
Метод: GET

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

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

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

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

{|
!Параметр
!Тип
!Описание
|-
|discounts
|Массив
|Список [[Справочник «Скидки клиентов»|скидок]]
|-
|• id
|Целое
|ИД [[Справочник «Скидки клиентов»|скидки]]
|-
|• name
|Строка
|Название [[Справочник «Скидки клиентов»|скидки]]
|-
|• sum
|Дробное
|Абсолютная сумма [[Справочник «Скидки клиентов»|скидки]], руб
|-
|• percent
|Дробное
|Процент [[Справочник «Скидки клиентов»|скидки]] от стоимости заказа, %
|}

Пример:

<pre>
Запрос:

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

Ответ:

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

=== Создание нового заказа ===
Метод: POST

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

Параметры:

{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|phone
|Строка, <= 16 символов
|Номер телефона
|-
|source
|Строка
|Адрес подачи
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
!colspan="3"|Необязательные параметры
|-
|dest
|Строка
|Адрес назначения
|-
|customer
|Строка
|Заказчик
|-
|comment
|Строка
|Комментарий
|-
|crew_group_id
|Целое
|ИД группы экипажей
|-
|uds_id
|Целое
|ИД службы ЕДС
|-
|tariff_id
|Целое
|ИД тарифа
|-
|is_prior
|true или false
|Предварительный заказ
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Заказ с такими параметрами уже создан
|-
|101
|Тариф не найден
|-
|102
|Группа экипажа не найдена
|-
|103
|Служба ЕДС не найдена
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|order_id
|Целое
|ИД созданного заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_order HTTP/1.1
Signature: <...>
Content-Type: application/x-www-form-urlencoded
Content-Length: 127
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

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"order_id":12345
}
}
</pre>

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

Метод: GET

Название запроса: calc_order_cost
{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|tariff_id
|Целое
|ИД тарифа
|-
Параметры:

!colspan="3"|Необязательные параметры
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|is_prior
|true или false
|Предварительный заказ
|-
|client_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»
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Тариф не найден
|-
|101
|Ошибка при расчете по тарифу
|-
|102
|Скидка не найдена
|-
|103
|Клиент не найден
|-
|104
|Район подачи не найден
|-
|105
|Район назначения не найден
|-
|106
|Дисконтная карта не найдена
|}

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

Пример:

<pre>
Запрос:

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

Ответ:

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

=== Запрос информации об экипаже ===
Метод: GET

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

Параметры:
{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|crew_id
|Целое
|ИД экипажа
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Экипаж не найден
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crew_id
|Целое
|ИД экипажа
|-
|code
|Строка
|Позывной экипажа
|-
|name
|Строка
|Наименование экипажа
|-
|driver_id
|Целое
|ИД водителя
|-
|car_id
|Целое
|ИД автомобиля
|-
|crew_group_id
|Целое
|ИД группы экипажа
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_crew_info?crew_id=1 HTTP/1.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
}
}
</pre>

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

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

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|driver_id
|Целое
|ИД водителя
|-
!colspan="3"|Необязательные параметры
|-
|need_photo
|true или false
|Нужна ли фотография водителя
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Водитель не найден
|}

Возвращаемые параметры в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|driver_id
|Целое
|ИД водителя
|-
|name
|Строка
|ФИО водителя
|-
|birthday
|ДД.ММ.ГГГГ
|День рождения водителя
|-
|car_id
|Целое
|ИД основного автомобиля водителя
|-
|license
|Строка
|Удостоверение водителя
|-
|home_phone
|Строка
|Домашний телефон водителя
|-
|mobile_phone
|Строка
|Мобильный телефон водителя
|-
|is_locked
|true или false
|Водитель заблокирован
|-
|is_dismissed
|true или false
|Водитель уволен
|-
|driver_photo
|Base64
|Фото водителя (только если need_photo = true)
|}

Пример:

<pre>
Запрос:

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",
"birthday":"01.01.1980",
"car_id":1,
"license":"1234567890",
"home_phone":"123456",
"mobile_phone":"+79123456789",
"is_locked":false,
"is_dismissed":false
}
}
</pre>

=== Запрос информации об автомобиле ===
Метод: GET

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

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|car_id
|Целое
|ИД автомобиля
|-
!colspan="3"|Необязательные параметры
|-
|need_photo
|true или false
|Нужна ли фотография автомобиля
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Автомобиль не найден
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|car_id
|Целое
|ИД автомобиля
|-
|name
|Строка
|Наименование автомобиля
|-
|code
|Строка
|Позывной автомобиля
|-
|gos_number
|Строка
|Государственный номер автомобиля
|-
|color
|Строка
|Цвет автомобиля
|-
|mark
|Строка
|Марка автомобиля
|-
|short_name
|Строка
|Краткое название автомобиля
|-
|production_year
|Целое
|Год выпуска автомобиля
|-
|car_photo
|Base64
|Фото автомобиля (только если need_photo = true)
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_car_info?car_id=1&need_photo=false HTTP/1.1
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
}
}
</pre>

=== Запрос координат экипажей ===
Метод: GET

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

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Необязательные параметры
|-
|crew_id
|Целое
|ИД экипажа, по которому нужно вернуть координаты. Если не задано, то будут возвращены координаты всех экипажей на линии.
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Координаты не найдены
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crews_coords
|Массив
|Список координат экипажей
|-
|• crew_id
|Целое
|ИД экипажа
|-
|• crew_code
|Строка
|Позывной экипажа
|-
|• coords_time
|ГГГГММДДччммсс
|Время получения координат
|-
|• lat
|Дробное
|Долгота
|-
|• lon
|Дробное
|Широта
|-
|• state_kind
|Строка
|Тип состояния экипажа. Может принимать значения:
• "not_available" — экипаж не на линии

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

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

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

Пример:

<pre>

Запрос:
GET https://ip:port/common_api/1.0/get_crews_coords HTTP/1.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"
},
{
"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 HTTP/1.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"
}
]
}
}
</pre>

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

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
! colspan="3"|Обязательные параметры
|-
|get_streets
|true или false
|Искать улицы
|-
|get_houses
|true или false
|Искать пункты
|-
|get_streets
|true или false
|Искать дома. Не может быть равно true, если get_streets = true или get_points = true.
|-
|street
|Строка
|Часть названия улицы или пункта, если идет поиск улиц или пунктов, или полное название улицы, если идет поиск домов
|-
!colspan="3"|Необязательные параметры
|-
|house
|Строка
|Часть номера дома. Нужно только если get_houses = true.
|-
|max_addresses_count
|Целое
|Максимальное количество адресов в ответе
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Подходящие адреса не найдены
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|addresses
|Массив
|Список подходящих адресов
|-
|• street
|Строка
|Название улицы или пункта
|-
|• house
|Строка
|Номер дома
|-
|• kind
|Строка
|Тип адреса. Может принимать значения:
• "street" — улица

• "house" — дом

• "point" — пункт
|-
|• comment
|Строка
|Комментарий
|}

Пример:

<pre>

Запрос:

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

Ответ:

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

Запрос:

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 HTTP/1.1
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":""
}
]
}
}
</pre>

=== Анализ маршрута ===
Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|source
|Строка
|Адрес подачи
|-
|dest
|Строка
|Адрес назначения
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Адрес подачи не распознан
|-
|101
|Адрес назначения не распознан
|-
|102
|Маршрут не распознан
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|source_lat
|Дробное
|Широта адреса подачи
|-
|source_lon
|Дробное
|Долгота адреса подачи
|-
|source_zone_id
|Целое
|ИД района подачи
|-
|dest_lat
|Дробное
|Широта адреса назначения
|-
|dest_lon
|Дробное
|Долгота адреса назначения
|-
|dest_zone_id
|Целое
|ИД района назначения
|-
|city_dist
|Дробное
|Километраж по городу
|-
|country_dist
|Дробное
|Километраж за городом
|-
|source_country_dist
|Дробное
|Километраж до адреса подачи, если адрес подачи за городом
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/analyze_route?source=STREET1,1&dest=STREET2,2 HTTP/1.1
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
}
}
</pre>

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

Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|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
|Целое
|ИД автомобиля
|-
|start_time
|ГГГГММДДччммсс
|Время создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|finish_time
|ГГГГММДДччммсс
|Время завершения заказа
|-
|source
|Строка
|Адрес подачи
|-
|destination
|Строка
|Адрес назначения
|-
|passenger
|Строка
|Пассажир
|-
|phone
|Строка
|Номер телефона
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_order_state?order_id=1 HTTP/1.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
"start_time":"17.01.2013 12:56:41",
"source_time":"17.01.2013 13:26:17",
"finish_time":"17.01.2013 13:03:43",
"source":"1",
"destination":"2",
"passenger":"Слепаков",
"phone":"8800"
}
}
</pre>

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

Метод: POST

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|phone
|Строка, <= 16 символов
|Номер телефона
|-
|message
|Строка
|Текст СМС
|}

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

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

Пример:

<pre>
Запрос:

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

Signature: <...>

message=SMSText&phone=89050057216

Ответ:

{
"code":0,
"descr":"OK",
"data":{}
}
</pre>

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

Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|login
|Строка, <= 60 символов
|Логин
|-
|password
|Строка, <= 60 символов
|Пароль
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент с логином LOGIN и/или неверный пароль
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|client_id
|Целое
|ИД клиента
|}

Пример:

<pre>
Запрос:

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

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"client_id":131
}
}
</pre>

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

Метод: POST

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

Параметры:

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

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

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Клиент с номером телефона=PHONE уже существует
|-
|101
|Клиент с логином=LOGIN уже существует
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|client_id
|Целое
|ИД созданного клиента
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_order HTTP/1.1

Signature: <...>

Content-Type: application/x-www-form-urlencoded

Content-Length: 127

name=NAME&phones=88,99&login=LOGIN&password=PASSWORD&birthday=19930218115517&gender=male&address=ADDRESS

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"client_id":140
}
}
</pre>

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

Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

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

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

• "female" - женский
|-
|birthday
|ДД.ММ.ГГГГ
|Дата рождения
|-
|phones
|Строка
|Номера телефонов (через запятую)
|-
|balance
|Дробное
|Баланс
|-
|login
|Строка
|Логин
|-
|password
|Строка
|Пароль
|}

Пример:

<pre>
Запрос:

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

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"client_id":140,
"name":"Васильев Артём",
"number":"000140",
"address":"Бутово,45",
"gender":"male",
"birthday":"18.02.1993",
"phones":"[\"88\",\"99\"]",
"balance":1467,
"login":"artem",
"password":"vasilev"
}
}
</pre>

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

Метод: POST

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

Параметры:

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

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

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Клиент с номером телефона=PHONE уже существует
|-
|101
|Клиент с логином=LOGIN уже существует

|}

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

Пример:

<pre>
Запрос:

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

client_id=140&name=NAME&phones=88,99&login=LOGIN&password=PASSWORD&birthday=19930218115517&gender=male&address=ADDRESS

Ответ:

{
"code":0,
"descr":"OK",
"data":{}
}
</pre>

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

Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента (может отсутствовать, если phone заполнен)
|-
|phone
|Строка, <= 16 символов
|Телефон клиента (может отсутствовать, если client_id заполнен)
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|id
|Целое
|ИД заказа
|-
|state_id
|Целое
|ИД состояния заказа
|-
|start_time
|ГГГГММДДччммсс
|Дата создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|source
|Строка
|Адрес подачи
|-
|destination
|Строка
|Адрес назначения
|-
|passenger
|Строка
|Пассажир
|-
|crew_id
|Целое
|ИД экипажа
|-
|prior_crew_id
|Целое
|ИД предварительного экипажа
|-
|driver_id
|Целое
|ИД водителя
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_current_orders?client_id=140&phone=18 HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"orders":[
{
"id":20648,
"state_id":44,
"start_time":"20130204181111",
"source_time":"20130204181111",
"source":"1-й пр-т \/Москва\/,",
"destination":"12-й мкр,",
"passenger":"маша",
"crew_id":0,
"prior_crew_id":0,
"driver_id":0
},
{
"id":20670,
"state_id":44,
"start_time":"20130207153022",
"source_time":"20130207153022",
"source":"11-й мкр,",
"destination":"1-й пр-т \/Москва\/,",
"passenger":"саша",
"crew_id":0,
"prior_crew_id":0,
"driver_id":0
}
]
}
}
</pre>

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

Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента (может отсутствовать, если phone заполнен)
|-
|phone
|Строка, <= 16 символов
|Телефон клиента (может отсутствовать, если client_id заполнен)
|-
|start_time
|ГГГГММДДччммсс
|Начало периода
|-
|finish_time
|ГГГГММДДччммсс
|Конец периода
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|id
|Целое
|ИД заказа
|-
|state_id
|Целое
|ИД состояния заказа
|-
|start_time
|ГГГГММДДччммсс
|Время создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|finish_time
|ГГГГММДДччммсс
|Время завершения заказа
|-
|source
|Строка
|Адрес подачи
|-
|destination
|Строка
|Адрес назначения
|-
|passenger
|Строка
|Пассажир
|-
|sum
|Дробное
|Стоимость заказа без учета скидок(наценок)
|-
|crew_id
|Целое
|ИД экипажа
|-
|prior_crew_id
|Целое
|ИД предварительного экипажа
|-
|driver_id
|Целое
|ИД водителя
|-
|car_id
|Целое
|ИД автомобиля
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_finished_orders?client_id=140&phone= HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"orders":[
{
"id":20651,
"state_id":34,
"source_time":"20130205110812",
"start_time":"20130205110812",
"finish_time":"20130205115618",
"source":"прпроп",
"destination":"рррррр",
"passenger":"вера",
"sum":"908",
"crew_id":"6",
"prior_crew_id":0,
"driver_id":"4",
"car_id":"6"
},
{
"id":20669,
"state_id":34,
"source_time":"20130205130500",
"start_time":"20130205130500",
"finish_time":"20130205134511",
"source":"1",
"destination":"2",
"passenger":"маша",
"sum":"454",
"crew_id":"6",
"prior_crew_id":0,
"driver_id":"4",
"car_id":"6"
}
]
}
}
</pre>

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

Метод: POST

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента
|-
|oper_time
|ГГГГММДДччммсс
|Время создания операции
|-
|sum
|Дробное
|Сумма
|-
|oper_type
|Целое
|Тип операции:
• "receipt" - приход

• "expense" - расход
|-
|pay_type
|Целое
|Тип оплаты:
• "cash" - наличный

• "nocash" - безналичный
|-
!colspan="3"|Необязательные параметры
|-
|comment
|Строка
|Комментарий
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|oper_id
|Целое
|ИД операции
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_client_operation HTTP/1.1

Signature: <...>

Content-Type: application/x-www-form-urlencoded

Content-Length: 127

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

Ответ:

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

}
}
</pre>

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

Метод: GET

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

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента (может отсутствовать, если phone заполнен)
|-
|phone
|Целое
|Телефон клиента (может отсутствовать, если client_id заполнен)
|-
|start_time
|ГГГГММДДччммсс
|Начало периода
|-
|finish_time
|ГГГГММДДччммсс
|Конец периода
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|oper_id
|Целое
|ИД операции
|-
|oper_time
|ГГГГММДДччммсс
|Время создания операции
|-
|sum
|Дробное
|Сумма
|-
|order_id
|Целое
|Заказ, связанный с операцией
|-
|oper_type
|Целое
|Тип операции:
• "receipt" - приход
• "expense" - расход
|-
|pay_type
|Целое
|Тип оплаты:
• "cash" - наличный
• "nocash" - безналичный
|}

Пример:

<pre>
Запрос:

GET

https://ip:port/common_api/1.0/get_client_operations?client_id=112&start_time=20130201092112&finish_time=20130221092112 HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"operations":[
{
"oper_id":112,
"oper_time":"20130219091328",
"sum":"21,8",
"order_id":11800,
"oper_type":"receipt",
"pay_type":"cash",
"comment":"jgznm"
},
{
"oper_id":112,
"oper_time":"20130220112245",
"sum":"4500",
"order_id":11801,
"oper_type":"receipt",
"pay_type":"cash",
"comment":"блин"
}
]
}
}
</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 HTTP/1.1
</pre>

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

Пример:

<pre>
GET https://ip:port/tm_tapi/1.0/get_info_by_phone?phone=89058800565&fields=PHONE_TYPEPHONE_
TO_DIAL&signature=661ce071eeefcb4f7fc8bc1f17bd520b HTTP/1.1
</pre>

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

Пример:

<pre>
POST https://ip:port/tm_tapi/1.0/change_order_state HTTP/1.1
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 HTTP/1.1

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

Signature = MD5("phone=89058800565&fields=PHONE_TYPE" + "321") = ef17ea682d09e452af544a5758dba396
HTTP/1.1
</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 - если звонит номер из справочника телефоны; 0 - неизвестный номер)
|-
|PHONE_TO_DIAL
|Строка, <= 16 символов
|Номер телефона для отзвона по заказу
|-
|CREW_ID
|Целое
|ИД экипажа
|-
|IS_PRIOR
|true или false
|Признак предварительного заказа
|-
|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
|Целое
|ИД группы экипажа
|-
|CLIENT_BALANCE
|Дробное
|Баланс клиента
|-
|DRIVER_TIMECOUNT
|Целое
|Время пути водителя до адреса подачи в минутах
|-
|SOURCE_TIMECOUNT
|Целое
|Время оставшееся до подачи в минутах
|-
|SOUND_COLOR
|Строка
|Запись с информацией о цвете
|-
|SOUND_GOSNUMBER
|Строка
|Запись с информацией о государственном номере автомобиля
|-
|SOUND_MARK
|Строка
|Запись с информацией о марке автомобиля
|-
|GOSNUMBER
|Строка
|Государственный номер автомобиля
|-
|CAR_COLOR
|Строка
|Цвет автомобиля
|-
|CAR_MARK
|Строка
|Марка автомобиля
|}

Пример:

<pre>
Запрос:
GET https://ip:port/tm_tapi/1.0/get_info_by_phone?phone=89058800565l&fields=PHONE_TYPEPHONE_
TO_DIAL-CREW_ID-ORDER_ID&signature=d35ab2765f2968d48c096d5f5327db26 HTTP/1.1

Ответ:

<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>
</data>
</response>
</pre>

==== Запрос информации по ИД заказа ====

Метод: GET
Название запроса: get_info_by_order_id
Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|-
|fields
|Строка
|Список полей, которые необходимо вернуть. Поля перечисляются через ''-''
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

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

{|
!Параметр
!Тип
!Описание
|-
|DRIVER_SOURCETIME
|Строка, <= 16 символов
|Время до подачи в минутах, указанное водителем
|-
|SOUND_COLOR
|Строка
|Запись с информацией о цвете
|-
|MARK
|Строка
|Марка автомобиля
|-
|COLOR
|Строка
|Цвет автомобиля
|-
|GOSNUMBER
|Строка
|Государственный номер автомобиля
|-
|SOUND_MARK
|Строка
|Запись с информацией о марке автомобиля
|-
|CREWGROUPID
|Целое
|ИД группы экипажа
|-
|IS_PRIOR
|true или false
|Признак предварительного заказа
|-
|DISCOUNTEDSUMM
|Строка
|Сумма заказа с учетом всех скидок
|-
|MOBILE_PHONE
|Строка, <= 16 символов
|Номер телефона водителя
|-
|CATEGORYID
|Целое
|ИД категории телефона
|-
|SOURCE_TIME
|Целое
|Время до подачи в минутах
|}

Пример:

<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
HTTP/1.1

Ответ:

<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></SOURCE_TIME>
</data>
</response>
</pre>

==== Смена состояния заказа ====
Метод: POST

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

Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|-
|need_state
|Целое
|Новое состояние заказа
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

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

{|
!Код
!Описание
|-
|100
|Заказ с таким ИД не найден.
|-
|101
|Изменение состояния не соответствует необходимым условиям.
|}

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

{|
!Параметр
!Тип
!Описание
|-
|ORDER_ID
|Целое
|ИД созданного заказа
|-
|NEW_STATE
|Целое
|Новое состояние заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/tm_tapi/1.0/change_order_state HTTP/1.1
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"|Обязательные параметры
|-
|RECORD_DATE
|ГГГГММДДччммсс
|Дата записи
|-
|RECORD_LENGTH
|Целое
|Продолжительность записи (в секундах)
|-
|PHONE
|Строка, <= 16 символов
|Номер телефона
|-
|ORDERID
|Целое
|Заказ, с которого сделана запись
|-
|USERID
|Целое
|Пользователь, сделавший запись
|-
|FILE_PATH
|Строка,<=255 символов
|Путь к файлу записи
|-
|RECORD_GUID
|Строка,<= 80 символов
|GUID звонка
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

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

{|
!Параметр
!Тип
!Описание
|-
|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: 206
RECORD_DATE=20121108145953&RECORD_LENGTH=6546&PHONE=654321&ORDERID=654&USERID=564&FILE_PATH=d%3A
%5CProjects%5Ctrunk%5C%5Ftrunk%5CTM%5CBin
%5C&RECORD_GUID=GUID456258&signature=cd11d50d65fa7e8ad73f80cdc7d296c7

Ответ:

<response>
<code>0</code>
<descr>OK</descr>
<data>
<RECORD_ID>25</RECORD_ID>
</data>
</response>
</pre>

==== Создать новый заказ ====

Метод: POST

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

Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|PHONE
|Строка, <= 16 символов
|Номер телефона
|-
|ORDER_STATE_ID
|Целое
|ИД состояния заказа
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|-
|colspan="3"|Необязательные параметры
|-
|CREW_GROUP_ID
|Целое
|ИД группы экипажа
|-
|TARIFF_ID
|Целое
|ИД тарифа
|-
|PHONE_PREFIX
|Строка
|Префикс, отрезаемый от номера телефона при поиске в базе данных. Для входящих звонков это код города с префиксом входящих номеров, обычно "8". Например, "83412"
|-
|DISCOUNTED_SU MM
|Строка
|Фиксированная сумма за заказ
|}

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

{|
!Код
!Описание
|-
|100
|Клиент не найден
|}

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

{|
!Параметр
!Тип
!Описание
|-
|ORDER_ID
|Целое
|ИД созданного заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/tm_tapi/1.0/make_new_order HTTP/1.1
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>
</pre>

== Пример формы для заказа такси ==
{{url|{{корень FTP|forms/zakaz_taxi.zip}}}}

Данная форма является примером, на основе которого можно построить собственную форму для принятия интернет-заказов. Форму можно использовать либо в исходном варианте, либо применяя запросы [[TM API#Описание запросов|TM API]].
Для того, чтобы данная форма функционировала, необходимо открыть файл в любом текстовом редакторе и указать корректные IP-адрес [[Сервер Такси-Мастер|сервера Такси-Мастер]], порт [[TM API#Параметры TM API|TM API]] и секретный ключ. Далее вам следует загрузить файл на хостинг.

Именно так будет выглядеть данная форма для заказа такси.
{{картинка|Форма для заказа такси.jpg}}

[[Категория:ТМ2]]

TM API

2013-10-01T15:19:59Z

AnnaNikolskih: /* Запрос выполненных заказов */

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

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

# Создать механизм приема заказов через интернет.
# Сделать ваш сайт более информативным: публиковать полезную для клиентов информацию прямо из системы - список ближайших [[Справочник «Экипажи»|экипажей]], предварительный расчет стоимости поездки, мониторинг движения автомобиля такси в процессе выполнения [[заказ]]а, [[Модуль «Интеграция с картами»|карты города]] и контактную информацию.
# Расширить возможности своей службы за счет популярного онлайн-сервиса Яндекс Такси.

== Параметры TM API ==
Задать настройки для корректной работы TM API вы сможете в программе [[Такси-Мастер]] в меню {{tab|Настройки}} в одноименной ветке {{tab|TM API}}.
Параметры организуют и контролируют работу [[Модуль «Интернет-заказы»|модуля «Интернет-заказы»]].
# Установите флажок {{checkbox|Использовать TM API}}, чтобы приступить к его использованию.
# В поле {{поле|Локальный порт}} введите номер порта подключения к интернету, на котором работает и будет ожидать запросы о новых заказах [[TMServer]]. Рекомендуется оставить номер порта по умолчанию.
# Установите флажок {{checkbox|Можно использовать данное рабочее место TMServer для распознавания адресов}} для того, чтобы конкретно с данного рабочего места происходило распознавание адресов модулем "Интернет-заказы".
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

=== Ветка «Открытое API» ===
В данной ветке регулируется доступ к синхронизации Такси-Мастер со сторонним сервисом (сайтом), с помощью которого клиенты будут создавать интернет-заказы. С примером кода для работы вы можете ознакомиться в данной статье в разделе [[TM API#Общее описание протокола|Общее описание протокола]].
# Установите флажок {{checkbox|Использовать открытое API}} для того, чтобы запустить работу по обслуживанию модуля «Интернет-заказы». При установленном флажке сервер [[Модуль «Интернет-заказы»|модуля «Интернет-заказы»]] запускается и ожидает запросы о новых заказах.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы с модулем «Интернет-заказы», который будет выслан вам в письме от менеджера.
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

=== Ветка «API для телефонии» ===
В данной ветке регулируются настройки API для телефонии, т.е. взаимодействие [[Такси-Мастер]] с call-центром через программный интерфейс. С его помощью [[Call-центр Oktell|call-центр]] может дать команду Такси-Мастер создать [[зака]]з или запросить информацию о [[Справочник «Состояния заказа»|статусе текущего заказа]].
# Установите флажок {{checkbox|Использовать открытое API для телефонии}} для того, чтобы запустить работу по обслуживанию телефонии через API.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы.
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

=== Ветка «Платежные терминалы» ===
{{info|Ранее для связи [[Модуль интеграции с платежными системами|платежных систем]] и [[Такси-Мастер]] служила такая утилита, как TMWeb. В данный момент мы отказались от ее использования, а функции были распределены между двумя компонентами системы: TM API и [[TMServer]].}}

Параметры этой ветки отвечают за работу [[Модуль интеграции с платежными терминалами|модуля интеграции с платежными системами]].
# Установите флажок {{checkbox|Включить прием терминальных платежей}}. Данная функция позволит отображать все платежные операции по приходу средств от водителей через терминалы в [[База данных Такси-Мастер 2|базе данных]] программы.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы с платежными системами и сверки платежей, который будет выслан вам в письме от менеджера. Секретный ключ - это определенный набор символов, необходимый для формирования подписи при передаче информации о платеже.
# В полях {{поле|Логин}} и {{поле|Пароль}} введите данные учетной записи на сайте http://term.bitmaster.ru.
# Кнопка {{кнопка|Задать всем водителям терминальный аккаунт по их ИД}} служит для соединения TM API с сервером Такси-Мастер. В результате соединения записи о терминальных аккаунтах генерируются, заносятся (для тех водителей, у которых они отсутствуют) и обновляются (для тех водителей, у которых уже существуют терминальные аккаунты) в Такси-Мастер.
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

{{info|Обратите внимание, что для платежных систем также существует открытый и свободно распространяемый API, с помощью которого есть возможность связать [[Такси-Мастер]] и [[Модуль интеграции с платежными системами|платежные системы]]. Обратитесь в отдел дополнительных услуг, написав на {{ящик ОДУ}}, за получением кода для данного компонента системы.}}

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

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

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

<pre>
GET https://ip:port/common_api/1.0/get_crew_groups_list HTTP/1.1
</pre>

Для получения данных из БД используются запросы типа GET. Для записи данных в [[База данных Такси-Мастер|базу данных]] используются запросы типа POST. В запросе типа GET параметры запроса передаются в URI. Пример:
<pre>
GET https://ip:port/common_api/1.0/calc_order_cost?tariff_id=1&distance_city=10 HTTP/1.1
Signature: <...>
</pre>

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

<pre>
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
</pre>

В любом запросе обязательно должен быть заголовок Signature. В нем передается MD5 хэш, рассчитанный для строки, которая получается сцеплением строки параметров запроса с секретным ключом. Секретный ключ задается в настройках модуля TMWeb в ТМ2. Пример:

<pre>
Запрос:
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
</pre>

=== Формат ответа ===

TMWeb всегда возвращает HTTP код 200 ОК. Результат выполнения запроса содержится в теле ответа в формате JSON. Общий вид возвращаемого результата:

<pre>
{
"code":<Числовой код результата>,
"descr":"<Строковое описание результата>",
"data":{<Дополнительная информация>}
}
</pre>

Существуют общие для всех запросов коды результатов:
{|
! Код
! Описание
|-
|0
|Успешное выполнение запроса
|-
|1
|Неизвестная ошибка
|-
|2
|Неизвестный тип API
|-
|3
|API отключено в настройках TMWeb
|-
|4
|Не совпадает секретный ключ
|-
|5
|Неподдерживаемая версия API
|-
|6
|Неизвестное название запроса
|-
|7
|Неверный тип запроса GET/POST
|-
|8
|Не хватает входного параметра (в доп. информации ответа будет название отсутствующего параметра)
|-
|9
|Некорректный входной параметр (в доп. информации ответа будет название некорректного параметра)
|-
|10
|Внутренняя ошибка обработки запроса
|}

== Описание запросов ==

=== Запрос-пинг ===
Для данного запроса не проверяется версия API, секретный ключ и тип запроса GET/ POST.

Метод: GET или POST

Название запроса: ping

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример:

<pre>
Запрос:
GET https://ip:port/common_api/1.0/ping HTTP/1.1
Ответ:
{
"code":0,
"descr":"OK",
"data":{}
}
</pre>

=== Запрос списка групп экипажей ===
Метод: GET

Название запроса: get_crew_groups_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crew_groups
|Массив
|Список групп экипажей
|-
|• id
|Целое
|ИД группы экипажей
|-
|• name
|Строка
|Название группы экипажей
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_crew_groups_list HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"crew_groups":[
{
"id":1,
"name":"CREW_GROUP1"
},
{
"id":2,
"name":"CREW_GROUP2"
}
]
}
}
</pre>

=== Запрос списка служб ЕДС ===

Метод: GET

Название запроса: get_uds_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр
!Тип
!Описание
|-
|uds
|Массив
|Список служб [[Модуль «Единая диспетчерская служба»|ЕДС]]
|-
|• id
|Целое
|ИД службы [[Модуль «Единая диспетчерская служба»|ЕДС]]
|-
|• name
|Строка
|Название службы [[Модуль «Единая диспетчерская служба»|ЕДС]]
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_uds_list HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"uds":[
{
"id":1,
"name":"UDS1"
},
{
"id":2,
"name":"UDS2"
}
]
}
}
</pre>

=== Запрос списка тарифов ===

Метод: GET

Название запроса: get_tariffs_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр
!Тип
!Описание
|-
|tariffs
|Массив
|Список [[Справочник «Тарифы»|тарифов]]
|-
|• id
|Целое
|ИД [[Справочник «Тарифы»|тарифа]]
|-
|• name
|Строка
|Название [[Справочник «Тарифы»|тарифа]]
|-
|• is_active
|true или false
|Активный [[Справочник «Тарифы»|тариф]]
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_tariffs_list HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"tariffs":[
{
"id":1,
"name":"TARIFF1"
"is_active":true
},
{
"id":2,
"name":"TARIFF2"
"is_active":true
}
]
}
}
</pre>

=== Запрос списка услуг ===
Метод: GET

Название запроса: get_services_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр
!Тип
!Описание
|-
|services
|Массив
|Список [[Справочник «Услуги»|услуг]]
|-
|• id
|Целое
|ИД [[Справочник «Услуги»|услуги]]
|-
|• name
|Строка
|Название [[Справочник «Услуги»|услуги]]
|-
|• sum
|Дробное
|Абсолютная сумма [[Справочник «Услуги»|услуги]], руб
|-
|• percent
|Дробное
|Процент [[Справочник «Услуги»|услуги]] от стоимости заказа, %
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_services_list HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"services":[
{
"id":1,
"name":"SERVICE1",
"sum":100,
"percent":0
},
{
"id":2,
"name":"SERVICE2"
"sum":0,
"percent":10
}
]
}
}
</pre>

=== Запрос списка скидок ===
Метод: GET

Название запроса: get_discounts_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр
!Тип
!Описание
|-
|discounts
|Массив
|Список [[Справочник «Скидки клиентов»|скидок]]
|-
|• id
|Целое
|ИД [[Справочник «Скидки клиентов»|скидки]]
|-
|• name
|Строка
|Название [[Справочник «Скидки клиентов»|скидки]]
|-
|• sum
|Дробное
|Абсолютная сумма [[Справочник «Скидки клиентов»|скидки]], руб
|-
|• percent
|Дробное
|Процент [[Справочник «Скидки клиентов»|скидки]] от стоимости заказа, %
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_discounts_list HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"discounts":[
{
"id":1,
"name":"DISCOUNT1",
"sum":100,
"percent":0
},
{
"id":2,
"name":"DISCOUNT2"
"sum":0,
"percent":10
}
]
}
}
</pre>

=== Создание нового заказа ===
Метод: POST

Название запроса: create_order

Параметры:

{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|phone
|Строка, <= 16 символов
|Номер телефона
|-
|source
|Строка
|Адрес подачи
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
!colspan="3"|Необязательные параметры
|-
|dest
|Строка
|Адрес назначения
|-
|customer
|Строка
|Заказчик
|-
|comment
|Строка
|Комментарий
|-
|crew_group_id
|Целое
|ИД группы экипажей
|-
|uds_id
|Целое
|ИД службы ЕДС
|-
|tariff_id
|Целое
|ИД тарифа
|-
|is_prior
|true или false
|Предварительный заказ
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Заказ с такими параметрами уже создан
|-
|101
|Тариф не найден
|-
|102
|Группа экипажа не найдена
|-
|103
|Служба ЕДС не найдена
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|order_id
|Целое
|ИД созданного заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_order HTTP/1.1
Signature: <...>
Content-Type: application/x-www-form-urlencoded
Content-Length: 127
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

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"order_id":12345
}
}
</pre>

=== Расчет суммы заказа ===

Метод: GET

Название запроса: calc_order_cost
{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|tariff_id
|Целое
|ИД тарифа
|-
Параметры:

!colspan="3"|Необязательные параметры
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|is_prior
|true или false
|Предварительный заказ
|-
|client_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»
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Тариф не найден
|-
|101
|Ошибка при расчете по тарифу
|-
|102
|Скидка не найдена
|-
|103
|Клиент не найден
|-
|104
|Район подачи не найден
|-
|105
|Район назначения не найден
|-
|106
|Дисконтная карта не найдена
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|sum
|Дробное
|Рассчитанная общая сумма заказа
|-
|info
|Массив
|Дополнительная информация по расчету суммы заказа
|-
| • comment
|Строка
|Описание позиции дополнительной информации по расчету суммы заказа
|-
| • sum
|Строка
|Сумма позиции дополнительной информации по расчету суммы заказа
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/calc_order_cost?
tariff_id=1&source_time=20120501100000&is_prior=false&client_id=1&discount_id=1&disc_card_id=1&sour
ce_zone_id=1&dest_zone_id=2&distance_city=10&distance_country=20&source_distance_country=5&is_count
ry=true&waiting_minutes=10&is_hourly=false&hourly_minutes=60&is_prize=true&back_way=false&services=
1;2;3 HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"sum":1000,
"info":[
{
"comment":"SUM1",
"sum":"100"
},
{
"comment":"SUM2",
"sum":"200"
}
]
}
}
</pre>

=== Запрос информации об экипаже ===
Метод: GET

Название запроса: get_crew_info

Параметры:
{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|crew_id
|Целое
|ИД экипажа
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Экипаж не найден
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crew_id
|Целое
|ИД экипажа
|-
|code
|Строка
|Позывной экипажа
|-
|name
|Строка
|Наименование экипажа
|-
|driver_id
|Целое
|ИД водителя
|-
|car_id
|Целое
|ИД автомобиля
|-
|crew_group_id
|Целое
|ИД группы экипажа
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_crew_info?crew_id=1 HTTP/1.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
}
}
</pre>

=== Запрос информации о водителе ===
Метод: GET

Название запроса: get_driver_info

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|driver_id
|Целое
|ИД водителя
|-
!colspan="3"|Необязательные параметры
|-
|need_photo
|true или false
|Нужна ли фотография водителя
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Водитель не найден
|}

Возвращаемые параметры в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|driver_id
|Целое
|ИД водителя
|-
|name
|Строка
|ФИО водителя
|-
|birthday
|ДД.ММ.ГГГГ
|День рождения водителя
|-
|car_id
|Целое
|ИД основного автомобиля водителя
|-
|license
|Строка
|Удостоверение водителя
|-
|home_phone
|Строка
|Домашний телефон водителя
|-
|mobile_phone
|Строка
|Мобильный телефон водителя
|-
|is_locked
|true или false
|Водитель заблокирован
|-
|is_dismissed
|true или false
|Водитель уволен
|-
|driver_photo
|Base64
|Фото водителя (только если need_photo = true)
|}

Пример:

<pre>
Запрос:

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",
"birthday":"01.01.1980",
"car_id":1,
"license":"1234567890",
"home_phone":"123456",
"mobile_phone":"+79123456789",
"is_locked":false,
"is_dismissed":false
}
}
</pre>

=== Запрос информации об автомобиле ===
Метод: GET

Название запроса: get_car_info

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|car_id
|Целое
|ИД автомобиля
|-
!colspan="3"|Необязательные параметры
|-
|need_photo
|true или false
|Нужна ли фотография автомобиля
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Автомобиль не найден
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|car_id
|Целое
|ИД автомобиля
|-
|name
|Строка
|Наименование автомобиля
|-
|code
|Строка
|Позывной автомобиля
|-
|gos_number
|Строка
|Государственный номер автомобиля
|-
|color
|Строка
|Цвет автомобиля
|-
|mark
|Строка
|Марка автомобиля
|-
|short_name
|Строка
|Краткое название автомобиля
|-
|production_year
|Целое
|Год выпуска автомобиля
|-
|car_photo
|Base64
|Фото автомобиля (только если need_photo = true)
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_car_info?car_id=1&need_photo=false HTTP/1.1
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
}
}
</pre>

=== Запрос координат экипажей ===
Метод: GET

Название запроса: get_crews_coords

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Необязательные параметры
|-
|crew_id
|Целое
|ИД экипажа, по которому нужно вернуть координаты. Если не задано, то будут возвращены координаты всех экипажей на линии.
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Координаты не найдены
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crews_coords
|Массив
|Список координат экипажей
|-
|• crew_id
|Целое
|ИД экипажа
|-
|• crew_code
|Строка
|Позывной экипажа
|-
|• coords_time
|ГГГГММДДччммсс
|Время получения координат
|-
|• lat
|Дробное
|Долгота
|-
|• lon
|Дробное
|Широта
|-
|• state_kind
|Строка
|Тип состояния экипажа. Может принимать значения:
• "not_available" — экипаж не на линии

• "waiting" — экипаж свободен, ожидает заказы

• "on_order" — экипаж на заказе

• "on_break" — экипаж на перерыве
|}

Пример:

<pre>

Запрос:
GET https://ip:port/common_api/1.0/get_crews_coords HTTP/1.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"
},
{
"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 HTTP/1.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"
}
]
}
}
</pre>

=== Запрос адресов, содержащих нужную строку ===
Метод: GET

Название запроса: get_addresses_like

Параметры:

{|
!Параметры
!Тип
!Описание
|-
! colspan="3"|Обязательные параметры
|-
|get_streets
|true или false
|Искать улицы
|-
|get_houses
|true или false
|Искать пункты
|-
|get_streets
|true или false
|Искать дома. Не может быть равно true, если get_streets = true или get_points = true.
|-
|street
|Строка
|Часть названия улицы или пункта, если идет поиск улиц или пунктов, или полное название улицы, если идет поиск домов
|-
!colspan="3"|Необязательные параметры
|-
|house
|Строка
|Часть номера дома. Нужно только если get_houses = true.
|-
|max_addresses_count
|Целое
|Максимальное количество адресов в ответе
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Подходящие адреса не найдены
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|addresses
|Массив
|Список подходящих адресов
|-
|• street
|Строка
|Название улицы или пункта
|-
|• house
|Строка
|Номер дома
|-
|• kind
|Строка
|Тип адреса. Может принимать значения:
• "street" — улица

• "house" — дом

• "point" — пункт
|-
|• comment
|Строка
|Комментарий
|}

Пример:

<pre>

Запрос:

GET https://ip:port/common_api/1.0/get_addresses_like?get_streets=true&get_points=true&
get_houses=false&street=STREE HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"addresses":[
{
"street":"STREET1",
"house":"",
"kind":"street",
"comment":""
},
{
"street":"STREET2",
"house":"",
"kind":"street",
"comment":""
},
{
"street":"POINT_STREET1",
"house":"",
"kind":"point",
"comment":"Point at street STREET1"
}
]
}
}

Запрос:

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 HTTP/1.1
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":""
}
]
}
}
</pre>

=== Анализ маршрута ===
Метод: GET

Название запроса: analyze_route

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|source
|Строка
|Адрес подачи
|-
|dest
|Строка
|Адрес назначения
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Адрес подачи не распознан
|-
|101
|Адрес назначения не распознан
|-
|102
|Маршрут не распознан
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|source_lat
|Дробное
|Широта адреса подачи
|-
|source_lon
|Дробное
|Долгота адреса подачи
|-
|source_zone_id
|Целое
|ИД района подачи
|-
|dest_lat
|Дробное
|Широта адреса назначения
|-
|dest_lon
|Дробное
|Долгота адреса назначения
|-
|dest_zone_id
|Целое
|ИД района назначения
|-
|city_dist
|Дробное
|Километраж по городу
|-
|country_dist
|Дробное
|Километраж за городом
|-
|source_country_dist
|Дробное
|Километраж до адреса подачи, если адрес подачи за городом
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/analyze_route?source=STREET1,1&dest=STREET2,2 HTTP/1.1
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
}
}
</pre>

=== Запрос информации о состоянии заказа ===

Метод: GET

Название запроса: get_order_state

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|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
|Целое
|ИД автомобиля
|-
|start_time
|ГГГГММДДччммсс
|Время создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|finish_time
|ГГГГММДДччммсс
|Время завершения заказа
|-
|source
|Строка
|Адрес подачи
|-
|destination
|Строка
|Адрес назначения
|-
|passenger
|Строка
|Пассажир
|-
|phone
|Строка
|Номер телефона
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_order_state?order_id=1 HTTP/1.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
"start_time":"17.01.2013 12:56:41",
"source_time":"17.01.2013 13:26:17",
"finish_time":"17.01.2013 13:03:43",
"source":"1",
"destination":"2",
"passenger":"Слепаков",
"phone":"8800"
}
}
</pre>

=== Создание задачи СМС серверу ===

Метод: POST

Название запроса: send_sms

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|phone
|Строка, <= 16 символов
|Номер телефона
|-
|message
|Строка
|Текст СМС
|}

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример:

<pre>
Запрос:

POST /common_api/1.0/send_sms HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Content-Length: 33

Signature: <...>

message=SMSText&phone=89050057216

Ответ:

{
"code":0,
"descr":"OK",
"data":{}
}
</pre>

=== Проверка авторизации ===

Метод: GET

Название запроса: check_authorization

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|login
|Строка, <= 60 символов
|Логин
|-
|password
|Строка, <= 60 символов
|Пароль
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент с логином LOGIN и/или неверный пароль
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|client_id
|Целое
|ИД клиента
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/check_authorization?login=LOGIN&password=PASSWORD HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"client_id":131
}
}
</pre>

=== Регистрация клиента ===

Метод: POST

Название запроса: register_client

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|name
|Строка, <= 60 символов
|ФИО
|-
|login
|Строка, <= 60 символов
|Логин
|-
|password
|Строка, <= 60 символов
|Пароль
|-
|phones
|Строка
|Номера телефонов (через запятую)
|-
!colspan="3"|Необязательные параметры
|-
|address
|Строка
|Домашний адрес
|-
|birthday
|Строка
|Дата рождения
|-
|gender
|Строка
|Пол. Может принимать значения:
• "male" - мужской

• "female" - женский
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Клиент с номером телефона=PHONE уже существует
|-
|101
|Клиент с логином=LOGIN уже существует
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|client_id
|Целое
|ИД созданного клиента
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_order HTTP/1.1

Signature: <...>

Content-Type: application/x-www-form-urlencoded

Content-Length: 127

name=NAME&phones=88,99&login=LOGIN&password=PASSWORD&birthday=19930218115517&gender=male&address=ADDRESS

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"client_id":140
}
}
</pre>

=== Запрос информации по клиенту ===

Метод: GET

Название запроса: get_client_info

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|client_id
|Целое
|ИД клиента
|-
|name
|Строка
|ФИО
|-
|number
|Строка
|Номер договора
|-
|address
|Строка
|Домашний адрес
|-
|gender
|Строка
|Пол. Может принимать значения:

• "male" - мужской

• "female" - женский
|-
|birthday
|ДД.ММ.ГГГГ
|Дата рождения
|-
|phones
|Строка
|Номера телефонов (через запятую)
|-
|balance
|Дробное
|Баланс
|-
|login
|Строка
|Логин
|-
|password
|Строка
|Пароль
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_client_info?client_id=140 HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"client_id":140,
"name":"Васильев Артём",
"number":"000140",
"address":"Бутово,45",
"gender":"male",
"birthday":"18.02.1993",
"phones":"[\"88\",\"99\"]",
"balance":1467,
"login":"artem",
"password":"vasilev"
}
}
</pre>

=== Изменение информации по клиенту ===

Метод: POST

Название запроса: update_client_info

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента
|-
!colspan="3"|Необязательные параметры
|-
|name
|Строка, <= 60 символов
|ФИО
|-
|login
|Строка, <= 60 символов
|Логин
|-
|password
|Строка, <= 60 символов
|Пароль
|-
|phones
|Строка
|Номера телефонов (через запятую)
|-
|address
|Строка
|Домашний адрес
|-
|birthday
|Строка
|Дата рождения
|-
|gender
|Строка
|Пол. Может принимать значения:
• "male" - мужской

• "female" - женский
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Клиент с номером телефона=PHONE уже существует
|-
|101
|Клиент с логином=LOGIN уже существует

|}

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_order HTTP/1.1
Signature: <...>
Content-Type: application/x-www-form-urlencoded
Content-Length: 127

client_id=140&name=NAME&phones=88,99&login=LOGIN&password=PASSWORD&birthday=19930218115517&gender=male&address=ADDRESS

Ответ:

{
"code":0,
"descr":"OK",
"data":{}
}
</pre>

=== Запрос текущих заказов ===

Метод: GET

Название запроса: get_current_orders

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента (может отсутствовать, если phone заполнен)
|-
|phone
|Строка, <= 16 символов
|Телефон клиента (может отсутствовать, если client_id заполнен)
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|id
|Целое
|ИД заказа
|-
|state_id
|Целое
|ИД состояния заказа
|-
|start_time
|ГГГГММДДччммсс
|Дата создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|source
|Строка
|Адрес подачи
|-
|destination
|Строка
|Адрес назначения
|-
|passenger
|Строка
|Пассажир
|-
|crew_id
|Целое
|ИД экипажа
|-
|prior_crew_id
|Целое
|ИД предварительного экипажа
|-
|driver_id
|Целое
|ИД водителя
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_current_orders?client_id=140&phone=18 HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"orders":[
{
"id":20648,
"state_id":44,
"start_time":"20130204181111",
"source_time":"20130204181111",
"source":"1-й пр-т \/Москва\/,",
"destination":"12-й мкр,",
"passenger":"маша",
"crew_id":0,
"prior_crew_id":0,
"driver_id":0
},
{
"id":20670,
"state_id":44,
"start_time":"20130207153022",
"source_time":"20130207153022",
"source":"11-й мкр,",
"destination":"1-й пр-т \/Москва\/,",
"passenger":"саша",
"crew_id":0,
"prior_crew_id":0,
"driver_id":0
}
]
}
}
</pre>

=== Запрос выполненных заказов ===

Метод: GET

Название запроса: get_finished_orders

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента (может отсутствовать, если phone заполнен)
|-
|phone
|Строка, <= 16 символов
|Телефон клиента (может отсутствовать, если client_id заполнен)
|-
|start_time
|ГГГГММДДччммсс
|Начало периода
|-
|finish_time
|ГГГГММДДччммсс
|Конец периода
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|id
|Целое
|ИД заказа
|-
|state_id
|Целое
|ИД состояния заказа
|-
|start_time
|ГГГГММДДччммсс
|Время создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|finish_time
|ГГГГММДДччммсс
|Время завершения заказа
|-
|source
|Строка
|Адрес подачи
|-
|destination
|Строка
|Адрес назначения
|-
|passenger
|Строка
|Пассажир
|-
|sum
|Дробное
|Стоимость заказа без учета скидок(наценок)
|-
|crew_id
|Целое
|ИД экипажа
|-
|prior_crew_id
|Целое
|ИД предварительного экипажа
|-
|driver_id
|Целое
|ИД водителя
|-
|car_id
|Целое
|ИД автомобиля
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_finished_orders?client_id=140&phone= HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"orders":[
{
"id":20651,
"state_id":34,
"source_time":"20130205110812",
"start_time":"20130205110812",
"finish_time":"20130205115618",
"source":"прпроп",
"destination":"рррррр",
"passenger":"вера",
"sum":"908",
"crew_id":"6",
"prior_crew_id":0,
"driver_id":"4",
"car_id":"6"
},
{
"id":20669,
"state_id":34,
"source_time":"20130205130500",
"start_time":"20130205130500",
"finish_time":"20130205134511",
"source":"1",
"destination":"2",
"passenger":"маша",
"sum":"454",
"crew_id":"6",
"prior_crew_id":0,
"driver_id":"4",
"car_id":"6"
}
]
}
}
</pre>

=== Проведение операции по клиенту ===

Метод: POST

Название запроса: create_client_operation

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента
|-
|oper_time
|ГГГГММДДччммсс
|Время создания операции
|-
|sum
|Дробное
|Сумма
|-
|oper_type
|Целое
|Тип операции:
• "receipt" - приход

• "expense" - расход
|-
|pay_type
|Целое
|Тип оплаты:
• "cash" - наличный

• "nocash" - безналичный
|-
!colspan="3"|Необязательные параметры
|-
|comment
|Строка
|Комментарий
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|oper_id
|Целое
|ИД операции
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_client_operation HTTP/1.1

Signature: <...>

Content-Type: application/x-www-form-urlencoded

Content-Length: 127

client_id=112&oper_time=20130221100719&oper_sum=300&oper_type=receipt&pay_type=cash&comment=COMMENT

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"oper_id":31

}
}
</pre>

=== Запрос операций по клиенту ===

Метод: GET

Название запроса: get_client_operations

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента (может отсутствовать, если phone заполнен)
|-
|phone
|Строка, <= 16 символов
|Телефон клиента (может отсутствовать, если client_id заполнен)
|-
|start_time
|ГГГГММДДччммсс
|Начало периода
|-
|finish_time
|ГГГГММДДччммсс
|Конец периода
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|oper_id
|Целое
|ИД операции
|-
|oper_time
|ГГГГММДДччммсс
|Время создания операции
|-
|sum
|Дробное
|Сумма
|-
|order_id
|Целое
|Заказ, связанный с операцией
|-
|oper_type
|Целое
|Тип операции:
• "receipt" - приход
• "expense" - расход
|-
|pay_type
|Целое
|Тип оплаты:
• "cash" - наличный
• "nocash" - безналичный
|}

Пример:

<pre>
Запрос:

GET

https://ip:port/common_api/1.0/get_client_operations?client_id=112&start_time=20130201092112&finish_time=20130221092112 HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"operations":[
{
"oper_id":112,
"oper_time":"20130219091328",
"sum":"21,8",
"order_id":11800,
"oper_type":"receipt",
"pay_type":"cash",
"comment":"jgznm"
},
{
"oper_id":112,
"oper_time":"20130220112245",
"sum":"4500",
"order_id":11801,
"oper_type":"receipt",
"pay_type":"cash",
"comment":"блин"
}
]
}
}
</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 HTTP/1.1
</pre>

Для получения данных из БД используются запросы типа GET. Для записи данных в БД используются запросы типа POST. В запросе типа GET параметры запроса передаются в URI.

Пример:

<pre>
GET https://ip:port/tm_tapi/1.0/get_info_by_phone?phone=89058800565&fields=PHONE_TYPEPHONE_
TO_DIAL&signature=661ce071eeefcb4f7fc8bc1f17bd520b HTTP/1.1
</pre>

В запросе типа POST параметры передаются в теле запроса в формате application/x-wwwform-
urlencoded.

Пример:

<pre>
POST https://ip:port/tm_tapi/1.0/change_order_state HTTP/1.1
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 HTTP/1.1

Секретный ключ:
321

Signature = MD5("phone=89058800565&fields=PHONE_TYPE" + "321") = ef17ea682d09e452af544a5758dba396
HTTP/1.1
</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 - если звонит номер из справочника телефоны; 0 - неизвестный номер)
|-
|PHONE_TO_DIAL
|Строка, <= 16 символов
|Номер телефона для отзвона по заказу
|-
|CREW_ID
|Целое
|ИД экипажа
|-
|IS_PRIOR
|true или false
|Признак предварительного заказа
|-
|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
|Целое
|ИД группы экипажа
|-
|CLIENT_BALANCE
|Дробное
|Баланс клиента
|-
|DRIVER_TIMECOUNT
|Целое
|Время пути водителя до адреса подачи в минутах
|-
|SOURCE_TIMECOUNT
|Целое
|Время оставшееся до подачи в минутах
|-
|SOUND_COLOR
|Строка
|Запись с информацией о цвете
|-
|SOUND_GOSNUMBER
|Строка
|Запись с информацией о государственном номере автомобиля
|-
|SOUND_MARK
|Строка
|Запись с информацией о марке автомобиля
|-
|GOSNUMBER
|Строка
|Государственный номер автомобиля
|-
|CAR_COLOR
|Строка
|Цвет автомобиля
|-
|CAR_MARK
|Строка
|Марка автомобиля
|}

Пример:

<pre>
Запрос:
GET https://ip:port/tm_tapi/1.0/get_info_by_phone?phone=89058800565l&fields=PHONE_TYPEPHONE_
TO_DIAL-CREW_ID-ORDER_ID&signature=d35ab2765f2968d48c096d5f5327db26 HTTP/1.1

Ответ:

<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>
</data>
</response>
</pre>

==== Запрос информации по ИД заказа ====

Метод: GET
Название запроса: get_info_by_order_id
Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|-
|fields
|Строка
|Список полей, которые необходимо вернуть. Поля перечисляются через ''-''
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

Специальные возвращаемые коды: нет
Возвращаемые данные в случае успешного выполнения запроса: зависит от того какие поля были переданы в поле fields.

{|
!Параметр
!Тип
!Описание
|-
|DRIVER_SOURCETIME
|Строка, <= 16 символов
|Время до подачи в минутах, указанное водителем
|-
|SOUND_COLOR
|Строка
|Запись с информацией о цвете
|-
|MARK
|Строка
|Марка автомобиля
|-
|COLOR
|Строка
|Цвет автомобиля
|-
|GOSNUMBER
|Строка
|Государственный номер автомобиля
|-
|SOUND_MARK
|Строка
|Запись с информацией о марке автомобиля
|-
|CREWGROUPID
|Целое
|ИД группы экипажа
|-
|IS_PRIOR
|true или false
|Признак предварительного заказа
|-
|DISCOUNTEDSUMM
|Строка
|Сумма заказа с учетом всех скидок
|-
|MOBILE_PHONE
|Строка, <= 16 символов
|Номер телефона водителя
|-
|CATEGORYID
|Целое
|ИД категории телефона
|-
|SOURCE_TIME
|Целое
|Время до подачи в минутах
|}

Пример:

<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
HTTP/1.1

Ответ:

<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></SOURCE_TIME>
</data>
</response>
</pre>

==== Смена состояния заказа ====
Метод: POST

Название запроса: change_order_state

Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|-
|need_state
|Целое
|Новое состояние заказа
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

Специальные возвращаемые коды:

{|
!Код
!Описание
|-
|100
|Заказ с таким ИД не найден.
|-
|101
|Изменение состояния не соответствует необходимым условиям.
|}

Возвращаемые данные в случае успешного выполнения запроса

{|
!Параметр
!Тип
!Описание
|-
|ORDER_ID
|Целое
|ИД созданного заказа
|-
|NEW_STATE
|Целое
|Новое состояние заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/tm_tapi/1.0/change_order_state HTTP/1.1
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"|Обязательные параметры
|-
|RECORD_DATE
|ГГГГММДДччммсс
|Дата записи
|-
|RECORD_LENGTH
|Целое
|Продолжительность записи (в секундах)
|-
|PHONE
|Строка, <= 16 символов
|Номер телефона
|-
|ORDERID
|Целое
|Заказ, с которого сделана запись
|-
|USERID
|Целое
|Пользователь, сделавший запись
|-
|FILE_PATH
|Строка,<=255 символов
|Путь к файлу записи
|-
|RECORD_GUID
|Строка,<= 80 символов
|GUID звонка
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

Специальные возвращаемые коды: нет
Возвращаемые данные в случае успешного выполнения запроса

{|
!Параметр
!Тип
!Описание
|-
|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: 206
RECORD_DATE=20121108145953&RECORD_LENGTH=6546&PHONE=654321&ORDERID=654&USERID=564&FILE_PATH=d%3A
%5CProjects%5Ctrunk%5C%5Ftrunk%5CTM%5CBin
%5C&RECORD_GUID=GUID456258&signature=cd11d50d65fa7e8ad73f80cdc7d296c7

Ответ:

<response>
<code>0</code>
<descr>OK</descr>
<data>
<RECORD_ID>25</RECORD_ID>
</data>
</response>
</pre>

==== Создать новый заказ ====

Метод: POST

Название запроса: make_new_order

Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|PHONE
|Строка, <= 16 символов
|Номер телефона
|-
|ORDER_STATE_ID
|Целое
|ИД состояния заказа
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|-
|colspan="3"|Необязательные параметры
|-
|CREW_GROUP_ID
|Целое
|ИД группы экипажа
|-
|TARIFF_ID
|Целое
|ИД тарифа
|-
|PHONE_PREFIX
|Строка
|Префикс, отрезаемый от номера телефона при поиске в базе данных. Для входящих звонков это код города с префиксом входящих номеров, обычно "8". Например, "83412"
|-
|DISCOUNTED_SU MM
|Строка
|Фиксированная сумма за заказ
|}

Специальные возвращаемые коды:

{|
!Код
!Описание
|-
|100
|Клиент не найден
|}

Возвращаемые данные в случае успешного выполнения запроса

{|
!Параметр
!Тип
!Описание
|-
|ORDER_ID
|Целое
|ИД созданного заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/tm_tapi/1.0/make_new_order HTTP/1.1
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>
</pre>

== Пример формы для заказа такси ==
{{url|{{корень FTP|forms/zakaz_taxi.zip}}}}

Данная форма является примером, на основе которого можно построить собственную форму для принятия интернет-заказов. Форму можно использовать либо в исходном варианте, либо применяя запросы [[TM API#Описание запросов|TM API]].
Для того, чтобы данная форма функционировала, необходимо открыть файл в любом текстовом редакторе и указать корректные IP-адрес [[Сервер Такси-Мастер|сервера Такси-Мастер]], порт [[TM API#Параметры TM API|TM API]] и секретный ключ. Далее вам следует загрузить файл на хостинг.

Именно так будет выглядеть данная форма для заказа такси.
{{картинка|Форма для заказа такси.jpg}}

[[Категория:ТМ2]]

TM API

2013-10-01T15:11:39Z

AnnaNikolskih: /* Запрос текущих заказов */

'''TM API''' - специальный набор инструментов [[Такси-Мастер]], который позволит объединить систему с вашим сайтом и различными полезными сервисами. Он предоставляется вам на свободных условиях.

Благодаря этому набору вы сможете:

# Создать механизм приема заказов через интернет.
# Сделать ваш сайт более информативным: публиковать полезную для клиентов информацию прямо из системы - список ближайших [[Справочник «Экипажи»|экипажей]], предварительный расчет стоимости поездки, мониторинг движения автомобиля такси в процессе выполнения [[заказ]]а, [[Модуль «Интеграция с картами»|карты города]] и контактную информацию.
# Расширить возможности своей службы за счет популярного онлайн-сервиса Яндекс Такси.

== Параметры TM API ==
Задать настройки для корректной работы TM API вы сможете в программе [[Такси-Мастер]] в меню {{tab|Настройки}} в одноименной ветке {{tab|TM API}}.
Параметры организуют и контролируют работу [[Модуль «Интернет-заказы»|модуля «Интернет-заказы»]].
# Установите флажок {{checkbox|Использовать TM API}}, чтобы приступить к его использованию.
# В поле {{поле|Локальный порт}} введите номер порта подключения к интернету, на котором работает и будет ожидать запросы о новых заказах [[TMServer]]. Рекомендуется оставить номер порта по умолчанию.
# Установите флажок {{checkbox|Можно использовать данное рабочее место TMServer для распознавания адресов}} для того, чтобы конкретно с данного рабочего места происходило распознавание адресов модулем "Интернет-заказы".
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

=== Ветка «Открытое API» ===
В данной ветке регулируется доступ к синхронизации Такси-Мастер со сторонним сервисом (сайтом), с помощью которого клиенты будут создавать интернет-заказы. С примером кода для работы вы можете ознакомиться в данной статье в разделе [[TM API#Общее описание протокола|Общее описание протокола]].
# Установите флажок {{checkbox|Использовать открытое API}} для того, чтобы запустить работу по обслуживанию модуля «Интернет-заказы». При установленном флажке сервер [[Модуль «Интернет-заказы»|модуля «Интернет-заказы»]] запускается и ожидает запросы о новых заказах.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы с модулем «Интернет-заказы», который будет выслан вам в письме от менеджера.
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

=== Ветка «API для телефонии» ===
В данной ветке регулируются настройки API для телефонии, т.е. взаимодействие [[Такси-Мастер]] с call-центром через программный интерфейс. С его помощью [[Call-центр Oktell|call-центр]] может дать команду Такси-Мастер создать [[зака]]з или запросить информацию о [[Справочник «Состояния заказа»|статусе текущего заказа]].
# Установите флажок {{checkbox|Использовать открытое API для телефонии}} для того, чтобы запустить работу по обслуживанию телефонии через API.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы.
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

=== Ветка «Платежные терминалы» ===
{{info|Ранее для связи [[Модуль интеграции с платежными системами|платежных систем]] и [[Такси-Мастер]] служила такая утилита, как TMWeb. В данный момент мы отказались от ее использования, а функции были распределены между двумя компонентами системы: TM API и [[TMServer]].}}

Параметры этой ветки отвечают за работу [[Модуль интеграции с платежными терминалами|модуля интеграции с платежными системами]].
# Установите флажок {{checkbox|Включить прием терминальных платежей}}. Данная функция позволит отображать все платежные операции по приходу средств от водителей через терминалы в [[База данных Такси-Мастер 2|базе данных]] программы.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы с платежными системами и сверки платежей, который будет выслан вам в письме от менеджера. Секретный ключ - это определенный набор символов, необходимый для формирования подписи при передаче информации о платеже.
# В полях {{поле|Логин}} и {{поле|Пароль}} введите данные учетной записи на сайте http://term.bitmaster.ru.
# Кнопка {{кнопка|Задать всем водителям терминальный аккаунт по их ИД}} служит для соединения TM API с сервером Такси-Мастер. В результате соединения записи о терминальных аккаунтах генерируются, заносятся (для тех водителей, у которых они отсутствуют) и обновляются (для тех водителей, у которых уже существуют терминальные аккаунты) в Такси-Мастер.
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

{{info|Обратите внимание, что для платежных систем также существует открытый и свободно распространяемый API, с помощью которого есть возможность связать [[Такси-Мастер]] и [[Модуль интеграции с платежными системами|платежные системы]]. Обратитесь в отдел дополнительных услуг, написав на {{ящик ОДУ}}, за получением кода для данного компонента системы.}}

== Общее описание протокола ==

=== Формат запроса ===

[[TMAPI]] принимает входящие запросы по протоколу HTTPS. В URI запроса после ip адреса и порта, который будет слушать TMWeb, должно идти название API (common_api) и версия
API. Пример:

<pre>
GET https://ip:port/common_api/1.0/get_crew_groups_list HTTP/1.1
</pre>

Для получения данных из БД используются запросы типа GET. Для записи данных в [[База данных Такси-Мастер|базу данных]] используются запросы типа POST. В запросе типа GET параметры запроса передаются в URI. Пример:
<pre>
GET https://ip:port/common_api/1.0/calc_order_cost?tariff_id=1&distance_city=10 HTTP/1.1
Signature: <...>
</pre>

В запросе типа POST параметры передаются в теле запроса в формате application/x-wwwform-urlencoded. Пример:

<pre>
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
</pre>

В любом запросе обязательно должен быть заголовок Signature. В нем передается MD5 хэш, рассчитанный для строки, которая получается сцеплением строки параметров запроса с секретным ключом. Секретный ключ задается в настройках модуля TMWeb в ТМ2. Пример:

<pre>
Запрос:
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
</pre>

=== Формат ответа ===

TMWeb всегда возвращает HTTP код 200 ОК. Результат выполнения запроса содержится в теле ответа в формате JSON. Общий вид возвращаемого результата:

<pre>
{
"code":<Числовой код результата>,
"descr":"<Строковое описание результата>",
"data":{<Дополнительная информация>}
}
</pre>

Существуют общие для всех запросов коды результатов:
{|
! Код
! Описание
|-
|0
|Успешное выполнение запроса
|-
|1
|Неизвестная ошибка
|-
|2
|Неизвестный тип API
|-
|3
|API отключено в настройках TMWeb
|-
|4
|Не совпадает секретный ключ
|-
|5
|Неподдерживаемая версия API
|-
|6
|Неизвестное название запроса
|-
|7
|Неверный тип запроса GET/POST
|-
|8
|Не хватает входного параметра (в доп. информации ответа будет название отсутствующего параметра)
|-
|9
|Некорректный входной параметр (в доп. информации ответа будет название некорректного параметра)
|-
|10
|Внутренняя ошибка обработки запроса
|}

== Описание запросов ==

=== Запрос-пинг ===
Для данного запроса не проверяется версия API, секретный ключ и тип запроса GET/ POST.

Метод: GET или POST

Название запроса: ping

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример:

<pre>
Запрос:
GET https://ip:port/common_api/1.0/ping HTTP/1.1
Ответ:
{
"code":0,
"descr":"OK",
"data":{}
}
</pre>

=== Запрос списка групп экипажей ===
Метод: GET

Название запроса: get_crew_groups_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crew_groups
|Массив
|Список групп экипажей
|-
|• id
|Целое
|ИД группы экипажей
|-
|• name
|Строка
|Название группы экипажей
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_crew_groups_list HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"crew_groups":[
{
"id":1,
"name":"CREW_GROUP1"
},
{
"id":2,
"name":"CREW_GROUP2"
}
]
}
}
</pre>

=== Запрос списка служб ЕДС ===

Метод: GET

Название запроса: get_uds_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр
!Тип
!Описание
|-
|uds
|Массив
|Список служб [[Модуль «Единая диспетчерская служба»|ЕДС]]
|-
|• id
|Целое
|ИД службы [[Модуль «Единая диспетчерская служба»|ЕДС]]
|-
|• name
|Строка
|Название службы [[Модуль «Единая диспетчерская служба»|ЕДС]]
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_uds_list HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"uds":[
{
"id":1,
"name":"UDS1"
},
{
"id":2,
"name":"UDS2"
}
]
}
}
</pre>

=== Запрос списка тарифов ===

Метод: GET

Название запроса: get_tariffs_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр
!Тип
!Описание
|-
|tariffs
|Массив
|Список [[Справочник «Тарифы»|тарифов]]
|-
|• id
|Целое
|ИД [[Справочник «Тарифы»|тарифа]]
|-
|• name
|Строка
|Название [[Справочник «Тарифы»|тарифа]]
|-
|• is_active
|true или false
|Активный [[Справочник «Тарифы»|тариф]]
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_tariffs_list HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"tariffs":[
{
"id":1,
"name":"TARIFF1"
"is_active":true
},
{
"id":2,
"name":"TARIFF2"
"is_active":true
}
]
}
}
</pre>

=== Запрос списка услуг ===
Метод: GET

Название запроса: get_services_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр
!Тип
!Описание
|-
|services
|Массив
|Список [[Справочник «Услуги»|услуг]]
|-
|• id
|Целое
|ИД [[Справочник «Услуги»|услуги]]
|-
|• name
|Строка
|Название [[Справочник «Услуги»|услуги]]
|-
|• sum
|Дробное
|Абсолютная сумма [[Справочник «Услуги»|услуги]], руб
|-
|• percent
|Дробное
|Процент [[Справочник «Услуги»|услуги]] от стоимости заказа, %
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_services_list HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"services":[
{
"id":1,
"name":"SERVICE1",
"sum":100,
"percent":0
},
{
"id":2,
"name":"SERVICE2"
"sum":0,
"percent":10
}
]
}
}
</pre>

=== Запрос списка скидок ===
Метод: GET

Название запроса: get_discounts_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр
!Тип
!Описание
|-
|discounts
|Массив
|Список [[Справочник «Скидки клиентов»|скидок]]
|-
|• id
|Целое
|ИД [[Справочник «Скидки клиентов»|скидки]]
|-
|• name
|Строка
|Название [[Справочник «Скидки клиентов»|скидки]]
|-
|• sum
|Дробное
|Абсолютная сумма [[Справочник «Скидки клиентов»|скидки]], руб
|-
|• percent
|Дробное
|Процент [[Справочник «Скидки клиентов»|скидки]] от стоимости заказа, %
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_discounts_list HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"discounts":[
{
"id":1,
"name":"DISCOUNT1",
"sum":100,
"percent":0
},
{
"id":2,
"name":"DISCOUNT2"
"sum":0,
"percent":10
}
]
}
}
</pre>

=== Создание нового заказа ===
Метод: POST

Название запроса: create_order

Параметры:

{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|phone
|Строка, <= 16 символов
|Номер телефона
|-
|source
|Строка
|Адрес подачи
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
!colspan="3"|Необязательные параметры
|-
|dest
|Строка
|Адрес назначения
|-
|customer
|Строка
|Заказчик
|-
|comment
|Строка
|Комментарий
|-
|crew_group_id
|Целое
|ИД группы экипажей
|-
|uds_id
|Целое
|ИД службы ЕДС
|-
|tariff_id
|Целое
|ИД тарифа
|-
|is_prior
|true или false
|Предварительный заказ
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Заказ с такими параметрами уже создан
|-
|101
|Тариф не найден
|-
|102
|Группа экипажа не найдена
|-
|103
|Служба ЕДС не найдена
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|order_id
|Целое
|ИД созданного заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_order HTTP/1.1
Signature: <...>
Content-Type: application/x-www-form-urlencoded
Content-Length: 127
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

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"order_id":12345
}
}
</pre>

=== Расчет суммы заказа ===

Метод: GET

Название запроса: calc_order_cost
{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|tariff_id
|Целое
|ИД тарифа
|-
Параметры:

!colspan="3"|Необязательные параметры
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|is_prior
|true или false
|Предварительный заказ
|-
|client_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»
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Тариф не найден
|-
|101
|Ошибка при расчете по тарифу
|-
|102
|Скидка не найдена
|-
|103
|Клиент не найден
|-
|104
|Район подачи не найден
|-
|105
|Район назначения не найден
|-
|106
|Дисконтная карта не найдена
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|sum
|Дробное
|Рассчитанная общая сумма заказа
|-
|info
|Массив
|Дополнительная информация по расчету суммы заказа
|-
| • comment
|Строка
|Описание позиции дополнительной информации по расчету суммы заказа
|-
| • sum
|Строка
|Сумма позиции дополнительной информации по расчету суммы заказа
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/calc_order_cost?
tariff_id=1&source_time=20120501100000&is_prior=false&client_id=1&discount_id=1&disc_card_id=1&sour
ce_zone_id=1&dest_zone_id=2&distance_city=10&distance_country=20&source_distance_country=5&is_count
ry=true&waiting_minutes=10&is_hourly=false&hourly_minutes=60&is_prize=true&back_way=false&services=
1;2;3 HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"sum":1000,
"info":[
{
"comment":"SUM1",
"sum":"100"
},
{
"comment":"SUM2",
"sum":"200"
}
]
}
}
</pre>

=== Запрос информации об экипаже ===
Метод: GET

Название запроса: get_crew_info

Параметры:
{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|crew_id
|Целое
|ИД экипажа
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Экипаж не найден
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crew_id
|Целое
|ИД экипажа
|-
|code
|Строка
|Позывной экипажа
|-
|name
|Строка
|Наименование экипажа
|-
|driver_id
|Целое
|ИД водителя
|-
|car_id
|Целое
|ИД автомобиля
|-
|crew_group_id
|Целое
|ИД группы экипажа
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_crew_info?crew_id=1 HTTP/1.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
}
}
</pre>

=== Запрос информации о водителе ===
Метод: GET

Название запроса: get_driver_info

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|driver_id
|Целое
|ИД водителя
|-
!colspan="3"|Необязательные параметры
|-
|need_photo
|true или false
|Нужна ли фотография водителя
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Водитель не найден
|}

Возвращаемые параметры в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|driver_id
|Целое
|ИД водителя
|-
|name
|Строка
|ФИО водителя
|-
|birthday
|ДД.ММ.ГГГГ
|День рождения водителя
|-
|car_id
|Целое
|ИД основного автомобиля водителя
|-
|license
|Строка
|Удостоверение водителя
|-
|home_phone
|Строка
|Домашний телефон водителя
|-
|mobile_phone
|Строка
|Мобильный телефон водителя
|-
|is_locked
|true или false
|Водитель заблокирован
|-
|is_dismissed
|true или false
|Водитель уволен
|-
|driver_photo
|Base64
|Фото водителя (только если need_photo = true)
|}

Пример:

<pre>
Запрос:

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",
"birthday":"01.01.1980",
"car_id":1,
"license":"1234567890",
"home_phone":"123456",
"mobile_phone":"+79123456789",
"is_locked":false,
"is_dismissed":false
}
}
</pre>

=== Запрос информации об автомобиле ===
Метод: GET

Название запроса: get_car_info

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|car_id
|Целое
|ИД автомобиля
|-
!colspan="3"|Необязательные параметры
|-
|need_photo
|true или false
|Нужна ли фотография автомобиля
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Автомобиль не найден
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|car_id
|Целое
|ИД автомобиля
|-
|name
|Строка
|Наименование автомобиля
|-
|code
|Строка
|Позывной автомобиля
|-
|gos_number
|Строка
|Государственный номер автомобиля
|-
|color
|Строка
|Цвет автомобиля
|-
|mark
|Строка
|Марка автомобиля
|-
|short_name
|Строка
|Краткое название автомобиля
|-
|production_year
|Целое
|Год выпуска автомобиля
|-
|car_photo
|Base64
|Фото автомобиля (только если need_photo = true)
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_car_info?car_id=1&need_photo=false HTTP/1.1
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
}
}
</pre>

=== Запрос координат экипажей ===
Метод: GET

Название запроса: get_crews_coords

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Необязательные параметры
|-
|crew_id
|Целое
|ИД экипажа, по которому нужно вернуть координаты. Если не задано, то будут возвращены координаты всех экипажей на линии.
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Координаты не найдены
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crews_coords
|Массив
|Список координат экипажей
|-
|• crew_id
|Целое
|ИД экипажа
|-
|• crew_code
|Строка
|Позывной экипажа
|-
|• coords_time
|ГГГГММДДччммсс
|Время получения координат
|-
|• lat
|Дробное
|Долгота
|-
|• lon
|Дробное
|Широта
|-
|• state_kind
|Строка
|Тип состояния экипажа. Может принимать значения:
• "not_available" — экипаж не на линии

• "waiting" — экипаж свободен, ожидает заказы

• "on_order" — экипаж на заказе

• "on_break" — экипаж на перерыве
|}

Пример:

<pre>

Запрос:
GET https://ip:port/common_api/1.0/get_crews_coords HTTP/1.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"
},
{
"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 HTTP/1.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"
}
]
}
}
</pre>

=== Запрос адресов, содержащих нужную строку ===
Метод: GET

Название запроса: get_addresses_like

Параметры:

{|
!Параметры
!Тип
!Описание
|-
! colspan="3"|Обязательные параметры
|-
|get_streets
|true или false
|Искать улицы
|-
|get_houses
|true или false
|Искать пункты
|-
|get_streets
|true или false
|Искать дома. Не может быть равно true, если get_streets = true или get_points = true.
|-
|street
|Строка
|Часть названия улицы или пункта, если идет поиск улиц или пунктов, или полное название улицы, если идет поиск домов
|-
!colspan="3"|Необязательные параметры
|-
|house
|Строка
|Часть номера дома. Нужно только если get_houses = true.
|-
|max_addresses_count
|Целое
|Максимальное количество адресов в ответе
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Подходящие адреса не найдены
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|addresses
|Массив
|Список подходящих адресов
|-
|• street
|Строка
|Название улицы или пункта
|-
|• house
|Строка
|Номер дома
|-
|• kind
|Строка
|Тип адреса. Может принимать значения:
• "street" — улица

• "house" — дом

• "point" — пункт
|-
|• comment
|Строка
|Комментарий
|}

Пример:

<pre>

Запрос:

GET https://ip:port/common_api/1.0/get_addresses_like?get_streets=true&get_points=true&
get_houses=false&street=STREE HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"addresses":[
{
"street":"STREET1",
"house":"",
"kind":"street",
"comment":""
},
{
"street":"STREET2",
"house":"",
"kind":"street",
"comment":""
},
{
"street":"POINT_STREET1",
"house":"",
"kind":"point",
"comment":"Point at street STREET1"
}
]
}
}

Запрос:

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 HTTP/1.1
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":""
}
]
}
}
</pre>

=== Анализ маршрута ===
Метод: GET

Название запроса: analyze_route

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|source
|Строка
|Адрес подачи
|-
|dest
|Строка
|Адрес назначения
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Адрес подачи не распознан
|-
|101
|Адрес назначения не распознан
|-
|102
|Маршрут не распознан
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|source_lat
|Дробное
|Широта адреса подачи
|-
|source_lon
|Дробное
|Долгота адреса подачи
|-
|source_zone_id
|Целое
|ИД района подачи
|-
|dest_lat
|Дробное
|Широта адреса назначения
|-
|dest_lon
|Дробное
|Долгота адреса назначения
|-
|dest_zone_id
|Целое
|ИД района назначения
|-
|city_dist
|Дробное
|Километраж по городу
|-
|country_dist
|Дробное
|Километраж за городом
|-
|source_country_dist
|Дробное
|Километраж до адреса подачи, если адрес подачи за городом
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/analyze_route?source=STREET1,1&dest=STREET2,2 HTTP/1.1
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
}
}
</pre>

=== Запрос информации о состоянии заказа ===

Метод: GET

Название запроса: get_order_state

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|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
|Целое
|ИД автомобиля
|-
|start_time
|ГГГГММДДччммсс
|Время создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|finish_time
|ГГГГММДДччммсс
|Время завершения заказа
|-
|source
|Строка
|Адрес подачи
|-
|destination
|Строка
|Адрес назначения
|-
|passenger
|Строка
|Пассажир
|-
|phone
|Строка
|Номер телефона
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_order_state?order_id=1 HTTP/1.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
"start_time":"17.01.2013 12:56:41",
"source_time":"17.01.2013 13:26:17",
"finish_time":"17.01.2013 13:03:43",
"source":"1",
"destination":"2",
"passenger":"Слепаков",
"phone":"8800"
}
}
</pre>

=== Создание задачи СМС серверу ===

Метод: POST

Название запроса: send_sms

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|phone
|Строка, <= 16 символов
|Номер телефона
|-
|message
|Строка
|Текст СМС
|}

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример:

<pre>
Запрос:

POST /common_api/1.0/send_sms HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Content-Length: 33

Signature: <...>

message=SMSText&phone=89050057216

Ответ:

{
"code":0,
"descr":"OK",
"data":{}
}
</pre>

=== Проверка авторизации ===

Метод: GET

Название запроса: check_authorization

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|login
|Строка, <= 60 символов
|Логин
|-
|password
|Строка, <= 60 символов
|Пароль
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент с логином LOGIN и/или неверный пароль
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|client_id
|Целое
|ИД клиента
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/check_authorization?login=LOGIN&password=PASSWORD HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"client_id":131
}
}
</pre>

=== Регистрация клиента ===

Метод: POST

Название запроса: register_client

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|name
|Строка, <= 60 символов
|ФИО
|-
|login
|Строка, <= 60 символов
|Логин
|-
|password
|Строка, <= 60 символов
|Пароль
|-
|phones
|Строка
|Номера телефонов (через запятую)
|-
!colspan="3"|Необязательные параметры
|-
|address
|Строка
|Домашний адрес
|-
|birthday
|Строка
|Дата рождения
|-
|gender
|Строка
|Пол. Может принимать значения:
• "male" - мужской

• "female" - женский
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Клиент с номером телефона=PHONE уже существует
|-
|101
|Клиент с логином=LOGIN уже существует
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|client_id
|Целое
|ИД созданного клиента
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_order HTTP/1.1

Signature: <...>

Content-Type: application/x-www-form-urlencoded

Content-Length: 127

name=NAME&phones=88,99&login=LOGIN&password=PASSWORD&birthday=19930218115517&gender=male&address=ADDRESS

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"client_id":140
}
}
</pre>

=== Запрос информации по клиенту ===

Метод: GET

Название запроса: get_client_info

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|client_id
|Целое
|ИД клиента
|-
|name
|Строка
|ФИО
|-
|number
|Строка
|Номер договора
|-
|address
|Строка
|Домашний адрес
|-
|gender
|Строка
|Пол. Может принимать значения:

• "male" - мужской

• "female" - женский
|-
|birthday
|ДД.ММ.ГГГГ
|Дата рождения
|-
|phones
|Строка
|Номера телефонов (через запятую)
|-
|balance
|Дробное
|Баланс
|-
|login
|Строка
|Логин
|-
|password
|Строка
|Пароль
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_client_info?client_id=140 HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"client_id":140,
"name":"Васильев Артём",
"number":"000140",
"address":"Бутово,45",
"gender":"male",
"birthday":"18.02.1993",
"phones":"[\"88\",\"99\"]",
"balance":1467,
"login":"artem",
"password":"vasilev"
}
}
</pre>

=== Изменение информации по клиенту ===

Метод: POST

Название запроса: update_client_info

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента
|-
!colspan="3"|Необязательные параметры
|-
|name
|Строка, <= 60 символов
|ФИО
|-
|login
|Строка, <= 60 символов
|Логин
|-
|password
|Строка, <= 60 символов
|Пароль
|-
|phones
|Строка
|Номера телефонов (через запятую)
|-
|address
|Строка
|Домашний адрес
|-
|birthday
|Строка
|Дата рождения
|-
|gender
|Строка
|Пол. Может принимать значения:
• "male" - мужской

• "female" - женский
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Клиент с номером телефона=PHONE уже существует
|-
|101
|Клиент с логином=LOGIN уже существует

|}

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_order HTTP/1.1
Signature: <...>
Content-Type: application/x-www-form-urlencoded
Content-Length: 127

client_id=140&name=NAME&phones=88,99&login=LOGIN&password=PASSWORD&birthday=19930218115517&gender=male&address=ADDRESS

Ответ:

{
"code":0,
"descr":"OK",
"data":{}
}
</pre>

=== Запрос текущих заказов ===

Метод: GET

Название запроса: get_current_orders

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента (может отсутствовать, если phone заполнен)
|-
|phone
|Строка, <= 16 символов
|Телефон клиента (может отсутствовать, если client_id заполнен)
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|id
|Целое
|ИД заказа
|-
|state_id
|Целое
|ИД состояния заказа
|-
|start_time
|ГГГГММДДччммсс
|Дата создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|source
|Строка
|Адрес подачи
|-
|destination
|Строка
|Адрес назначения
|-
|passenger
|Строка
|Пассажир
|-
|crew_id
|Целое
|ИД экипажа
|-
|prior_crew_id
|Целое
|ИД предварительного экипажа
|-
|driver_id
|Целое
|ИД водителя
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_current_orders?client_id=140&phone=18 HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"orders":[
{
"id":20648,
"state_id":44,
"start_time":"20130204181111",
"source_time":"20130204181111",
"source":"1-й пр-т \/Москва\/,",
"destination":"12-й мкр,",
"passenger":"маша",
"crew_id":0,
"prior_crew_id":0,
"driver_id":0
},
{
"id":20670,
"state_id":44,
"start_time":"20130207153022",
"source_time":"20130207153022",
"source":"11-й мкр,",
"destination":"1-й пр-т \/Москва\/,",
"passenger":"саша",
"crew_id":0,
"prior_crew_id":0,
"driver_id":0
}
]
}
}
</pre>

=== Запрос выполненных заказов ===

Метод: GET

Название запроса: get_finished_orders

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента (может отсутствовать, если phone заполнен)
|-
|phone
|Строка, <= 16 символов
|Телефон клиента (может отсутствовать, если client_id заполнен)
|-
|start_time
|ГГГГММДДччммсс
|Начало периода
|-
|finish_time
|ГГГГММДДччммсс
|Конец периода
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|id
|Целое
|ИД заказа
|-
|state_id
|Целое
|ИД состояния заказа
|-
|start_time
|ГГГГММДДччммсс
|Дата создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|finish_time
|ГГГГММДДччммсс
|Время завершения заказа
|-
|birthday
|ДД.ММ.ГГГГ
|Дата рождения
|-
|source
|Строка
|Адрес подачи
|-
|destination
|Строка
|Адрес назначения
|-
|sum
|Дробное
|Стоимость заказа без учета скидок(наценок)
|-
|passenger
|Строка
|Пассажир
|-
|crew_id
|Целое
|ИД экипажа
|-
|prior_crew_id
|Целое
|ИД предварительного экипажа
|-
|driver_id
|Целое
|ИД водителя
|-
|car_id
|Целое
|ИД автомобиля
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_finished_orders?client_id=140&phone= HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"orders":[
{
"id":20651,
"state_id":34,
"source_time":"20130205110812",
"start_time":"20130205110812",
"finish_time":"20130205115618",
"source":"прпроп",
"destination":"рррррр",
"passenger":"вера",
"sum":"908",
"crew_id":"6",
"prior_crew_id":0,
"driver_id":"4",
"car_id":"6"
},
{
"id":20669,
"state_id":34,
"source_time":"20130205130500",
"start_time":"20130205130500",
"finish_time":"20130205134511",
"source":"1",
"destination":"2",
"passenger":"маша",
"sum":"454",
"crew_id":"6",
"prior_crew_id":0,
"driver_id":"4",
"car_id":"6"
}
]
}
}
</pre>

=== Проведение операции по клиенту ===

Метод: POST

Название запроса: create_client_operation

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента
|-
|oper_time
|ГГГГММДДччммсс
|Время создания операции
|-
|sum
|Дробное
|Сумма
|-
|oper_type
|Целое
|Тип операции:
• "receipt" - приход

• "expense" - расход
|-
|pay_type
|Целое
|Тип оплаты:
• "cash" - наличный

• "nocash" - безналичный
|-
!colspan="3"|Необязательные параметры
|-
|comment
|Строка
|Комментарий
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|oper_id
|Целое
|ИД операции
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_client_operation HTTP/1.1

Signature: <...>

Content-Type: application/x-www-form-urlencoded

Content-Length: 127

client_id=112&oper_time=20130221100719&oper_sum=300&oper_type=receipt&pay_type=cash&comment=COMMENT

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"oper_id":31

}
}
</pre>

=== Запрос операций по клиенту ===

Метод: GET

Название запроса: get_client_operations

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента (может отсутствовать, если phone заполнен)
|-
|phone
|Строка, <= 16 символов
|Телефон клиента (может отсутствовать, если client_id заполнен)
|-
|start_time
|ГГГГММДДччммсс
|Начало периода
|-
|finish_time
|ГГГГММДДччммсс
|Конец периода
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|oper_id
|Целое
|ИД операции
|-
|oper_time
|ГГГГММДДччммсс
|Время создания операции
|-
|sum
|Дробное
|Сумма
|-
|order_id
|Целое
|Заказ, связанный с операцией
|-
|oper_type
|Целое
|Тип операции:
• "receipt" - приход
• "expense" - расход
|-
|pay_type
|Целое
|Тип оплаты:
• "cash" - наличный
• "nocash" - безналичный
|}

Пример:

<pre>
Запрос:

GET

https://ip:port/common_api/1.0/get_client_operations?client_id=112&start_time=20130201092112&finish_time=20130221092112 HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"operations":[
{
"oper_id":112,
"oper_time":"20130219091328",
"sum":"21,8",
"order_id":11800,
"oper_type":"receipt",
"pay_type":"cash",
"comment":"jgznm"
},
{
"oper_id":112,
"oper_time":"20130220112245",
"sum":"4500",
"order_id":11801,
"oper_type":"receipt",
"pay_type":"cash",
"comment":"блин"
}
]
}
}
</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 HTTP/1.1
</pre>

Для получения данных из БД используются запросы типа GET. Для записи данных в БД используются запросы типа POST. В запросе типа GET параметры запроса передаются в URI.

Пример:

<pre>
GET https://ip:port/tm_tapi/1.0/get_info_by_phone?phone=89058800565&fields=PHONE_TYPEPHONE_
TO_DIAL&signature=661ce071eeefcb4f7fc8bc1f17bd520b HTTP/1.1
</pre>

В запросе типа POST параметры передаются в теле запроса в формате application/x-wwwform-
urlencoded.

Пример:

<pre>
POST https://ip:port/tm_tapi/1.0/change_order_state HTTP/1.1
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 HTTP/1.1

Секретный ключ:
321

Signature = MD5("phone=89058800565&fields=PHONE_TYPE" + "321") = ef17ea682d09e452af544a5758dba396
HTTP/1.1
</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 - если звонит номер из справочника телефоны; 0 - неизвестный номер)
|-
|PHONE_TO_DIAL
|Строка, <= 16 символов
|Номер телефона для отзвона по заказу
|-
|CREW_ID
|Целое
|ИД экипажа
|-
|IS_PRIOR
|true или false
|Признак предварительного заказа
|-
|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
|Целое
|ИД группы экипажа
|-
|CLIENT_BALANCE
|Дробное
|Баланс клиента
|-
|DRIVER_TIMECOUNT
|Целое
|Время пути водителя до адреса подачи в минутах
|-
|SOURCE_TIMECOUNT
|Целое
|Время оставшееся до подачи в минутах
|-
|SOUND_COLOR
|Строка
|Запись с информацией о цвете
|-
|SOUND_GOSNUMBER
|Строка
|Запись с информацией о государственном номере автомобиля
|-
|SOUND_MARK
|Строка
|Запись с информацией о марке автомобиля
|-
|GOSNUMBER
|Строка
|Государственный номер автомобиля
|-
|CAR_COLOR
|Строка
|Цвет автомобиля
|-
|CAR_MARK
|Строка
|Марка автомобиля
|}

Пример:

<pre>
Запрос:
GET https://ip:port/tm_tapi/1.0/get_info_by_phone?phone=89058800565l&fields=PHONE_TYPEPHONE_
TO_DIAL-CREW_ID-ORDER_ID&signature=d35ab2765f2968d48c096d5f5327db26 HTTP/1.1

Ответ:

<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>
</data>
</response>
</pre>

==== Запрос информации по ИД заказа ====

Метод: GET
Название запроса: get_info_by_order_id
Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|-
|fields
|Строка
|Список полей, которые необходимо вернуть. Поля перечисляются через ''-''
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

Специальные возвращаемые коды: нет
Возвращаемые данные в случае успешного выполнения запроса: зависит от того какие поля были переданы в поле fields.

{|
!Параметр
!Тип
!Описание
|-
|DRIVER_SOURCETIME
|Строка, <= 16 символов
|Время до подачи в минутах, указанное водителем
|-
|SOUND_COLOR
|Строка
|Запись с информацией о цвете
|-
|MARK
|Строка
|Марка автомобиля
|-
|COLOR
|Строка
|Цвет автомобиля
|-
|GOSNUMBER
|Строка
|Государственный номер автомобиля
|-
|SOUND_MARK
|Строка
|Запись с информацией о марке автомобиля
|-
|CREWGROUPID
|Целое
|ИД группы экипажа
|-
|IS_PRIOR
|true или false
|Признак предварительного заказа
|-
|DISCOUNTEDSUMM
|Строка
|Сумма заказа с учетом всех скидок
|-
|MOBILE_PHONE
|Строка, <= 16 символов
|Номер телефона водителя
|-
|CATEGORYID
|Целое
|ИД категории телефона
|-
|SOURCE_TIME
|Целое
|Время до подачи в минутах
|}

Пример:

<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
HTTP/1.1

Ответ:

<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></SOURCE_TIME>
</data>
</response>
</pre>

==== Смена состояния заказа ====
Метод: POST

Название запроса: change_order_state

Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|-
|need_state
|Целое
|Новое состояние заказа
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

Специальные возвращаемые коды:

{|
!Код
!Описание
|-
|100
|Заказ с таким ИД не найден.
|-
|101
|Изменение состояния не соответствует необходимым условиям.
|}

Возвращаемые данные в случае успешного выполнения запроса

{|
!Параметр
!Тип
!Описание
|-
|ORDER_ID
|Целое
|ИД созданного заказа
|-
|NEW_STATE
|Целое
|Новое состояние заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/tm_tapi/1.0/change_order_state HTTP/1.1
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"|Обязательные параметры
|-
|RECORD_DATE
|ГГГГММДДччммсс
|Дата записи
|-
|RECORD_LENGTH
|Целое
|Продолжительность записи (в секундах)
|-
|PHONE
|Строка, <= 16 символов
|Номер телефона
|-
|ORDERID
|Целое
|Заказ, с которого сделана запись
|-
|USERID
|Целое
|Пользователь, сделавший запись
|-
|FILE_PATH
|Строка,<=255 символов
|Путь к файлу записи
|-
|RECORD_GUID
|Строка,<= 80 символов
|GUID звонка
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

Специальные возвращаемые коды: нет
Возвращаемые данные в случае успешного выполнения запроса

{|
!Параметр
!Тип
!Описание
|-
|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: 206
RECORD_DATE=20121108145953&RECORD_LENGTH=6546&PHONE=654321&ORDERID=654&USERID=564&FILE_PATH=d%3A
%5CProjects%5Ctrunk%5C%5Ftrunk%5CTM%5CBin
%5C&RECORD_GUID=GUID456258&signature=cd11d50d65fa7e8ad73f80cdc7d296c7

Ответ:

<response>
<code>0</code>
<descr>OK</descr>
<data>
<RECORD_ID>25</RECORD_ID>
</data>
</response>
</pre>

==== Создать новый заказ ====

Метод: POST

Название запроса: make_new_order

Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|PHONE
|Строка, <= 16 символов
|Номер телефона
|-
|ORDER_STATE_ID
|Целое
|ИД состояния заказа
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|-
|colspan="3"|Необязательные параметры
|-
|CREW_GROUP_ID
|Целое
|ИД группы экипажа
|-
|TARIFF_ID
|Целое
|ИД тарифа
|-
|PHONE_PREFIX
|Строка
|Префикс, отрезаемый от номера телефона при поиске в базе данных. Для входящих звонков это код города с префиксом входящих номеров, обычно "8". Например, "83412"
|-
|DISCOUNTED_SU MM
|Строка
|Фиксированная сумма за заказ
|}

Специальные возвращаемые коды:

{|
!Код
!Описание
|-
|100
|Клиент не найден
|}

Возвращаемые данные в случае успешного выполнения запроса

{|
!Параметр
!Тип
!Описание
|-
|ORDER_ID
|Целое
|ИД созданного заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/tm_tapi/1.0/make_new_order HTTP/1.1
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>
</pre>

== Пример формы для заказа такси ==
{{url|{{корень FTP|forms/zakaz_taxi.zip}}}}

Данная форма является примером, на основе которого можно построить собственную форму для принятия интернет-заказов. Форму можно использовать либо в исходном варианте, либо применяя запросы [[TM API#Описание запросов|TM API]].
Для того, чтобы данная форма функционировала, необходимо открыть файл в любом текстовом редакторе и указать корректные IP-адрес [[Сервер Такси-Мастер|сервера Такси-Мастер]], порт [[TM API#Параметры TM API|TM API]] и секретный ключ. Далее вам следует загрузить файл на хостинг.

Именно так будет выглядеть данная форма для заказа такси.
{{картинка|Форма для заказа такси.jpg}}

[[Категория:ТМ2]]

TM API

2013-10-01T15:04:05Z

AnnaNikolskih: /* Изменение информации по клиенту */

'''TM API''' - специальный набор инструментов [[Такси-Мастер]], который позволит объединить систему с вашим сайтом и различными полезными сервисами. Он предоставляется вам на свободных условиях.

Благодаря этому набору вы сможете:

# Создать механизм приема заказов через интернет.
# Сделать ваш сайт более информативным: публиковать полезную для клиентов информацию прямо из системы - список ближайших [[Справочник «Экипажи»|экипажей]], предварительный расчет стоимости поездки, мониторинг движения автомобиля такси в процессе выполнения [[заказ]]а, [[Модуль «Интеграция с картами»|карты города]] и контактную информацию.
# Расширить возможности своей службы за счет популярного онлайн-сервиса Яндекс Такси.

== Параметры TM API ==
Задать настройки для корректной работы TM API вы сможете в программе [[Такси-Мастер]] в меню {{tab|Настройки}} в одноименной ветке {{tab|TM API}}.
Параметры организуют и контролируют работу [[Модуль «Интернет-заказы»|модуля «Интернет-заказы»]].
# Установите флажок {{checkbox|Использовать TM API}}, чтобы приступить к его использованию.
# В поле {{поле|Локальный порт}} введите номер порта подключения к интернету, на котором работает и будет ожидать запросы о новых заказах [[TMServer]]. Рекомендуется оставить номер порта по умолчанию.
# Установите флажок {{checkbox|Можно использовать данное рабочее место TMServer для распознавания адресов}} для того, чтобы конкретно с данного рабочего места происходило распознавание адресов модулем "Интернет-заказы".
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

=== Ветка «Открытое API» ===
В данной ветке регулируется доступ к синхронизации Такси-Мастер со сторонним сервисом (сайтом), с помощью которого клиенты будут создавать интернет-заказы. С примером кода для работы вы можете ознакомиться в данной статье в разделе [[TM API#Общее описание протокола|Общее описание протокола]].
# Установите флажок {{checkbox|Использовать открытое API}} для того, чтобы запустить работу по обслуживанию модуля «Интернет-заказы». При установленном флажке сервер [[Модуль «Интернет-заказы»|модуля «Интернет-заказы»]] запускается и ожидает запросы о новых заказах.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы с модулем «Интернет-заказы», который будет выслан вам в письме от менеджера.
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

=== Ветка «API для телефонии» ===
В данной ветке регулируются настройки API для телефонии, т.е. взаимодействие [[Такси-Мастер]] с call-центром через программный интерфейс. С его помощью [[Call-центр Oktell|call-центр]] может дать команду Такси-Мастер создать [[зака]]з или запросить информацию о [[Справочник «Состояния заказа»|статусе текущего заказа]].
# Установите флажок {{checkbox|Использовать открытое API для телефонии}} для того, чтобы запустить работу по обслуживанию телефонии через API.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы.
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

=== Ветка «Платежные терминалы» ===
{{info|Ранее для связи [[Модуль интеграции с платежными системами|платежных систем]] и [[Такси-Мастер]] служила такая утилита, как TMWeb. В данный момент мы отказались от ее использования, а функции были распределены между двумя компонентами системы: TM API и [[TMServer]].}}

Параметры этой ветки отвечают за работу [[Модуль интеграции с платежными терминалами|модуля интеграции с платежными системами]].
# Установите флажок {{checkbox|Включить прием терминальных платежей}}. Данная функция позволит отображать все платежные операции по приходу средств от водителей через терминалы в [[База данных Такси-Мастер 2|базе данных]] программы.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы с платежными системами и сверки платежей, который будет выслан вам в письме от менеджера. Секретный ключ - это определенный набор символов, необходимый для формирования подписи при передаче информации о платеже.
# В полях {{поле|Логин}} и {{поле|Пароль}} введите данные учетной записи на сайте http://term.bitmaster.ru.
# Кнопка {{кнопка|Задать всем водителям терминальный аккаунт по их ИД}} служит для соединения TM API с сервером Такси-Мастер. В результате соединения записи о терминальных аккаунтах генерируются, заносятся (для тех водителей, у которых они отсутствуют) и обновляются (для тех водителей, у которых уже существуют терминальные аккаунты) в Такси-Мастер.
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

{{info|Обратите внимание, что для платежных систем также существует открытый и свободно распространяемый API, с помощью которого есть возможность связать [[Такси-Мастер]] и [[Модуль интеграции с платежными системами|платежные системы]]. Обратитесь в отдел дополнительных услуг, написав на {{ящик ОДУ}}, за получением кода для данного компонента системы.}}

== Общее описание протокола ==

=== Формат запроса ===

[[TMAPI]] принимает входящие запросы по протоколу HTTPS. В URI запроса после ip адреса и порта, который будет слушать TMWeb, должно идти название API (common_api) и версия
API. Пример:

<pre>
GET https://ip:port/common_api/1.0/get_crew_groups_list HTTP/1.1
</pre>

Для получения данных из БД используются запросы типа GET. Для записи данных в [[База данных Такси-Мастер|базу данных]] используются запросы типа POST. В запросе типа GET параметры запроса передаются в URI. Пример:
<pre>
GET https://ip:port/common_api/1.0/calc_order_cost?tariff_id=1&distance_city=10 HTTP/1.1
Signature: <...>
</pre>

В запросе типа POST параметры передаются в теле запроса в формате application/x-wwwform-urlencoded. Пример:

<pre>
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
</pre>

В любом запросе обязательно должен быть заголовок Signature. В нем передается MD5 хэш, рассчитанный для строки, которая получается сцеплением строки параметров запроса с секретным ключом. Секретный ключ задается в настройках модуля TMWeb в ТМ2. Пример:

<pre>
Запрос:
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
</pre>

=== Формат ответа ===

TMWeb всегда возвращает HTTP код 200 ОК. Результат выполнения запроса содержится в теле ответа в формате JSON. Общий вид возвращаемого результата:

<pre>
{
"code":<Числовой код результата>,
"descr":"<Строковое описание результата>",
"data":{<Дополнительная информация>}
}
</pre>

Существуют общие для всех запросов коды результатов:
{|
! Код
! Описание
|-
|0
|Успешное выполнение запроса
|-
|1
|Неизвестная ошибка
|-
|2
|Неизвестный тип API
|-
|3
|API отключено в настройках TMWeb
|-
|4
|Не совпадает секретный ключ
|-
|5
|Неподдерживаемая версия API
|-
|6
|Неизвестное название запроса
|-
|7
|Неверный тип запроса GET/POST
|-
|8
|Не хватает входного параметра (в доп. информации ответа будет название отсутствующего параметра)
|-
|9
|Некорректный входной параметр (в доп. информации ответа будет название некорректного параметра)
|-
|10
|Внутренняя ошибка обработки запроса
|}

== Описание запросов ==

=== Запрос-пинг ===
Для данного запроса не проверяется версия API, секретный ключ и тип запроса GET/ POST.

Метод: GET или POST

Название запроса: ping

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример:

<pre>
Запрос:
GET https://ip:port/common_api/1.0/ping HTTP/1.1
Ответ:
{
"code":0,
"descr":"OK",
"data":{}
}
</pre>

=== Запрос списка групп экипажей ===
Метод: GET

Название запроса: get_crew_groups_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crew_groups
|Массив
|Список групп экипажей
|-
|• id
|Целое
|ИД группы экипажей
|-
|• name
|Строка
|Название группы экипажей
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_crew_groups_list HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"crew_groups":[
{
"id":1,
"name":"CREW_GROUP1"
},
{
"id":2,
"name":"CREW_GROUP2"
}
]
}
}
</pre>

=== Запрос списка служб ЕДС ===

Метод: GET

Название запроса: get_uds_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр
!Тип
!Описание
|-
|uds
|Массив
|Список служб [[Модуль «Единая диспетчерская служба»|ЕДС]]
|-
|• id
|Целое
|ИД службы [[Модуль «Единая диспетчерская служба»|ЕДС]]
|-
|• name
|Строка
|Название службы [[Модуль «Единая диспетчерская служба»|ЕДС]]
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_uds_list HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"uds":[
{
"id":1,
"name":"UDS1"
},
{
"id":2,
"name":"UDS2"
}
]
}
}
</pre>

=== Запрос списка тарифов ===

Метод: GET

Название запроса: get_tariffs_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр
!Тип
!Описание
|-
|tariffs
|Массив
|Список [[Справочник «Тарифы»|тарифов]]
|-
|• id
|Целое
|ИД [[Справочник «Тарифы»|тарифа]]
|-
|• name
|Строка
|Название [[Справочник «Тарифы»|тарифа]]
|-
|• is_active
|true или false
|Активный [[Справочник «Тарифы»|тариф]]
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_tariffs_list HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"tariffs":[
{
"id":1,
"name":"TARIFF1"
"is_active":true
},
{
"id":2,
"name":"TARIFF2"
"is_active":true
}
]
}
}
</pre>

=== Запрос списка услуг ===
Метод: GET

Название запроса: get_services_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр
!Тип
!Описание
|-
|services
|Массив
|Список [[Справочник «Услуги»|услуг]]
|-
|• id
|Целое
|ИД [[Справочник «Услуги»|услуги]]
|-
|• name
|Строка
|Название [[Справочник «Услуги»|услуги]]
|-
|• sum
|Дробное
|Абсолютная сумма [[Справочник «Услуги»|услуги]], руб
|-
|• percent
|Дробное
|Процент [[Справочник «Услуги»|услуги]] от стоимости заказа, %
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_services_list HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"services":[
{
"id":1,
"name":"SERVICE1",
"sum":100,
"percent":0
},
{
"id":2,
"name":"SERVICE2"
"sum":0,
"percent":10
}
]
}
}
</pre>

=== Запрос списка скидок ===
Метод: GET

Название запроса: get_discounts_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр
!Тип
!Описание
|-
|discounts
|Массив
|Список [[Справочник «Скидки клиентов»|скидок]]
|-
|• id
|Целое
|ИД [[Справочник «Скидки клиентов»|скидки]]
|-
|• name
|Строка
|Название [[Справочник «Скидки клиентов»|скидки]]
|-
|• sum
|Дробное
|Абсолютная сумма [[Справочник «Скидки клиентов»|скидки]], руб
|-
|• percent
|Дробное
|Процент [[Справочник «Скидки клиентов»|скидки]] от стоимости заказа, %
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_discounts_list HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"discounts":[
{
"id":1,
"name":"DISCOUNT1",
"sum":100,
"percent":0
},
{
"id":2,
"name":"DISCOUNT2"
"sum":0,
"percent":10
}
]
}
}
</pre>

=== Создание нового заказа ===
Метод: POST

Название запроса: create_order

Параметры:

{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|phone
|Строка, <= 16 символов
|Номер телефона
|-
|source
|Строка
|Адрес подачи
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
!colspan="3"|Необязательные параметры
|-
|dest
|Строка
|Адрес назначения
|-
|customer
|Строка
|Заказчик
|-
|comment
|Строка
|Комментарий
|-
|crew_group_id
|Целое
|ИД группы экипажей
|-
|uds_id
|Целое
|ИД службы ЕДС
|-
|tariff_id
|Целое
|ИД тарифа
|-
|is_prior
|true или false
|Предварительный заказ
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Заказ с такими параметрами уже создан
|-
|101
|Тариф не найден
|-
|102
|Группа экипажа не найдена
|-
|103
|Служба ЕДС не найдена
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|order_id
|Целое
|ИД созданного заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_order HTTP/1.1
Signature: <...>
Content-Type: application/x-www-form-urlencoded
Content-Length: 127
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

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"order_id":12345
}
}
</pre>

=== Расчет суммы заказа ===

Метод: GET

Название запроса: calc_order_cost
{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|tariff_id
|Целое
|ИД тарифа
|-
Параметры:

!colspan="3"|Необязательные параметры
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|is_prior
|true или false
|Предварительный заказ
|-
|client_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»
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Тариф не найден
|-
|101
|Ошибка при расчете по тарифу
|-
|102
|Скидка не найдена
|-
|103
|Клиент не найден
|-
|104
|Район подачи не найден
|-
|105
|Район назначения не найден
|-
|106
|Дисконтная карта не найдена
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|sum
|Дробное
|Рассчитанная общая сумма заказа
|-
|info
|Массив
|Дополнительная информация по расчету суммы заказа
|-
| • comment
|Строка
|Описание позиции дополнительной информации по расчету суммы заказа
|-
| • sum
|Строка
|Сумма позиции дополнительной информации по расчету суммы заказа
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/calc_order_cost?
tariff_id=1&source_time=20120501100000&is_prior=false&client_id=1&discount_id=1&disc_card_id=1&sour
ce_zone_id=1&dest_zone_id=2&distance_city=10&distance_country=20&source_distance_country=5&is_count
ry=true&waiting_minutes=10&is_hourly=false&hourly_minutes=60&is_prize=true&back_way=false&services=
1;2;3 HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"sum":1000,
"info":[
{
"comment":"SUM1",
"sum":"100"
},
{
"comment":"SUM2",
"sum":"200"
}
]
}
}
</pre>

=== Запрос информации об экипаже ===
Метод: GET

Название запроса: get_crew_info

Параметры:
{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|crew_id
|Целое
|ИД экипажа
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Экипаж не найден
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crew_id
|Целое
|ИД экипажа
|-
|code
|Строка
|Позывной экипажа
|-
|name
|Строка
|Наименование экипажа
|-
|driver_id
|Целое
|ИД водителя
|-
|car_id
|Целое
|ИД автомобиля
|-
|crew_group_id
|Целое
|ИД группы экипажа
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_crew_info?crew_id=1 HTTP/1.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
}
}
</pre>

=== Запрос информации о водителе ===
Метод: GET

Название запроса: get_driver_info

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|driver_id
|Целое
|ИД водителя
|-
!colspan="3"|Необязательные параметры
|-
|need_photo
|true или false
|Нужна ли фотография водителя
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Водитель не найден
|}

Возвращаемые параметры в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|driver_id
|Целое
|ИД водителя
|-
|name
|Строка
|ФИО водителя
|-
|birthday
|ДД.ММ.ГГГГ
|День рождения водителя
|-
|car_id
|Целое
|ИД основного автомобиля водителя
|-
|license
|Строка
|Удостоверение водителя
|-
|home_phone
|Строка
|Домашний телефон водителя
|-
|mobile_phone
|Строка
|Мобильный телефон водителя
|-
|is_locked
|true или false
|Водитель заблокирован
|-
|is_dismissed
|true или false
|Водитель уволен
|-
|driver_photo
|Base64
|Фото водителя (только если need_photo = true)
|}

Пример:

<pre>
Запрос:

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",
"birthday":"01.01.1980",
"car_id":1,
"license":"1234567890",
"home_phone":"123456",
"mobile_phone":"+79123456789",
"is_locked":false,
"is_dismissed":false
}
}
</pre>

=== Запрос информации об автомобиле ===
Метод: GET

Название запроса: get_car_info

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|car_id
|Целое
|ИД автомобиля
|-
!colspan="3"|Необязательные параметры
|-
|need_photo
|true или false
|Нужна ли фотография автомобиля
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Автомобиль не найден
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|car_id
|Целое
|ИД автомобиля
|-
|name
|Строка
|Наименование автомобиля
|-
|code
|Строка
|Позывной автомобиля
|-
|gos_number
|Строка
|Государственный номер автомобиля
|-
|color
|Строка
|Цвет автомобиля
|-
|mark
|Строка
|Марка автомобиля
|-
|short_name
|Строка
|Краткое название автомобиля
|-
|production_year
|Целое
|Год выпуска автомобиля
|-
|car_photo
|Base64
|Фото автомобиля (только если need_photo = true)
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_car_info?car_id=1&need_photo=false HTTP/1.1
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
}
}
</pre>

=== Запрос координат экипажей ===
Метод: GET

Название запроса: get_crews_coords

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Необязательные параметры
|-
|crew_id
|Целое
|ИД экипажа, по которому нужно вернуть координаты. Если не задано, то будут возвращены координаты всех экипажей на линии.
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Координаты не найдены
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crews_coords
|Массив
|Список координат экипажей
|-
|• crew_id
|Целое
|ИД экипажа
|-
|• crew_code
|Строка
|Позывной экипажа
|-
|• coords_time
|ГГГГММДДччммсс
|Время получения координат
|-
|• lat
|Дробное
|Долгота
|-
|• lon
|Дробное
|Широта
|-
|• state_kind
|Строка
|Тип состояния экипажа. Может принимать значения:
• "not_available" — экипаж не на линии

• "waiting" — экипаж свободен, ожидает заказы

• "on_order" — экипаж на заказе

• "on_break" — экипаж на перерыве
|}

Пример:

<pre>

Запрос:
GET https://ip:port/common_api/1.0/get_crews_coords HTTP/1.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"
},
{
"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 HTTP/1.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"
}
]
}
}
</pre>

=== Запрос адресов, содержащих нужную строку ===
Метод: GET

Название запроса: get_addresses_like

Параметры:

{|
!Параметры
!Тип
!Описание
|-
! colspan="3"|Обязательные параметры
|-
|get_streets
|true или false
|Искать улицы
|-
|get_houses
|true или false
|Искать пункты
|-
|get_streets
|true или false
|Искать дома. Не может быть равно true, если get_streets = true или get_points = true.
|-
|street
|Строка
|Часть названия улицы или пункта, если идет поиск улиц или пунктов, или полное название улицы, если идет поиск домов
|-
!colspan="3"|Необязательные параметры
|-
|house
|Строка
|Часть номера дома. Нужно только если get_houses = true.
|-
|max_addresses_count
|Целое
|Максимальное количество адресов в ответе
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Подходящие адреса не найдены
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|addresses
|Массив
|Список подходящих адресов
|-
|• street
|Строка
|Название улицы или пункта
|-
|• house
|Строка
|Номер дома
|-
|• kind
|Строка
|Тип адреса. Может принимать значения:
• "street" — улица

• "house" — дом

• "point" — пункт
|-
|• comment
|Строка
|Комментарий
|}

Пример:

<pre>

Запрос:

GET https://ip:port/common_api/1.0/get_addresses_like?get_streets=true&get_points=true&
get_houses=false&street=STREE HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"addresses":[
{
"street":"STREET1",
"house":"",
"kind":"street",
"comment":""
},
{
"street":"STREET2",
"house":"",
"kind":"street",
"comment":""
},
{
"street":"POINT_STREET1",
"house":"",
"kind":"point",
"comment":"Point at street STREET1"
}
]
}
}

Запрос:

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 HTTP/1.1
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":""
}
]
}
}
</pre>

=== Анализ маршрута ===
Метод: GET

Название запроса: analyze_route

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|source
|Строка
|Адрес подачи
|-
|dest
|Строка
|Адрес назначения
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Адрес подачи не распознан
|-
|101
|Адрес назначения не распознан
|-
|102
|Маршрут не распознан
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|source_lat
|Дробное
|Широта адреса подачи
|-
|source_lon
|Дробное
|Долгота адреса подачи
|-
|source_zone_id
|Целое
|ИД района подачи
|-
|dest_lat
|Дробное
|Широта адреса назначения
|-
|dest_lon
|Дробное
|Долгота адреса назначения
|-
|dest_zone_id
|Целое
|ИД района назначения
|-
|city_dist
|Дробное
|Километраж по городу
|-
|country_dist
|Дробное
|Километраж за городом
|-
|source_country_dist
|Дробное
|Километраж до адреса подачи, если адрес подачи за городом
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/analyze_route?source=STREET1,1&dest=STREET2,2 HTTP/1.1
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
}
}
</pre>

=== Запрос информации о состоянии заказа ===

Метод: GET

Название запроса: get_order_state

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|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
|Целое
|ИД автомобиля
|-
|start_time
|ГГГГММДДччммсс
|Время создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|finish_time
|ГГГГММДДччммсс
|Время завершения заказа
|-
|source
|Строка
|Адрес подачи
|-
|destination
|Строка
|Адрес назначения
|-
|passenger
|Строка
|Пассажир
|-
|phone
|Строка
|Номер телефона
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_order_state?order_id=1 HTTP/1.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
"start_time":"17.01.2013 12:56:41",
"source_time":"17.01.2013 13:26:17",
"finish_time":"17.01.2013 13:03:43",
"source":"1",
"destination":"2",
"passenger":"Слепаков",
"phone":"8800"
}
}
</pre>

=== Создание задачи СМС серверу ===

Метод: POST

Название запроса: send_sms

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|phone
|Строка, <= 16 символов
|Номер телефона
|-
|message
|Строка
|Текст СМС
|}

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример:

<pre>
Запрос:

POST /common_api/1.0/send_sms HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Content-Length: 33

Signature: <...>

message=SMSText&phone=89050057216

Ответ:

{
"code":0,
"descr":"OK",
"data":{}
}
</pre>

=== Проверка авторизации ===

Метод: GET

Название запроса: check_authorization

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|login
|Строка, <= 60 символов
|Логин
|-
|password
|Строка, <= 60 символов
|Пароль
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент с логином LOGIN и/или неверный пароль
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|client_id
|Целое
|ИД клиента
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/check_authorization?login=LOGIN&password=PASSWORD HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"client_id":131
}
}
</pre>

=== Регистрация клиента ===

Метод: POST

Название запроса: register_client

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|name
|Строка, <= 60 символов
|ФИО
|-
|login
|Строка, <= 60 символов
|Логин
|-
|password
|Строка, <= 60 символов
|Пароль
|-
|phones
|Строка
|Номера телефонов (через запятую)
|-
!colspan="3"|Необязательные параметры
|-
|address
|Строка
|Домашний адрес
|-
|birthday
|Строка
|Дата рождения
|-
|gender
|Строка
|Пол. Может принимать значения:
• "male" - мужской

• "female" - женский
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Клиент с номером телефона=PHONE уже существует
|-
|101
|Клиент с логином=LOGIN уже существует
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|client_id
|Целое
|ИД созданного клиента
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_order HTTP/1.1

Signature: <...>

Content-Type: application/x-www-form-urlencoded

Content-Length: 127

name=NAME&phones=88,99&login=LOGIN&password=PASSWORD&birthday=19930218115517&gender=male&address=ADDRESS

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"client_id":140
}
}
</pre>

=== Запрос информации по клиенту ===

Метод: GET

Название запроса: get_client_info

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|client_id
|Целое
|ИД клиента
|-
|name
|Строка
|ФИО
|-
|number
|Строка
|Номер договора
|-
|address
|Строка
|Домашний адрес
|-
|gender
|Строка
|Пол. Может принимать значения:

• "male" - мужской

• "female" - женский
|-
|birthday
|ДД.ММ.ГГГГ
|Дата рождения
|-
|phones
|Строка
|Номера телефонов (через запятую)
|-
|balance
|Дробное
|Баланс
|-
|login
|Строка
|Логин
|-
|password
|Строка
|Пароль
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_client_info?client_id=140 HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"client_id":140,
"name":"Васильев Артём",
"number":"000140",
"address":"Бутово,45",
"gender":"male",
"birthday":"18.02.1993",
"phones":"[\"88\",\"99\"]",
"balance":1467,
"login":"artem",
"password":"vasilev"
}
}
</pre>

=== Изменение информации по клиенту ===

Метод: POST

Название запроса: update_client_info

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента
|-
!colspan="3"|Необязательные параметры
|-
|name
|Строка, <= 60 символов
|ФИО
|-
|login
|Строка, <= 60 символов
|Логин
|-
|password
|Строка, <= 60 символов
|Пароль
|-
|phones
|Строка
|Номера телефонов (через запятую)
|-
|address
|Строка
|Домашний адрес
|-
|birthday
|Строка
|Дата рождения
|-
|gender
|Строка
|Пол. Может принимать значения:
• "male" - мужской

• "female" - женский
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Клиент с номером телефона=PHONE уже существует
|-
|101
|Клиент с логином=LOGIN уже существует

|}

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_order HTTP/1.1
Signature: <...>
Content-Type: application/x-www-form-urlencoded
Content-Length: 127

client_id=140&name=NAME&phones=88,99&login=LOGIN&password=PASSWORD&birthday=19930218115517&gender=male&address=ADDRESS

Ответ:

{
"code":0,
"descr":"OK",
"data":{}
}
</pre>

=== Запрос текущих заказов ===

Метод: GET

Название запроса: get_current_orders

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента (может отсутствовать, если phone заполнен)
|-
|phone
|Строка, <= 16 символов
|Телефон клиента (может отсутствовать, если client_id заполнен)
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|id
|Целое
|ИД заказа
|-
|state_id
|Целое
|ИД состояния заказа
|-
|start_time
|ГГГГММДДччммсс
|Дата создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|birthday
|ДД.ММ.ГГГГ
|Дата рождения
|-
|source
|Строка
|Адрес подачи
|-
|destination
|Строка
|Адрес назначения
|-
|passenger
|Строка
|Пассажир
|-
|crew_id
|Целое
|ИД экипажа
|-
|prior_crew_id
|Целое
|ИД предварительного экипажа
|-
|driver_id
|Целое
|ИД водителя
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_current_orders?client_id=140&phone=18 HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"orders":[
{
"id":20648,
"state_id":44,
"start_time":"20130204181111",
"source_time":"20130204181111",
"source":"1-й пр-т \/Москва\/,",
"destination":"12-й мкр,",
"passenger":"маша",
"crew_id":0,
"prior_crew_id":0,
"driver_id":0
},
{
"id":20670,
"state_id":44,
"start_time":"20130207153022",
"source_time":"20130207153022",
"source":"11-й мкр,",
"destination":"1-й пр-т \/Москва\/,",
"passenger":"саша",
"crew_id":0,
"prior_crew_id":0,
"driver_id":0
}
]
}
}
</pre>

=== Запрос выполненных заказов ===

Метод: GET

Название запроса: get_finished_orders

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента (может отсутствовать, если phone заполнен)
|-
|phone
|Строка, <= 16 символов
|Телефон клиента (может отсутствовать, если client_id заполнен)
|-
|start_time
|ГГГГММДДччммсс
|Начало периода
|-
|finish_time
|ГГГГММДДччммсс
|Конец периода
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|id
|Целое
|ИД заказа
|-
|state_id
|Целое
|ИД состояния заказа
|-
|start_time
|ГГГГММДДччммсс
|Дата создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|finish_time
|ГГГГММДДччммсс
|Время завершения заказа
|-
|birthday
|ДД.ММ.ГГГГ
|Дата рождения
|-
|source
|Строка
|Адрес подачи
|-
|destination
|Строка
|Адрес назначения
|-
|sum
|Дробное
|Стоимость заказа без учета скидок(наценок)
|-
|passenger
|Строка
|Пассажир
|-
|crew_id
|Целое
|ИД экипажа
|-
|prior_crew_id
|Целое
|ИД предварительного экипажа
|-
|driver_id
|Целое
|ИД водителя
|-
|car_id
|Целое
|ИД автомобиля
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_finished_orders?client_id=140&phone= HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"orders":[
{
"id":20651,
"state_id":34,
"source_time":"20130205110812",
"start_time":"20130205110812",
"finish_time":"20130205115618",
"source":"прпроп",
"destination":"рррррр",
"passenger":"вера",
"sum":"908",
"crew_id":"6",
"prior_crew_id":0,
"driver_id":"4",
"car_id":"6"
},
{
"id":20669,
"state_id":34,
"source_time":"20130205130500",
"start_time":"20130205130500",
"finish_time":"20130205134511",
"source":"1",
"destination":"2",
"passenger":"маша",
"sum":"454",
"crew_id":"6",
"prior_crew_id":0,
"driver_id":"4",
"car_id":"6"
}
]
}
}
</pre>

=== Проведение операции по клиенту ===

Метод: POST

Название запроса: create_client_operation

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента
|-
|oper_time
|ГГГГММДДччммсс
|Время создания операции
|-
|sum
|Дробное
|Сумма
|-
|oper_type
|Целое
|Тип операции:
• "receipt" - приход

• "expense" - расход
|-
|pay_type
|Целое
|Тип оплаты:
• "cash" - наличный

• "nocash" - безналичный
|-
!colspan="3"|Необязательные параметры
|-
|comment
|Строка
|Комментарий
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|oper_id
|Целое
|ИД операции
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_client_operation HTTP/1.1

Signature: <...>

Content-Type: application/x-www-form-urlencoded

Content-Length: 127

client_id=112&oper_time=20130221100719&oper_sum=300&oper_type=receipt&pay_type=cash&comment=COMMENT

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"oper_id":31

}
}
</pre>

=== Запрос операций по клиенту ===

Метод: GET

Название запроса: get_client_operations

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента (может отсутствовать, если phone заполнен)
|-
|phone
|Строка, <= 16 символов
|Телефон клиента (может отсутствовать, если client_id заполнен)
|-
|start_time
|ГГГГММДДччммсс
|Начало периода
|-
|finish_time
|ГГГГММДДччммсс
|Конец периода
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|oper_id
|Целое
|ИД операции
|-
|oper_time
|ГГГГММДДччммсс
|Время создания операции
|-
|sum
|Дробное
|Сумма
|-
|order_id
|Целое
|Заказ, связанный с операцией
|-
|oper_type
|Целое
|Тип операции:
• "receipt" - приход
• "expense" - расход
|-
|pay_type
|Целое
|Тип оплаты:
• "cash" - наличный
• "nocash" - безналичный
|}

Пример:

<pre>
Запрос:

GET

https://ip:port/common_api/1.0/get_client_operations?client_id=112&start_time=20130201092112&finish_time=20130221092112 HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"operations":[
{
"oper_id":112,
"oper_time":"20130219091328",
"sum":"21,8",
"order_id":11800,
"oper_type":"receipt",
"pay_type":"cash",
"comment":"jgznm"
},
{
"oper_id":112,
"oper_time":"20130220112245",
"sum":"4500",
"order_id":11801,
"oper_type":"receipt",
"pay_type":"cash",
"comment":"блин"
}
]
}
}
</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 HTTP/1.1
</pre>

Для получения данных из БД используются запросы типа GET. Для записи данных в БД используются запросы типа POST. В запросе типа GET параметры запроса передаются в URI.

Пример:

<pre>
GET https://ip:port/tm_tapi/1.0/get_info_by_phone?phone=89058800565&fields=PHONE_TYPEPHONE_
TO_DIAL&signature=661ce071eeefcb4f7fc8bc1f17bd520b HTTP/1.1
</pre>

В запросе типа POST параметры передаются в теле запроса в формате application/x-wwwform-
urlencoded.

Пример:

<pre>
POST https://ip:port/tm_tapi/1.0/change_order_state HTTP/1.1
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 HTTP/1.1

Секретный ключ:
321

Signature = MD5("phone=89058800565&fields=PHONE_TYPE" + "321") = ef17ea682d09e452af544a5758dba396
HTTP/1.1
</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 - если звонит номер из справочника телефоны; 0 - неизвестный номер)
|-
|PHONE_TO_DIAL
|Строка, <= 16 символов
|Номер телефона для отзвона по заказу
|-
|CREW_ID
|Целое
|ИД экипажа
|-
|IS_PRIOR
|true или false
|Признак предварительного заказа
|-
|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
|Целое
|ИД группы экипажа
|-
|CLIENT_BALANCE
|Дробное
|Баланс клиента
|-
|DRIVER_TIMECOUNT
|Целое
|Время пути водителя до адреса подачи в минутах
|-
|SOURCE_TIMECOUNT
|Целое
|Время оставшееся до подачи в минутах
|-
|SOUND_COLOR
|Строка
|Запись с информацией о цвете
|-
|SOUND_GOSNUMBER
|Строка
|Запись с информацией о государственном номере автомобиля
|-
|SOUND_MARK
|Строка
|Запись с информацией о марке автомобиля
|-
|GOSNUMBER
|Строка
|Государственный номер автомобиля
|-
|CAR_COLOR
|Строка
|Цвет автомобиля
|-
|CAR_MARK
|Строка
|Марка автомобиля
|}

Пример:

<pre>
Запрос:
GET https://ip:port/tm_tapi/1.0/get_info_by_phone?phone=89058800565l&fields=PHONE_TYPEPHONE_
TO_DIAL-CREW_ID-ORDER_ID&signature=d35ab2765f2968d48c096d5f5327db26 HTTP/1.1

Ответ:

<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>
</data>
</response>
</pre>

==== Запрос информации по ИД заказа ====

Метод: GET
Название запроса: get_info_by_order_id
Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|-
|fields
|Строка
|Список полей, которые необходимо вернуть. Поля перечисляются через ''-''
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

Специальные возвращаемые коды: нет
Возвращаемые данные в случае успешного выполнения запроса: зависит от того какие поля были переданы в поле fields.

{|
!Параметр
!Тип
!Описание
|-
|DRIVER_SOURCETIME
|Строка, <= 16 символов
|Время до подачи в минутах, указанное водителем
|-
|SOUND_COLOR
|Строка
|Запись с информацией о цвете
|-
|MARK
|Строка
|Марка автомобиля
|-
|COLOR
|Строка
|Цвет автомобиля
|-
|GOSNUMBER
|Строка
|Государственный номер автомобиля
|-
|SOUND_MARK
|Строка
|Запись с информацией о марке автомобиля
|-
|CREWGROUPID
|Целое
|ИД группы экипажа
|-
|IS_PRIOR
|true или false
|Признак предварительного заказа
|-
|DISCOUNTEDSUMM
|Строка
|Сумма заказа с учетом всех скидок
|-
|MOBILE_PHONE
|Строка, <= 16 символов
|Номер телефона водителя
|-
|CATEGORYID
|Целое
|ИД категории телефона
|-
|SOURCE_TIME
|Целое
|Время до подачи в минутах
|}

Пример:

<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
HTTP/1.1

Ответ:

<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></SOURCE_TIME>
</data>
</response>
</pre>

==== Смена состояния заказа ====
Метод: POST

Название запроса: change_order_state

Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|-
|need_state
|Целое
|Новое состояние заказа
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

Специальные возвращаемые коды:

{|
!Код
!Описание
|-
|100
|Заказ с таким ИД не найден.
|-
|101
|Изменение состояния не соответствует необходимым условиям.
|}

Возвращаемые данные в случае успешного выполнения запроса

{|
!Параметр
!Тип
!Описание
|-
|ORDER_ID
|Целое
|ИД созданного заказа
|-
|NEW_STATE
|Целое
|Новое состояние заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/tm_tapi/1.0/change_order_state HTTP/1.1
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"|Обязательные параметры
|-
|RECORD_DATE
|ГГГГММДДччммсс
|Дата записи
|-
|RECORD_LENGTH
|Целое
|Продолжительность записи (в секундах)
|-
|PHONE
|Строка, <= 16 символов
|Номер телефона
|-
|ORDERID
|Целое
|Заказ, с которого сделана запись
|-
|USERID
|Целое
|Пользователь, сделавший запись
|-
|FILE_PATH
|Строка,<=255 символов
|Путь к файлу записи
|-
|RECORD_GUID
|Строка,<= 80 символов
|GUID звонка
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

Специальные возвращаемые коды: нет
Возвращаемые данные в случае успешного выполнения запроса

{|
!Параметр
!Тип
!Описание
|-
|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: 206
RECORD_DATE=20121108145953&RECORD_LENGTH=6546&PHONE=654321&ORDERID=654&USERID=564&FILE_PATH=d%3A
%5CProjects%5Ctrunk%5C%5Ftrunk%5CTM%5CBin
%5C&RECORD_GUID=GUID456258&signature=cd11d50d65fa7e8ad73f80cdc7d296c7

Ответ:

<response>
<code>0</code>
<descr>OK</descr>
<data>
<RECORD_ID>25</RECORD_ID>
</data>
</response>
</pre>

==== Создать новый заказ ====

Метод: POST

Название запроса: make_new_order

Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|PHONE
|Строка, <= 16 символов
|Номер телефона
|-
|ORDER_STATE_ID
|Целое
|ИД состояния заказа
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|-
|colspan="3"|Необязательные параметры
|-
|CREW_GROUP_ID
|Целое
|ИД группы экипажа
|-
|TARIFF_ID
|Целое
|ИД тарифа
|-
|PHONE_PREFIX
|Строка
|Префикс, отрезаемый от номера телефона при поиске в базе данных. Для входящих звонков это код города с префиксом входящих номеров, обычно "8". Например, "83412"
|-
|DISCOUNTED_SU MM
|Строка
|Фиксированная сумма за заказ
|}

Специальные возвращаемые коды:

{|
!Код
!Описание
|-
|100
|Клиент не найден
|}

Возвращаемые данные в случае успешного выполнения запроса

{|
!Параметр
!Тип
!Описание
|-
|ORDER_ID
|Целое
|ИД созданного заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/tm_tapi/1.0/make_new_order HTTP/1.1
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>
</pre>

== Пример формы для заказа такси ==
{{url|{{корень FTP|forms/zakaz_taxi.zip}}}}

Данная форма является примером, на основе которого можно построить собственную форму для принятия интернет-заказов. Форму можно использовать либо в исходном варианте, либо применяя запросы [[TM API#Описание запросов|TM API]].
Для того, чтобы данная форма функционировала, необходимо открыть файл в любом текстовом редакторе и указать корректные IP-адрес [[Сервер Такси-Мастер|сервера Такси-Мастер]], порт [[TM API#Параметры TM API|TM API]] и секретный ключ. Далее вам следует загрузить файл на хостинг.

Именно так будет выглядеть данная форма для заказа такси.
{{картинка|Форма для заказа такси.jpg}}

[[Категория:ТМ2]]

TM API

2013-10-01T14:59:32Z

AnnaNikolskih: /* Запрос информации по клиенту */

'''TM API''' - специальный набор инструментов [[Такси-Мастер]], который позволит объединить систему с вашим сайтом и различными полезными сервисами. Он предоставляется вам на свободных условиях.

Благодаря этому набору вы сможете:

# Создать механизм приема заказов через интернет.
# Сделать ваш сайт более информативным: публиковать полезную для клиентов информацию прямо из системы - список ближайших [[Справочник «Экипажи»|экипажей]], предварительный расчет стоимости поездки, мониторинг движения автомобиля такси в процессе выполнения [[заказ]]а, [[Модуль «Интеграция с картами»|карты города]] и контактную информацию.
# Расширить возможности своей службы за счет популярного онлайн-сервиса Яндекс Такси.

== Параметры TM API ==
Задать настройки для корректной работы TM API вы сможете в программе [[Такси-Мастер]] в меню {{tab|Настройки}} в одноименной ветке {{tab|TM API}}.
Параметры организуют и контролируют работу [[Модуль «Интернет-заказы»|модуля «Интернет-заказы»]].
# Установите флажок {{checkbox|Использовать TM API}}, чтобы приступить к его использованию.
# В поле {{поле|Локальный порт}} введите номер порта подключения к интернету, на котором работает и будет ожидать запросы о новых заказах [[TMServer]]. Рекомендуется оставить номер порта по умолчанию.
# Установите флажок {{checkbox|Можно использовать данное рабочее место TMServer для распознавания адресов}} для того, чтобы конкретно с данного рабочего места происходило распознавание адресов модулем "Интернет-заказы".
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

=== Ветка «Открытое API» ===
В данной ветке регулируется доступ к синхронизации Такси-Мастер со сторонним сервисом (сайтом), с помощью которого клиенты будут создавать интернет-заказы. С примером кода для работы вы можете ознакомиться в данной статье в разделе [[TM API#Общее описание протокола|Общее описание протокола]].
# Установите флажок {{checkbox|Использовать открытое API}} для того, чтобы запустить работу по обслуживанию модуля «Интернет-заказы». При установленном флажке сервер [[Модуль «Интернет-заказы»|модуля «Интернет-заказы»]] запускается и ожидает запросы о новых заказах.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы с модулем «Интернет-заказы», который будет выслан вам в письме от менеджера.
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

=== Ветка «API для телефонии» ===
В данной ветке регулируются настройки API для телефонии, т.е. взаимодействие [[Такси-Мастер]] с call-центром через программный интерфейс. С его помощью [[Call-центр Oktell|call-центр]] может дать команду Такси-Мастер создать [[зака]]з или запросить информацию о [[Справочник «Состояния заказа»|статусе текущего заказа]].
# Установите флажок {{checkbox|Использовать открытое API для телефонии}} для того, чтобы запустить работу по обслуживанию телефонии через API.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы.
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

=== Ветка «Платежные терминалы» ===
{{info|Ранее для связи [[Модуль интеграции с платежными системами|платежных систем]] и [[Такси-Мастер]] служила такая утилита, как TMWeb. В данный момент мы отказались от ее использования, а функции были распределены между двумя компонентами системы: TM API и [[TMServer]].}}

Параметры этой ветки отвечают за работу [[Модуль интеграции с платежными терминалами|модуля интеграции с платежными системами]].
# Установите флажок {{checkbox|Включить прием терминальных платежей}}. Данная функция позволит отображать все платежные операции по приходу средств от водителей через терминалы в [[База данных Такси-Мастер 2|базе данных]] программы.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы с платежными системами и сверки платежей, который будет выслан вам в письме от менеджера. Секретный ключ - это определенный набор символов, необходимый для формирования подписи при передаче информации о платеже.
# В полях {{поле|Логин}} и {{поле|Пароль}} введите данные учетной записи на сайте http://term.bitmaster.ru.
# Кнопка {{кнопка|Задать всем водителям терминальный аккаунт по их ИД}} служит для соединения TM API с сервером Такси-Мастер. В результате соединения записи о терминальных аккаунтах генерируются, заносятся (для тех водителей, у которых они отсутствуют) и обновляются (для тех водителей, у которых уже существуют терминальные аккаунты) в Такси-Мастер.
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

{{info|Обратите внимание, что для платежных систем также существует открытый и свободно распространяемый API, с помощью которого есть возможность связать [[Такси-Мастер]] и [[Модуль интеграции с платежными системами|платежные системы]]. Обратитесь в отдел дополнительных услуг, написав на {{ящик ОДУ}}, за получением кода для данного компонента системы.}}

== Общее описание протокола ==

=== Формат запроса ===

[[TMAPI]] принимает входящие запросы по протоколу HTTPS. В URI запроса после ip адреса и порта, который будет слушать TMWeb, должно идти название API (common_api) и версия
API. Пример:

<pre>
GET https://ip:port/common_api/1.0/get_crew_groups_list HTTP/1.1
</pre>

Для получения данных из БД используются запросы типа GET. Для записи данных в [[База данных Такси-Мастер|базу данных]] используются запросы типа POST. В запросе типа GET параметры запроса передаются в URI. Пример:
<pre>
GET https://ip:port/common_api/1.0/calc_order_cost?tariff_id=1&distance_city=10 HTTP/1.1
Signature: <...>
</pre>

В запросе типа POST параметры передаются в теле запроса в формате application/x-wwwform-urlencoded. Пример:

<pre>
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
</pre>

В любом запросе обязательно должен быть заголовок Signature. В нем передается MD5 хэш, рассчитанный для строки, которая получается сцеплением строки параметров запроса с секретным ключом. Секретный ключ задается в настройках модуля TMWeb в ТМ2. Пример:

<pre>
Запрос:
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
</pre>

=== Формат ответа ===

TMWeb всегда возвращает HTTP код 200 ОК. Результат выполнения запроса содержится в теле ответа в формате JSON. Общий вид возвращаемого результата:

<pre>
{
"code":<Числовой код результата>,
"descr":"<Строковое описание результата>",
"data":{<Дополнительная информация>}
}
</pre>

Существуют общие для всех запросов коды результатов:
{|
! Код
! Описание
|-
|0
|Успешное выполнение запроса
|-
|1
|Неизвестная ошибка
|-
|2
|Неизвестный тип API
|-
|3
|API отключено в настройках TMWeb
|-
|4
|Не совпадает секретный ключ
|-
|5
|Неподдерживаемая версия API
|-
|6
|Неизвестное название запроса
|-
|7
|Неверный тип запроса GET/POST
|-
|8
|Не хватает входного параметра (в доп. информации ответа будет название отсутствующего параметра)
|-
|9
|Некорректный входной параметр (в доп. информации ответа будет название некорректного параметра)
|-
|10
|Внутренняя ошибка обработки запроса
|}

== Описание запросов ==

=== Запрос-пинг ===
Для данного запроса не проверяется версия API, секретный ключ и тип запроса GET/ POST.

Метод: GET или POST

Название запроса: ping

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример:

<pre>
Запрос:
GET https://ip:port/common_api/1.0/ping HTTP/1.1
Ответ:
{
"code":0,
"descr":"OK",
"data":{}
}
</pre>

=== Запрос списка групп экипажей ===
Метод: GET

Название запроса: get_crew_groups_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crew_groups
|Массив
|Список групп экипажей
|-
|• id
|Целое
|ИД группы экипажей
|-
|• name
|Строка
|Название группы экипажей
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_crew_groups_list HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"crew_groups":[
{
"id":1,
"name":"CREW_GROUP1"
},
{
"id":2,
"name":"CREW_GROUP2"
}
]
}
}
</pre>

=== Запрос списка служб ЕДС ===

Метод: GET

Название запроса: get_uds_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр
!Тип
!Описание
|-
|uds
|Массив
|Список служб [[Модуль «Единая диспетчерская служба»|ЕДС]]
|-
|• id
|Целое
|ИД службы [[Модуль «Единая диспетчерская служба»|ЕДС]]
|-
|• name
|Строка
|Название службы [[Модуль «Единая диспетчерская служба»|ЕДС]]
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_uds_list HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"uds":[
{
"id":1,
"name":"UDS1"
},
{
"id":2,
"name":"UDS2"
}
]
}
}
</pre>

=== Запрос списка тарифов ===

Метод: GET

Название запроса: get_tariffs_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр
!Тип
!Описание
|-
|tariffs
|Массив
|Список [[Справочник «Тарифы»|тарифов]]
|-
|• id
|Целое
|ИД [[Справочник «Тарифы»|тарифа]]
|-
|• name
|Строка
|Название [[Справочник «Тарифы»|тарифа]]
|-
|• is_active
|true или false
|Активный [[Справочник «Тарифы»|тариф]]
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_tariffs_list HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"tariffs":[
{
"id":1,
"name":"TARIFF1"
"is_active":true
},
{
"id":2,
"name":"TARIFF2"
"is_active":true
}
]
}
}
</pre>

=== Запрос списка услуг ===
Метод: GET

Название запроса: get_services_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр
!Тип
!Описание
|-
|services
|Массив
|Список [[Справочник «Услуги»|услуг]]
|-
|• id
|Целое
|ИД [[Справочник «Услуги»|услуги]]
|-
|• name
|Строка
|Название [[Справочник «Услуги»|услуги]]
|-
|• sum
|Дробное
|Абсолютная сумма [[Справочник «Услуги»|услуги]], руб
|-
|• percent
|Дробное
|Процент [[Справочник «Услуги»|услуги]] от стоимости заказа, %
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_services_list HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"services":[
{
"id":1,
"name":"SERVICE1",
"sum":100,
"percent":0
},
{
"id":2,
"name":"SERVICE2"
"sum":0,
"percent":10
}
]
}
}
</pre>

=== Запрос списка скидок ===
Метод: GET

Название запроса: get_discounts_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр
!Тип
!Описание
|-
|discounts
|Массив
|Список [[Справочник «Скидки клиентов»|скидок]]
|-
|• id
|Целое
|ИД [[Справочник «Скидки клиентов»|скидки]]
|-
|• name
|Строка
|Название [[Справочник «Скидки клиентов»|скидки]]
|-
|• sum
|Дробное
|Абсолютная сумма [[Справочник «Скидки клиентов»|скидки]], руб
|-
|• percent
|Дробное
|Процент [[Справочник «Скидки клиентов»|скидки]] от стоимости заказа, %
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_discounts_list HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"discounts":[
{
"id":1,
"name":"DISCOUNT1",
"sum":100,
"percent":0
},
{
"id":2,
"name":"DISCOUNT2"
"sum":0,
"percent":10
}
]
}
}
</pre>

=== Создание нового заказа ===
Метод: POST

Название запроса: create_order

Параметры:

{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|phone
|Строка, <= 16 символов
|Номер телефона
|-
|source
|Строка
|Адрес подачи
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
!colspan="3"|Необязательные параметры
|-
|dest
|Строка
|Адрес назначения
|-
|customer
|Строка
|Заказчик
|-
|comment
|Строка
|Комментарий
|-
|crew_group_id
|Целое
|ИД группы экипажей
|-
|uds_id
|Целое
|ИД службы ЕДС
|-
|tariff_id
|Целое
|ИД тарифа
|-
|is_prior
|true или false
|Предварительный заказ
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Заказ с такими параметрами уже создан
|-
|101
|Тариф не найден
|-
|102
|Группа экипажа не найдена
|-
|103
|Служба ЕДС не найдена
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|order_id
|Целое
|ИД созданного заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_order HTTP/1.1
Signature: <...>
Content-Type: application/x-www-form-urlencoded
Content-Length: 127
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

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"order_id":12345
}
}
</pre>

=== Расчет суммы заказа ===

Метод: GET

Название запроса: calc_order_cost
{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|tariff_id
|Целое
|ИД тарифа
|-
Параметры:

!colspan="3"|Необязательные параметры
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|is_prior
|true или false
|Предварительный заказ
|-
|client_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»
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Тариф не найден
|-
|101
|Ошибка при расчете по тарифу
|-
|102
|Скидка не найдена
|-
|103
|Клиент не найден
|-
|104
|Район подачи не найден
|-
|105
|Район назначения не найден
|-
|106
|Дисконтная карта не найдена
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|sum
|Дробное
|Рассчитанная общая сумма заказа
|-
|info
|Массив
|Дополнительная информация по расчету суммы заказа
|-
| • comment
|Строка
|Описание позиции дополнительной информации по расчету суммы заказа
|-
| • sum
|Строка
|Сумма позиции дополнительной информации по расчету суммы заказа
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/calc_order_cost?
tariff_id=1&source_time=20120501100000&is_prior=false&client_id=1&discount_id=1&disc_card_id=1&sour
ce_zone_id=1&dest_zone_id=2&distance_city=10&distance_country=20&source_distance_country=5&is_count
ry=true&waiting_minutes=10&is_hourly=false&hourly_minutes=60&is_prize=true&back_way=false&services=
1;2;3 HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"sum":1000,
"info":[
{
"comment":"SUM1",
"sum":"100"
},
{
"comment":"SUM2",
"sum":"200"
}
]
}
}
</pre>

=== Запрос информации об экипаже ===
Метод: GET

Название запроса: get_crew_info

Параметры:
{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|crew_id
|Целое
|ИД экипажа
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Экипаж не найден
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crew_id
|Целое
|ИД экипажа
|-
|code
|Строка
|Позывной экипажа
|-
|name
|Строка
|Наименование экипажа
|-
|driver_id
|Целое
|ИД водителя
|-
|car_id
|Целое
|ИД автомобиля
|-
|crew_group_id
|Целое
|ИД группы экипажа
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_crew_info?crew_id=1 HTTP/1.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
}
}
</pre>

=== Запрос информации о водителе ===
Метод: GET

Название запроса: get_driver_info

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|driver_id
|Целое
|ИД водителя
|-
!colspan="3"|Необязательные параметры
|-
|need_photo
|true или false
|Нужна ли фотография водителя
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Водитель не найден
|}

Возвращаемые параметры в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|driver_id
|Целое
|ИД водителя
|-
|name
|Строка
|ФИО водителя
|-
|birthday
|ДД.ММ.ГГГГ
|День рождения водителя
|-
|car_id
|Целое
|ИД основного автомобиля водителя
|-
|license
|Строка
|Удостоверение водителя
|-
|home_phone
|Строка
|Домашний телефон водителя
|-
|mobile_phone
|Строка
|Мобильный телефон водителя
|-
|is_locked
|true или false
|Водитель заблокирован
|-
|is_dismissed
|true или false
|Водитель уволен
|-
|driver_photo
|Base64
|Фото водителя (только если need_photo = true)
|}

Пример:

<pre>
Запрос:

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",
"birthday":"01.01.1980",
"car_id":1,
"license":"1234567890",
"home_phone":"123456",
"mobile_phone":"+79123456789",
"is_locked":false,
"is_dismissed":false
}
}
</pre>

=== Запрос информации об автомобиле ===
Метод: GET

Название запроса: get_car_info

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|car_id
|Целое
|ИД автомобиля
|-
!colspan="3"|Необязательные параметры
|-
|need_photo
|true или false
|Нужна ли фотография автомобиля
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Автомобиль не найден
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|car_id
|Целое
|ИД автомобиля
|-
|name
|Строка
|Наименование автомобиля
|-
|code
|Строка
|Позывной автомобиля
|-
|gos_number
|Строка
|Государственный номер автомобиля
|-
|color
|Строка
|Цвет автомобиля
|-
|mark
|Строка
|Марка автомобиля
|-
|short_name
|Строка
|Краткое название автомобиля
|-
|production_year
|Целое
|Год выпуска автомобиля
|-
|car_photo
|Base64
|Фото автомобиля (только если need_photo = true)
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_car_info?car_id=1&need_photo=false HTTP/1.1
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
}
}
</pre>

=== Запрос координат экипажей ===
Метод: GET

Название запроса: get_crews_coords

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Необязательные параметры
|-
|crew_id
|Целое
|ИД экипажа, по которому нужно вернуть координаты. Если не задано, то будут возвращены координаты всех экипажей на линии.
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Координаты не найдены
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crews_coords
|Массив
|Список координат экипажей
|-
|• crew_id
|Целое
|ИД экипажа
|-
|• crew_code
|Строка
|Позывной экипажа
|-
|• coords_time
|ГГГГММДДччммсс
|Время получения координат
|-
|• lat
|Дробное
|Долгота
|-
|• lon
|Дробное
|Широта
|-
|• state_kind
|Строка
|Тип состояния экипажа. Может принимать значения:
• "not_available" — экипаж не на линии

• "waiting" — экипаж свободен, ожидает заказы

• "on_order" — экипаж на заказе

• "on_break" — экипаж на перерыве
|}

Пример:

<pre>

Запрос:
GET https://ip:port/common_api/1.0/get_crews_coords HTTP/1.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"
},
{
"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 HTTP/1.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"
}
]
}
}
</pre>

=== Запрос адресов, содержащих нужную строку ===
Метод: GET

Название запроса: get_addresses_like

Параметры:

{|
!Параметры
!Тип
!Описание
|-
! colspan="3"|Обязательные параметры
|-
|get_streets
|true или false
|Искать улицы
|-
|get_houses
|true или false
|Искать пункты
|-
|get_streets
|true или false
|Искать дома. Не может быть равно true, если get_streets = true или get_points = true.
|-
|street
|Строка
|Часть названия улицы или пункта, если идет поиск улиц или пунктов, или полное название улицы, если идет поиск домов
|-
!colspan="3"|Необязательные параметры
|-
|house
|Строка
|Часть номера дома. Нужно только если get_houses = true.
|-
|max_addresses_count
|Целое
|Максимальное количество адресов в ответе
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Подходящие адреса не найдены
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|addresses
|Массив
|Список подходящих адресов
|-
|• street
|Строка
|Название улицы или пункта
|-
|• house
|Строка
|Номер дома
|-
|• kind
|Строка
|Тип адреса. Может принимать значения:
• "street" — улица

• "house" — дом

• "point" — пункт
|-
|• comment
|Строка
|Комментарий
|}

Пример:

<pre>

Запрос:

GET https://ip:port/common_api/1.0/get_addresses_like?get_streets=true&get_points=true&
get_houses=false&street=STREE HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"addresses":[
{
"street":"STREET1",
"house":"",
"kind":"street",
"comment":""
},
{
"street":"STREET2",
"house":"",
"kind":"street",
"comment":""
},
{
"street":"POINT_STREET1",
"house":"",
"kind":"point",
"comment":"Point at street STREET1"
}
]
}
}

Запрос:

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 HTTP/1.1
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":""
}
]
}
}
</pre>

=== Анализ маршрута ===
Метод: GET

Название запроса: analyze_route

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|source
|Строка
|Адрес подачи
|-
|dest
|Строка
|Адрес назначения
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Адрес подачи не распознан
|-
|101
|Адрес назначения не распознан
|-
|102
|Маршрут не распознан
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|source_lat
|Дробное
|Широта адреса подачи
|-
|source_lon
|Дробное
|Долгота адреса подачи
|-
|source_zone_id
|Целое
|ИД района подачи
|-
|dest_lat
|Дробное
|Широта адреса назначения
|-
|dest_lon
|Дробное
|Долгота адреса назначения
|-
|dest_zone_id
|Целое
|ИД района назначения
|-
|city_dist
|Дробное
|Километраж по городу
|-
|country_dist
|Дробное
|Километраж за городом
|-
|source_country_dist
|Дробное
|Километраж до адреса подачи, если адрес подачи за городом
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/analyze_route?source=STREET1,1&dest=STREET2,2 HTTP/1.1
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
}
}
</pre>

=== Запрос информации о состоянии заказа ===

Метод: GET

Название запроса: get_order_state

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|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
|Целое
|ИД автомобиля
|-
|start_time
|ГГГГММДДччммсс
|Время создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|finish_time
|ГГГГММДДччммсс
|Время завершения заказа
|-
|source
|Строка
|Адрес подачи
|-
|destination
|Строка
|Адрес назначения
|-
|passenger
|Строка
|Пассажир
|-
|phone
|Строка
|Номер телефона
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_order_state?order_id=1 HTTP/1.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
"start_time":"17.01.2013 12:56:41",
"source_time":"17.01.2013 13:26:17",
"finish_time":"17.01.2013 13:03:43",
"source":"1",
"destination":"2",
"passenger":"Слепаков",
"phone":"8800"
}
}
</pre>

=== Создание задачи СМС серверу ===

Метод: POST

Название запроса: send_sms

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|phone
|Строка, <= 16 символов
|Номер телефона
|-
|message
|Строка
|Текст СМС
|}

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример:

<pre>
Запрос:

POST /common_api/1.0/send_sms HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Content-Length: 33

Signature: <...>

message=SMSText&phone=89050057216

Ответ:

{
"code":0,
"descr":"OK",
"data":{}
}
</pre>

=== Проверка авторизации ===

Метод: GET

Название запроса: check_authorization

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|login
|Строка, <= 60 символов
|Логин
|-
|password
|Строка, <= 60 символов
|Пароль
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент с логином LOGIN и/или неверный пароль
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|client_id
|Целое
|ИД клиента
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/check_authorization?login=LOGIN&password=PASSWORD HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"client_id":131
}
}
</pre>

=== Регистрация клиента ===

Метод: POST

Название запроса: register_client

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|name
|Строка, <= 60 символов
|ФИО
|-
|login
|Строка, <= 60 символов
|Логин
|-
|password
|Строка, <= 60 символов
|Пароль
|-
|phones
|Строка
|Номера телефонов (через запятую)
|-
!colspan="3"|Необязательные параметры
|-
|address
|Строка
|Домашний адрес
|-
|birthday
|Строка
|Дата рождения
|-
|gender
|Строка
|Пол. Может принимать значения:
• "male" - мужской

• "female" - женский
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Клиент с номером телефона=PHONE уже существует
|-
|101
|Клиент с логином=LOGIN уже существует
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|client_id
|Целое
|ИД созданного клиента
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_order HTTP/1.1

Signature: <...>

Content-Type: application/x-www-form-urlencoded

Content-Length: 127

name=NAME&phones=88,99&login=LOGIN&password=PASSWORD&birthday=19930218115517&gender=male&address=ADDRESS

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"client_id":140
}
}
</pre>

=== Запрос информации по клиенту ===

Метод: GET

Название запроса: get_client_info

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|client_id
|Целое
|ИД клиента
|-
|name
|Строка
|ФИО
|-
|number
|Строка
|Номер договора
|-
|address
|Строка
|Домашний адрес
|-
|gender
|Строка
|Пол. Может принимать значения:

• "male" - мужской

• "female" - женский
|-
|birthday
|ДД.ММ.ГГГГ
|Дата рождения
|-
|phones
|Строка
|Номера телефонов (через запятую)
|-
|balance
|Дробное
|Баланс
|-
|login
|Строка
|Логин
|-
|password
|Строка
|Пароль
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_client_info?client_id=140 HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"client_id":140,
"name":"Васильев Артём",
"number":"000140",
"address":"Бутово,45",
"gender":"male",
"birthday":"18.02.1993",
"phones":"[\"88\",\"99\"]",
"balance":1467,
"login":"artem",
"password":"vasilev"
}
}
</pre>

=== Изменение информации по клиенту ===

Метод: POST

Название запроса: register_client

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента
|-
!colspan="3"|Необязательные параметры
|-
|name
|Строка, <= 60 символов
|ФИО
|-
|login
|Строка, <= 60 символов
|Логин
|-
|password
|Строка, <= 60 символов
|Пароль
|-
|phones
|Строка
|Номера телефонов (через запятую)
|-
|address
|Строка
|Домашний адрес
|-
|birthday
|ДД.ММ.ГГГГ
|Дата рождения
|-
|gender
|Строка
|Пол. Может принимать значения:
• "male" - мужской

• "female" - женский
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Клиент с номером телефона=PHONE уже существует
|-
|101
|Клиент с ИД=ID имеет такой же номер телефона=PHONE
|-
|102
|Клиент с логином=LOGIN уже существует
|}

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_order HTTP/1.1
Signature: <...>
Content-Type: application/x-www-form-urlencoded
Content-Length: 127

client_id=140&name=NAME&phones=88,99&login=LOGIN&password=PASSWORD&birthday=19930218115517&gender=male&address=ADDRESS

Ответ:

{
"code":0,
"descr":"OK",
"data":{}
}
</pre>

=== Запрос текущих заказов ===

Метод: GET

Название запроса: get_current_orders

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента (может отсутствовать, если phone заполнен)
|-
|phone
|Строка, <= 16 символов
|Телефон клиента (может отсутствовать, если client_id заполнен)
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|id
|Целое
|ИД заказа
|-
|state_id
|Целое
|ИД состояния заказа
|-
|start_time
|ГГГГММДДччммсс
|Дата создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|birthday
|ДД.ММ.ГГГГ
|Дата рождения
|-
|source
|Строка
|Адрес подачи
|-
|destination
|Строка
|Адрес назначения
|-
|passenger
|Строка
|Пассажир
|-
|crew_id
|Целое
|ИД экипажа
|-
|prior_crew_id
|Целое
|ИД предварительного экипажа
|-
|driver_id
|Целое
|ИД водителя
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_current_orders?client_id=140&phone=18 HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"orders":[
{
"id":20648,
"state_id":44,
"start_time":"20130204181111",
"source_time":"20130204181111",
"source":"1-й пр-т \/Москва\/,",
"destination":"12-й мкр,",
"passenger":"маша",
"crew_id":0,
"prior_crew_id":0,
"driver_id":0
},
{
"id":20670,
"state_id":44,
"start_time":"20130207153022",
"source_time":"20130207153022",
"source":"11-й мкр,",
"destination":"1-й пр-т \/Москва\/,",
"passenger":"саша",
"crew_id":0,
"prior_crew_id":0,
"driver_id":0
}
]
}
}
</pre>

=== Запрос выполненных заказов ===

Метод: GET

Название запроса: get_finished_orders

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента (может отсутствовать, если phone заполнен)
|-
|phone
|Строка, <= 16 символов
|Телефон клиента (может отсутствовать, если client_id заполнен)
|-
|start_time
|ГГГГММДДччммсс
|Начало периода
|-
|finish_time
|ГГГГММДДччммсс
|Конец периода
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|id
|Целое
|ИД заказа
|-
|state_id
|Целое
|ИД состояния заказа
|-
|start_time
|ГГГГММДДччммсс
|Дата создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|finish_time
|ГГГГММДДччммсс
|Время завершения заказа
|-
|birthday
|ДД.ММ.ГГГГ
|Дата рождения
|-
|source
|Строка
|Адрес подачи
|-
|destination
|Строка
|Адрес назначения
|-
|sum
|Дробное
|Стоимость заказа без учета скидок(наценок)
|-
|passenger
|Строка
|Пассажир
|-
|crew_id
|Целое
|ИД экипажа
|-
|prior_crew_id
|Целое
|ИД предварительного экипажа
|-
|driver_id
|Целое
|ИД водителя
|-
|car_id
|Целое
|ИД автомобиля
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_finished_orders?client_id=140&phone= HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"orders":[
{
"id":20651,
"state_id":34,
"source_time":"20130205110812",
"start_time":"20130205110812",
"finish_time":"20130205115618",
"source":"прпроп",
"destination":"рррррр",
"passenger":"вера",
"sum":"908",
"crew_id":"6",
"prior_crew_id":0,
"driver_id":"4",
"car_id":"6"
},
{
"id":20669,
"state_id":34,
"source_time":"20130205130500",
"start_time":"20130205130500",
"finish_time":"20130205134511",
"source":"1",
"destination":"2",
"passenger":"маша",
"sum":"454",
"crew_id":"6",
"prior_crew_id":0,
"driver_id":"4",
"car_id":"6"
}
]
}
}
</pre>

=== Проведение операции по клиенту ===

Метод: POST

Название запроса: create_client_operation

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента
|-
|oper_time
|ГГГГММДДччммсс
|Время создания операции
|-
|sum
|Дробное
|Сумма
|-
|oper_type
|Целое
|Тип операции:
• "receipt" - приход

• "expense" - расход
|-
|pay_type
|Целое
|Тип оплаты:
• "cash" - наличный

• "nocash" - безналичный
|-
!colspan="3"|Необязательные параметры
|-
|comment
|Строка
|Комментарий
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|oper_id
|Целое
|ИД операции
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_client_operation HTTP/1.1

Signature: <...>

Content-Type: application/x-www-form-urlencoded

Content-Length: 127

client_id=112&oper_time=20130221100719&oper_sum=300&oper_type=receipt&pay_type=cash&comment=COMMENT

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"oper_id":31

}
}
</pre>

=== Запрос операций по клиенту ===

Метод: GET

Название запроса: get_client_operations

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента (может отсутствовать, если phone заполнен)
|-
|phone
|Строка, <= 16 символов
|Телефон клиента (может отсутствовать, если client_id заполнен)
|-
|start_time
|ГГГГММДДччммсс
|Начало периода
|-
|finish_time
|ГГГГММДДччммсс
|Конец периода
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|oper_id
|Целое
|ИД операции
|-
|oper_time
|ГГГГММДДччммсс
|Время создания операции
|-
|sum
|Дробное
|Сумма
|-
|order_id
|Целое
|Заказ, связанный с операцией
|-
|oper_type
|Целое
|Тип операции:
• "receipt" - приход
• "expense" - расход
|-
|pay_type
|Целое
|Тип оплаты:
• "cash" - наличный
• "nocash" - безналичный
|}

Пример:

<pre>
Запрос:

GET

https://ip:port/common_api/1.0/get_client_operations?client_id=112&start_time=20130201092112&finish_time=20130221092112 HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"operations":[
{
"oper_id":112,
"oper_time":"20130219091328",
"sum":"21,8",
"order_id":11800,
"oper_type":"receipt",
"pay_type":"cash",
"comment":"jgznm"
},
{
"oper_id":112,
"oper_time":"20130220112245",
"sum":"4500",
"order_id":11801,
"oper_type":"receipt",
"pay_type":"cash",
"comment":"блин"
}
]
}
}
</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 HTTP/1.1
</pre>

Для получения данных из БД используются запросы типа GET. Для записи данных в БД используются запросы типа POST. В запросе типа GET параметры запроса передаются в URI.

Пример:

<pre>
GET https://ip:port/tm_tapi/1.0/get_info_by_phone?phone=89058800565&fields=PHONE_TYPEPHONE_
TO_DIAL&signature=661ce071eeefcb4f7fc8bc1f17bd520b HTTP/1.1
</pre>

В запросе типа POST параметры передаются в теле запроса в формате application/x-wwwform-
urlencoded.

Пример:

<pre>
POST https://ip:port/tm_tapi/1.0/change_order_state HTTP/1.1
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 HTTP/1.1

Секретный ключ:
321

Signature = MD5("phone=89058800565&fields=PHONE_TYPE" + "321") = ef17ea682d09e452af544a5758dba396
HTTP/1.1
</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 - если звонит номер из справочника телефоны; 0 - неизвестный номер)
|-
|PHONE_TO_DIAL
|Строка, <= 16 символов
|Номер телефона для отзвона по заказу
|-
|CREW_ID
|Целое
|ИД экипажа
|-
|IS_PRIOR
|true или false
|Признак предварительного заказа
|-
|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
|Целое
|ИД группы экипажа
|-
|CLIENT_BALANCE
|Дробное
|Баланс клиента
|-
|DRIVER_TIMECOUNT
|Целое
|Время пути водителя до адреса подачи в минутах
|-
|SOURCE_TIMECOUNT
|Целое
|Время оставшееся до подачи в минутах
|-
|SOUND_COLOR
|Строка
|Запись с информацией о цвете
|-
|SOUND_GOSNUMBER
|Строка
|Запись с информацией о государственном номере автомобиля
|-
|SOUND_MARK
|Строка
|Запись с информацией о марке автомобиля
|-
|GOSNUMBER
|Строка
|Государственный номер автомобиля
|-
|CAR_COLOR
|Строка
|Цвет автомобиля
|-
|CAR_MARK
|Строка
|Марка автомобиля
|}

Пример:

<pre>
Запрос:
GET https://ip:port/tm_tapi/1.0/get_info_by_phone?phone=89058800565l&fields=PHONE_TYPEPHONE_
TO_DIAL-CREW_ID-ORDER_ID&signature=d35ab2765f2968d48c096d5f5327db26 HTTP/1.1

Ответ:

<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>
</data>
</response>
</pre>

==== Запрос информации по ИД заказа ====

Метод: GET
Название запроса: get_info_by_order_id
Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|-
|fields
|Строка
|Список полей, которые необходимо вернуть. Поля перечисляются через ''-''
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

Специальные возвращаемые коды: нет
Возвращаемые данные в случае успешного выполнения запроса: зависит от того какие поля были переданы в поле fields.

{|
!Параметр
!Тип
!Описание
|-
|DRIVER_SOURCETIME
|Строка, <= 16 символов
|Время до подачи в минутах, указанное водителем
|-
|SOUND_COLOR
|Строка
|Запись с информацией о цвете
|-
|MARK
|Строка
|Марка автомобиля
|-
|COLOR
|Строка
|Цвет автомобиля
|-
|GOSNUMBER
|Строка
|Государственный номер автомобиля
|-
|SOUND_MARK
|Строка
|Запись с информацией о марке автомобиля
|-
|CREWGROUPID
|Целое
|ИД группы экипажа
|-
|IS_PRIOR
|true или false
|Признак предварительного заказа
|-
|DISCOUNTEDSUMM
|Строка
|Сумма заказа с учетом всех скидок
|-
|MOBILE_PHONE
|Строка, <= 16 символов
|Номер телефона водителя
|-
|CATEGORYID
|Целое
|ИД категории телефона
|-
|SOURCE_TIME
|Целое
|Время до подачи в минутах
|}

Пример:

<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
HTTP/1.1

Ответ:

<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></SOURCE_TIME>
</data>
</response>
</pre>

==== Смена состояния заказа ====
Метод: POST

Название запроса: change_order_state

Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|-
|need_state
|Целое
|Новое состояние заказа
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

Специальные возвращаемые коды:

{|
!Код
!Описание
|-
|100
|Заказ с таким ИД не найден.
|-
|101
|Изменение состояния не соответствует необходимым условиям.
|}

Возвращаемые данные в случае успешного выполнения запроса

{|
!Параметр
!Тип
!Описание
|-
|ORDER_ID
|Целое
|ИД созданного заказа
|-
|NEW_STATE
|Целое
|Новое состояние заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/tm_tapi/1.0/change_order_state HTTP/1.1
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"|Обязательные параметры
|-
|RECORD_DATE
|ГГГГММДДччммсс
|Дата записи
|-
|RECORD_LENGTH
|Целое
|Продолжительность записи (в секундах)
|-
|PHONE
|Строка, <= 16 символов
|Номер телефона
|-
|ORDERID
|Целое
|Заказ, с которого сделана запись
|-
|USERID
|Целое
|Пользователь, сделавший запись
|-
|FILE_PATH
|Строка,<=255 символов
|Путь к файлу записи
|-
|RECORD_GUID
|Строка,<= 80 символов
|GUID звонка
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

Специальные возвращаемые коды: нет
Возвращаемые данные в случае успешного выполнения запроса

{|
!Параметр
!Тип
!Описание
|-
|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: 206
RECORD_DATE=20121108145953&RECORD_LENGTH=6546&PHONE=654321&ORDERID=654&USERID=564&FILE_PATH=d%3A
%5CProjects%5Ctrunk%5C%5Ftrunk%5CTM%5CBin
%5C&RECORD_GUID=GUID456258&signature=cd11d50d65fa7e8ad73f80cdc7d296c7

Ответ:

<response>
<code>0</code>
<descr>OK</descr>
<data>
<RECORD_ID>25</RECORD_ID>
</data>
</response>
</pre>

==== Создать новый заказ ====

Метод: POST

Название запроса: make_new_order

Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|PHONE
|Строка, <= 16 символов
|Номер телефона
|-
|ORDER_STATE_ID
|Целое
|ИД состояния заказа
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|-
|colspan="3"|Необязательные параметры
|-
|CREW_GROUP_ID
|Целое
|ИД группы экипажа
|-
|TARIFF_ID
|Целое
|ИД тарифа
|-
|PHONE_PREFIX
|Строка
|Префикс, отрезаемый от номера телефона при поиске в базе данных. Для входящих звонков это код города с префиксом входящих номеров, обычно "8". Например, "83412"
|-
|DISCOUNTED_SU MM
|Строка
|Фиксированная сумма за заказ
|}

Специальные возвращаемые коды:

{|
!Код
!Описание
|-
|100
|Клиент не найден
|}

Возвращаемые данные в случае успешного выполнения запроса

{|
!Параметр
!Тип
!Описание
|-
|ORDER_ID
|Целое
|ИД созданного заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/tm_tapi/1.0/make_new_order HTTP/1.1
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>
</pre>

== Пример формы для заказа такси ==
{{url|{{корень FTP|forms/zakaz_taxi.zip}}}}

Данная форма является примером, на основе которого можно построить собственную форму для принятия интернет-заказов. Форму можно использовать либо в исходном варианте, либо применяя запросы [[TM API#Описание запросов|TM API]].
Для того, чтобы данная форма функционировала, необходимо открыть файл в любом текстовом редакторе и указать корректные IP-адрес [[Сервер Такси-Мастер|сервера Такси-Мастер]], порт [[TM API#Параметры TM API|TM API]] и секретный ключ. Далее вам следует загрузить файл на хостинг.

Именно так будет выглядеть данная форма для заказа такси.
{{картинка|Форма для заказа такси.jpg}}

[[Категория:ТМ2]]

TM API

2013-10-01T14:59:01Z

AnnaNikolskih: /* Запрос информации по клиенту */

'''TM API''' - специальный набор инструментов [[Такси-Мастер]], который позволит объединить систему с вашим сайтом и различными полезными сервисами. Он предоставляется вам на свободных условиях.

Благодаря этому набору вы сможете:

# Создать механизм приема заказов через интернет.
# Сделать ваш сайт более информативным: публиковать полезную для клиентов информацию прямо из системы - список ближайших [[Справочник «Экипажи»|экипажей]], предварительный расчет стоимости поездки, мониторинг движения автомобиля такси в процессе выполнения [[заказ]]а, [[Модуль «Интеграция с картами»|карты города]] и контактную информацию.
# Расширить возможности своей службы за счет популярного онлайн-сервиса Яндекс Такси.

== Параметры TM API ==
Задать настройки для корректной работы TM API вы сможете в программе [[Такси-Мастер]] в меню {{tab|Настройки}} в одноименной ветке {{tab|TM API}}.
Параметры организуют и контролируют работу [[Модуль «Интернет-заказы»|модуля «Интернет-заказы»]].
# Установите флажок {{checkbox|Использовать TM API}}, чтобы приступить к его использованию.
# В поле {{поле|Локальный порт}} введите номер порта подключения к интернету, на котором работает и будет ожидать запросы о новых заказах [[TMServer]]. Рекомендуется оставить номер порта по умолчанию.
# Установите флажок {{checkbox|Можно использовать данное рабочее место TMServer для распознавания адресов}} для того, чтобы конкретно с данного рабочего места происходило распознавание адресов модулем "Интернет-заказы".
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

=== Ветка «Открытое API» ===
В данной ветке регулируется доступ к синхронизации Такси-Мастер со сторонним сервисом (сайтом), с помощью которого клиенты будут создавать интернет-заказы. С примером кода для работы вы можете ознакомиться в данной статье в разделе [[TM API#Общее описание протокола|Общее описание протокола]].
# Установите флажок {{checkbox|Использовать открытое API}} для того, чтобы запустить работу по обслуживанию модуля «Интернет-заказы». При установленном флажке сервер [[Модуль «Интернет-заказы»|модуля «Интернет-заказы»]] запускается и ожидает запросы о новых заказах.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы с модулем «Интернет-заказы», который будет выслан вам в письме от менеджера.
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

=== Ветка «API для телефонии» ===
В данной ветке регулируются настройки API для телефонии, т.е. взаимодействие [[Такси-Мастер]] с call-центром через программный интерфейс. С его помощью [[Call-центр Oktell|call-центр]] может дать команду Такси-Мастер создать [[зака]]з или запросить информацию о [[Справочник «Состояния заказа»|статусе текущего заказа]].
# Установите флажок {{checkbox|Использовать открытое API для телефонии}} для того, чтобы запустить работу по обслуживанию телефонии через API.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы.
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

=== Ветка «Платежные терминалы» ===
{{info|Ранее для связи [[Модуль интеграции с платежными системами|платежных систем]] и [[Такси-Мастер]] служила такая утилита, как TMWeb. В данный момент мы отказались от ее использования, а функции были распределены между двумя компонентами системы: TM API и [[TMServer]].}}

Параметры этой ветки отвечают за работу [[Модуль интеграции с платежными терминалами|модуля интеграции с платежными системами]].
# Установите флажок {{checkbox|Включить прием терминальных платежей}}. Данная функция позволит отображать все платежные операции по приходу средств от водителей через терминалы в [[База данных Такси-Мастер 2|базе данных]] программы.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы с платежными системами и сверки платежей, который будет выслан вам в письме от менеджера. Секретный ключ - это определенный набор символов, необходимый для формирования подписи при передаче информации о платеже.
# В полях {{поле|Логин}} и {{поле|Пароль}} введите данные учетной записи на сайте http://term.bitmaster.ru.
# Кнопка {{кнопка|Задать всем водителям терминальный аккаунт по их ИД}} служит для соединения TM API с сервером Такси-Мастер. В результате соединения записи о терминальных аккаунтах генерируются, заносятся (для тех водителей, у которых они отсутствуют) и обновляются (для тех водителей, у которых уже существуют терминальные аккаунты) в Такси-Мастер.
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

{{info|Обратите внимание, что для платежных систем также существует открытый и свободно распространяемый API, с помощью которого есть возможность связать [[Такси-Мастер]] и [[Модуль интеграции с платежными системами|платежные системы]]. Обратитесь в отдел дополнительных услуг, написав на {{ящик ОДУ}}, за получением кода для данного компонента системы.}}

== Общее описание протокола ==

=== Формат запроса ===

[[TMAPI]] принимает входящие запросы по протоколу HTTPS. В URI запроса после ip адреса и порта, который будет слушать TMWeb, должно идти название API (common_api) и версия
API. Пример:

<pre>
GET https://ip:port/common_api/1.0/get_crew_groups_list HTTP/1.1
</pre>

Для получения данных из БД используются запросы типа GET. Для записи данных в [[База данных Такси-Мастер|базу данных]] используются запросы типа POST. В запросе типа GET параметры запроса передаются в URI. Пример:
<pre>
GET https://ip:port/common_api/1.0/calc_order_cost?tariff_id=1&distance_city=10 HTTP/1.1
Signature: <...>
</pre>

В запросе типа POST параметры передаются в теле запроса в формате application/x-wwwform-urlencoded. Пример:

<pre>
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
</pre>

В любом запросе обязательно должен быть заголовок Signature. В нем передается MD5 хэш, рассчитанный для строки, которая получается сцеплением строки параметров запроса с секретным ключом. Секретный ключ задается в настройках модуля TMWeb в ТМ2. Пример:

<pre>
Запрос:
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
</pre>

=== Формат ответа ===

TMWeb всегда возвращает HTTP код 200 ОК. Результат выполнения запроса содержится в теле ответа в формате JSON. Общий вид возвращаемого результата:

<pre>
{
"code":<Числовой код результата>,
"descr":"<Строковое описание результата>",
"data":{<Дополнительная информация>}
}
</pre>

Существуют общие для всех запросов коды результатов:
{|
! Код
! Описание
|-
|0
|Успешное выполнение запроса
|-
|1
|Неизвестная ошибка
|-
|2
|Неизвестный тип API
|-
|3
|API отключено в настройках TMWeb
|-
|4
|Не совпадает секретный ключ
|-
|5
|Неподдерживаемая версия API
|-
|6
|Неизвестное название запроса
|-
|7
|Неверный тип запроса GET/POST
|-
|8
|Не хватает входного параметра (в доп. информации ответа будет название отсутствующего параметра)
|-
|9
|Некорректный входной параметр (в доп. информации ответа будет название некорректного параметра)
|-
|10
|Внутренняя ошибка обработки запроса
|}

== Описание запросов ==

=== Запрос-пинг ===
Для данного запроса не проверяется версия API, секретный ключ и тип запроса GET/ POST.

Метод: GET или POST

Название запроса: ping

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример:

<pre>
Запрос:
GET https://ip:port/common_api/1.0/ping HTTP/1.1
Ответ:
{
"code":0,
"descr":"OK",
"data":{}
}
</pre>

=== Запрос списка групп экипажей ===
Метод: GET

Название запроса: get_crew_groups_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crew_groups
|Массив
|Список групп экипажей
|-
|• id
|Целое
|ИД группы экипажей
|-
|• name
|Строка
|Название группы экипажей
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_crew_groups_list HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"crew_groups":[
{
"id":1,
"name":"CREW_GROUP1"
},
{
"id":2,
"name":"CREW_GROUP2"
}
]
}
}
</pre>

=== Запрос списка служб ЕДС ===

Метод: GET

Название запроса: get_uds_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр
!Тип
!Описание
|-
|uds
|Массив
|Список служб [[Модуль «Единая диспетчерская служба»|ЕДС]]
|-
|• id
|Целое
|ИД службы [[Модуль «Единая диспетчерская служба»|ЕДС]]
|-
|• name
|Строка
|Название службы [[Модуль «Единая диспетчерская служба»|ЕДС]]
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_uds_list HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"uds":[
{
"id":1,
"name":"UDS1"
},
{
"id":2,
"name":"UDS2"
}
]
}
}
</pre>

=== Запрос списка тарифов ===

Метод: GET

Название запроса: get_tariffs_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр
!Тип
!Описание
|-
|tariffs
|Массив
|Список [[Справочник «Тарифы»|тарифов]]
|-
|• id
|Целое
|ИД [[Справочник «Тарифы»|тарифа]]
|-
|• name
|Строка
|Название [[Справочник «Тарифы»|тарифа]]
|-
|• is_active
|true или false
|Активный [[Справочник «Тарифы»|тариф]]
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_tariffs_list HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"tariffs":[
{
"id":1,
"name":"TARIFF1"
"is_active":true
},
{
"id":2,
"name":"TARIFF2"
"is_active":true
}
]
}
}
</pre>

=== Запрос списка услуг ===
Метод: GET

Название запроса: get_services_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр
!Тип
!Описание
|-
|services
|Массив
|Список [[Справочник «Услуги»|услуг]]
|-
|• id
|Целое
|ИД [[Справочник «Услуги»|услуги]]
|-
|• name
|Строка
|Название [[Справочник «Услуги»|услуги]]
|-
|• sum
|Дробное
|Абсолютная сумма [[Справочник «Услуги»|услуги]], руб
|-
|• percent
|Дробное
|Процент [[Справочник «Услуги»|услуги]] от стоимости заказа, %
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_services_list HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"services":[
{
"id":1,
"name":"SERVICE1",
"sum":100,
"percent":0
},
{
"id":2,
"name":"SERVICE2"
"sum":0,
"percent":10
}
]
}
}
</pre>

=== Запрос списка скидок ===
Метод: GET

Название запроса: get_discounts_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр
!Тип
!Описание
|-
|discounts
|Массив
|Список [[Справочник «Скидки клиентов»|скидок]]
|-
|• id
|Целое
|ИД [[Справочник «Скидки клиентов»|скидки]]
|-
|• name
|Строка
|Название [[Справочник «Скидки клиентов»|скидки]]
|-
|• sum
|Дробное
|Абсолютная сумма [[Справочник «Скидки клиентов»|скидки]], руб
|-
|• percent
|Дробное
|Процент [[Справочник «Скидки клиентов»|скидки]] от стоимости заказа, %
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_discounts_list HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"discounts":[
{
"id":1,
"name":"DISCOUNT1",
"sum":100,
"percent":0
},
{
"id":2,
"name":"DISCOUNT2"
"sum":0,
"percent":10
}
]
}
}
</pre>

=== Создание нового заказа ===
Метод: POST

Название запроса: create_order

Параметры:

{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|phone
|Строка, <= 16 символов
|Номер телефона
|-
|source
|Строка
|Адрес подачи
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
!colspan="3"|Необязательные параметры
|-
|dest
|Строка
|Адрес назначения
|-
|customer
|Строка
|Заказчик
|-
|comment
|Строка
|Комментарий
|-
|crew_group_id
|Целое
|ИД группы экипажей
|-
|uds_id
|Целое
|ИД службы ЕДС
|-
|tariff_id
|Целое
|ИД тарифа
|-
|is_prior
|true или false
|Предварительный заказ
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Заказ с такими параметрами уже создан
|-
|101
|Тариф не найден
|-
|102
|Группа экипажа не найдена
|-
|103
|Служба ЕДС не найдена
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|order_id
|Целое
|ИД созданного заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_order HTTP/1.1
Signature: <...>
Content-Type: application/x-www-form-urlencoded
Content-Length: 127
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

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"order_id":12345
}
}
</pre>

=== Расчет суммы заказа ===

Метод: GET

Название запроса: calc_order_cost
{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|tariff_id
|Целое
|ИД тарифа
|-
Параметры:

!colspan="3"|Необязательные параметры
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|is_prior
|true или false
|Предварительный заказ
|-
|client_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»
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Тариф не найден
|-
|101
|Ошибка при расчете по тарифу
|-
|102
|Скидка не найдена
|-
|103
|Клиент не найден
|-
|104
|Район подачи не найден
|-
|105
|Район назначения не найден
|-
|106
|Дисконтная карта не найдена
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|sum
|Дробное
|Рассчитанная общая сумма заказа
|-
|info
|Массив
|Дополнительная информация по расчету суммы заказа
|-
| • comment
|Строка
|Описание позиции дополнительной информации по расчету суммы заказа
|-
| • sum
|Строка
|Сумма позиции дополнительной информации по расчету суммы заказа
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/calc_order_cost?
tariff_id=1&source_time=20120501100000&is_prior=false&client_id=1&discount_id=1&disc_card_id=1&sour
ce_zone_id=1&dest_zone_id=2&distance_city=10&distance_country=20&source_distance_country=5&is_count
ry=true&waiting_minutes=10&is_hourly=false&hourly_minutes=60&is_prize=true&back_way=false&services=
1;2;3 HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"sum":1000,
"info":[
{
"comment":"SUM1",
"sum":"100"
},
{
"comment":"SUM2",
"sum":"200"
}
]
}
}
</pre>

=== Запрос информации об экипаже ===
Метод: GET

Название запроса: get_crew_info

Параметры:
{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|crew_id
|Целое
|ИД экипажа
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Экипаж не найден
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crew_id
|Целое
|ИД экипажа
|-
|code
|Строка
|Позывной экипажа
|-
|name
|Строка
|Наименование экипажа
|-
|driver_id
|Целое
|ИД водителя
|-
|car_id
|Целое
|ИД автомобиля
|-
|crew_group_id
|Целое
|ИД группы экипажа
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_crew_info?crew_id=1 HTTP/1.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
}
}
</pre>

=== Запрос информации о водителе ===
Метод: GET

Название запроса: get_driver_info

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|driver_id
|Целое
|ИД водителя
|-
!colspan="3"|Необязательные параметры
|-
|need_photo
|true или false
|Нужна ли фотография водителя
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Водитель не найден
|}

Возвращаемые параметры в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|driver_id
|Целое
|ИД водителя
|-
|name
|Строка
|ФИО водителя
|-
|birthday
|ДД.ММ.ГГГГ
|День рождения водителя
|-
|car_id
|Целое
|ИД основного автомобиля водителя
|-
|license
|Строка
|Удостоверение водителя
|-
|home_phone
|Строка
|Домашний телефон водителя
|-
|mobile_phone
|Строка
|Мобильный телефон водителя
|-
|is_locked
|true или false
|Водитель заблокирован
|-
|is_dismissed
|true или false
|Водитель уволен
|-
|driver_photo
|Base64
|Фото водителя (только если need_photo = true)
|}

Пример:

<pre>
Запрос:

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",
"birthday":"01.01.1980",
"car_id":1,
"license":"1234567890",
"home_phone":"123456",
"mobile_phone":"+79123456789",
"is_locked":false,
"is_dismissed":false
}
}
</pre>

=== Запрос информации об автомобиле ===
Метод: GET

Название запроса: get_car_info

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|car_id
|Целое
|ИД автомобиля
|-
!colspan="3"|Необязательные параметры
|-
|need_photo
|true или false
|Нужна ли фотография автомобиля
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Автомобиль не найден
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|car_id
|Целое
|ИД автомобиля
|-
|name
|Строка
|Наименование автомобиля
|-
|code
|Строка
|Позывной автомобиля
|-
|gos_number
|Строка
|Государственный номер автомобиля
|-
|color
|Строка
|Цвет автомобиля
|-
|mark
|Строка
|Марка автомобиля
|-
|short_name
|Строка
|Краткое название автомобиля
|-
|production_year
|Целое
|Год выпуска автомобиля
|-
|car_photo
|Base64
|Фото автомобиля (только если need_photo = true)
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_car_info?car_id=1&need_photo=false HTTP/1.1
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
}
}
</pre>

=== Запрос координат экипажей ===
Метод: GET

Название запроса: get_crews_coords

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Необязательные параметры
|-
|crew_id
|Целое
|ИД экипажа, по которому нужно вернуть координаты. Если не задано, то будут возвращены координаты всех экипажей на линии.
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Координаты не найдены
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crews_coords
|Массив
|Список координат экипажей
|-
|• crew_id
|Целое
|ИД экипажа
|-
|• crew_code
|Строка
|Позывной экипажа
|-
|• coords_time
|ГГГГММДДччммсс
|Время получения координат
|-
|• lat
|Дробное
|Долгота
|-
|• lon
|Дробное
|Широта
|-
|• state_kind
|Строка
|Тип состояния экипажа. Может принимать значения:
• "not_available" — экипаж не на линии

• "waiting" — экипаж свободен, ожидает заказы

• "on_order" — экипаж на заказе

• "on_break" — экипаж на перерыве
|}

Пример:

<pre>

Запрос:
GET https://ip:port/common_api/1.0/get_crews_coords HTTP/1.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"
},
{
"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 HTTP/1.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"
}
]
}
}
</pre>

=== Запрос адресов, содержащих нужную строку ===
Метод: GET

Название запроса: get_addresses_like

Параметры:

{|
!Параметры
!Тип
!Описание
|-
! colspan="3"|Обязательные параметры
|-
|get_streets
|true или false
|Искать улицы
|-
|get_houses
|true или false
|Искать пункты
|-
|get_streets
|true или false
|Искать дома. Не может быть равно true, если get_streets = true или get_points = true.
|-
|street
|Строка
|Часть названия улицы или пункта, если идет поиск улиц или пунктов, или полное название улицы, если идет поиск домов
|-
!colspan="3"|Необязательные параметры
|-
|house
|Строка
|Часть номера дома. Нужно только если get_houses = true.
|-
|max_addresses_count
|Целое
|Максимальное количество адресов в ответе
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Подходящие адреса не найдены
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|addresses
|Массив
|Список подходящих адресов
|-
|• street
|Строка
|Название улицы или пункта
|-
|• house
|Строка
|Номер дома
|-
|• kind
|Строка
|Тип адреса. Может принимать значения:
• "street" — улица

• "house" — дом

• "point" — пункт
|-
|• comment
|Строка
|Комментарий
|}

Пример:

<pre>

Запрос:

GET https://ip:port/common_api/1.0/get_addresses_like?get_streets=true&get_points=true&
get_houses=false&street=STREE HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"addresses":[
{
"street":"STREET1",
"house":"",
"kind":"street",
"comment":""
},
{
"street":"STREET2",
"house":"",
"kind":"street",
"comment":""
},
{
"street":"POINT_STREET1",
"house":"",
"kind":"point",
"comment":"Point at street STREET1"
}
]
}
}

Запрос:

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 HTTP/1.1
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":""
}
]
}
}
</pre>

=== Анализ маршрута ===
Метод: GET

Название запроса: analyze_route

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|source
|Строка
|Адрес подачи
|-
|dest
|Строка
|Адрес назначения
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Адрес подачи не распознан
|-
|101
|Адрес назначения не распознан
|-
|102
|Маршрут не распознан
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|source_lat
|Дробное
|Широта адреса подачи
|-
|source_lon
|Дробное
|Долгота адреса подачи
|-
|source_zone_id
|Целое
|ИД района подачи
|-
|dest_lat
|Дробное
|Широта адреса назначения
|-
|dest_lon
|Дробное
|Долгота адреса назначения
|-
|dest_zone_id
|Целое
|ИД района назначения
|-
|city_dist
|Дробное
|Километраж по городу
|-
|country_dist
|Дробное
|Километраж за городом
|-
|source_country_dist
|Дробное
|Километраж до адреса подачи, если адрес подачи за городом
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/analyze_route?source=STREET1,1&dest=STREET2,2 HTTP/1.1
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
}
}
</pre>

=== Запрос информации о состоянии заказа ===

Метод: GET

Название запроса: get_order_state

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|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
|Целое
|ИД автомобиля
|-
|start_time
|ГГГГММДДччммсс
|Время создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|finish_time
|ГГГГММДДччммсс
|Время завершения заказа
|-
|source
|Строка
|Адрес подачи
|-
|destination
|Строка
|Адрес назначения
|-
|passenger
|Строка
|Пассажир
|-
|phone
|Строка
|Номер телефона
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_order_state?order_id=1 HTTP/1.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
"start_time":"17.01.2013 12:56:41",
"source_time":"17.01.2013 13:26:17",
"finish_time":"17.01.2013 13:03:43",
"source":"1",
"destination":"2",
"passenger":"Слепаков",
"phone":"8800"
}
}
</pre>

=== Создание задачи СМС серверу ===

Метод: POST

Название запроса: send_sms

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|phone
|Строка, <= 16 символов
|Номер телефона
|-
|message
|Строка
|Текст СМС
|}

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример:

<pre>
Запрос:

POST /common_api/1.0/send_sms HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Content-Length: 33

Signature: <...>

message=SMSText&phone=89050057216

Ответ:

{
"code":0,
"descr":"OK",
"data":{}
}
</pre>

=== Проверка авторизации ===

Метод: GET

Название запроса: check_authorization

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|login
|Строка, <= 60 символов
|Логин
|-
|password
|Строка, <= 60 символов
|Пароль
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент с логином LOGIN и/или неверный пароль
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|client_id
|Целое
|ИД клиента
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/check_authorization?login=LOGIN&password=PASSWORD HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"client_id":131
}
}
</pre>

=== Регистрация клиента ===

Метод: POST

Название запроса: register_client

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|name
|Строка, <= 60 символов
|ФИО
|-
|login
|Строка, <= 60 символов
|Логин
|-
|password
|Строка, <= 60 символов
|Пароль
|-
|phones
|Строка
|Номера телефонов (через запятую)
|-
!colspan="3"|Необязательные параметры
|-
|address
|Строка
|Домашний адрес
|-
|birthday
|Строка
|Дата рождения
|-
|gender
|Строка
|Пол. Может принимать значения:
• "male" - мужской

• "female" - женский
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Клиент с номером телефона=PHONE уже существует
|-
|101
|Клиент с логином=LOGIN уже существует
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|client_id
|Целое
|ИД созданного клиента
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_order HTTP/1.1

Signature: <...>

Content-Type: application/x-www-form-urlencoded

Content-Length: 127

name=NAME&phones=88,99&login=LOGIN&password=PASSWORD&birthday=19930218115517&gender=male&address=ADDRESS

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"client_id":140
}
}
</pre>

=== Запрос информации по клиенту ===

Метод: GET

Название запроса: get_client_info

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|client_id
|Целое
|ИД клиента
|-
|name
|Строка
|Номер договора
|-
|number
|Строка
|Номер договора
|-
|address
|Строка
|Домашний адрес
|-
|gender
|Строка
|Пол. Может принимать значения:

• "male" - мужской

• "female" - женский
|-
|birthday
|ДД.ММ.ГГГГ
|Дата рождения
|-
|phones
|Строка
|Номера телефонов (через запятую)
|-
|balance
|Дробное
|Баланс
|-
|login
|Строка
|Логин
|-
|password
|Строка
|Пароль
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_client_info?client_id=140 HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"client_id":140,
"name":"Васильев Артём",
"number":"000140",
"address":"Бутово,45",
"gender":"male",
"birthday":"18.02.1993",
"phones":"[\"88\",\"99\"]",
"balance":1467,
"login":"artem",
"password":"vasilev"
}
}
</pre>

=== Изменение информации по клиенту ===

Метод: POST

Название запроса: register_client

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента
|-
!colspan="3"|Необязательные параметры
|-
|name
|Строка, <= 60 символов
|ФИО
|-
|login
|Строка, <= 60 символов
|Логин
|-
|password
|Строка, <= 60 символов
|Пароль
|-
|phones
|Строка
|Номера телефонов (через запятую)
|-
|address
|Строка
|Домашний адрес
|-
|birthday
|ДД.ММ.ГГГГ
|Дата рождения
|-
|gender
|Строка
|Пол. Может принимать значения:
• "male" - мужской

• "female" - женский
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Клиент с номером телефона=PHONE уже существует
|-
|101
|Клиент с ИД=ID имеет такой же номер телефона=PHONE
|-
|102
|Клиент с логином=LOGIN уже существует
|}

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_order HTTP/1.1
Signature: <...>
Content-Type: application/x-www-form-urlencoded
Content-Length: 127

client_id=140&name=NAME&phones=88,99&login=LOGIN&password=PASSWORD&birthday=19930218115517&gender=male&address=ADDRESS

Ответ:

{
"code":0,
"descr":"OK",
"data":{}
}
</pre>

=== Запрос текущих заказов ===

Метод: GET

Название запроса: get_current_orders

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента (может отсутствовать, если phone заполнен)
|-
|phone
|Строка, <= 16 символов
|Телефон клиента (может отсутствовать, если client_id заполнен)
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|id
|Целое
|ИД заказа
|-
|state_id
|Целое
|ИД состояния заказа
|-
|start_time
|ГГГГММДДччммсс
|Дата создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|birthday
|ДД.ММ.ГГГГ
|Дата рождения
|-
|source
|Строка
|Адрес подачи
|-
|destination
|Строка
|Адрес назначения
|-
|passenger
|Строка
|Пассажир
|-
|crew_id
|Целое
|ИД экипажа
|-
|prior_crew_id
|Целое
|ИД предварительного экипажа
|-
|driver_id
|Целое
|ИД водителя
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_current_orders?client_id=140&phone=18 HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"orders":[
{
"id":20648,
"state_id":44,
"start_time":"20130204181111",
"source_time":"20130204181111",
"source":"1-й пр-т \/Москва\/,",
"destination":"12-й мкр,",
"passenger":"маша",
"crew_id":0,
"prior_crew_id":0,
"driver_id":0
},
{
"id":20670,
"state_id":44,
"start_time":"20130207153022",
"source_time":"20130207153022",
"source":"11-й мкр,",
"destination":"1-й пр-т \/Москва\/,",
"passenger":"саша",
"crew_id":0,
"prior_crew_id":0,
"driver_id":0
}
]
}
}
</pre>

=== Запрос выполненных заказов ===

Метод: GET

Название запроса: get_finished_orders

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента (может отсутствовать, если phone заполнен)
|-
|phone
|Строка, <= 16 символов
|Телефон клиента (может отсутствовать, если client_id заполнен)
|-
|start_time
|ГГГГММДДччммсс
|Начало периода
|-
|finish_time
|ГГГГММДДччммсс
|Конец периода
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|id
|Целое
|ИД заказа
|-
|state_id
|Целое
|ИД состояния заказа
|-
|start_time
|ГГГГММДДччммсс
|Дата создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|finish_time
|ГГГГММДДччммсс
|Время завершения заказа
|-
|birthday
|ДД.ММ.ГГГГ
|Дата рождения
|-
|source
|Строка
|Адрес подачи
|-
|destination
|Строка
|Адрес назначения
|-
|sum
|Дробное
|Стоимость заказа без учета скидок(наценок)
|-
|passenger
|Строка
|Пассажир
|-
|crew_id
|Целое
|ИД экипажа
|-
|prior_crew_id
|Целое
|ИД предварительного экипажа
|-
|driver_id
|Целое
|ИД водителя
|-
|car_id
|Целое
|ИД автомобиля
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_finished_orders?client_id=140&phone= HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"orders":[
{
"id":20651,
"state_id":34,
"source_time":"20130205110812",
"start_time":"20130205110812",
"finish_time":"20130205115618",
"source":"прпроп",
"destination":"рррррр",
"passenger":"вера",
"sum":"908",
"crew_id":"6",
"prior_crew_id":0,
"driver_id":"4",
"car_id":"6"
},
{
"id":20669,
"state_id":34,
"source_time":"20130205130500",
"start_time":"20130205130500",
"finish_time":"20130205134511",
"source":"1",
"destination":"2",
"passenger":"маша",
"sum":"454",
"crew_id":"6",
"prior_crew_id":0,
"driver_id":"4",
"car_id":"6"
}
]
}
}
</pre>

=== Проведение операции по клиенту ===

Метод: POST

Название запроса: create_client_operation

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента
|-
|oper_time
|ГГГГММДДччммсс
|Время создания операции
|-
|sum
|Дробное
|Сумма
|-
|oper_type
|Целое
|Тип операции:
• "receipt" - приход

• "expense" - расход
|-
|pay_type
|Целое
|Тип оплаты:
• "cash" - наличный

• "nocash" - безналичный
|-
!colspan="3"|Необязательные параметры
|-
|comment
|Строка
|Комментарий
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|oper_id
|Целое
|ИД операции
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_client_operation HTTP/1.1

Signature: <...>

Content-Type: application/x-www-form-urlencoded

Content-Length: 127

client_id=112&oper_time=20130221100719&oper_sum=300&oper_type=receipt&pay_type=cash&comment=COMMENT

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"oper_id":31

}
}
</pre>

=== Запрос операций по клиенту ===

Метод: GET

Название запроса: get_client_operations

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента (может отсутствовать, если phone заполнен)
|-
|phone
|Строка, <= 16 символов
|Телефон клиента (может отсутствовать, если client_id заполнен)
|-
|start_time
|ГГГГММДДччммсс
|Начало периода
|-
|finish_time
|ГГГГММДДччммсс
|Конец периода
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|oper_id
|Целое
|ИД операции
|-
|oper_time
|ГГГГММДДччммсс
|Время создания операции
|-
|sum
|Дробное
|Сумма
|-
|order_id
|Целое
|Заказ, связанный с операцией
|-
|oper_type
|Целое
|Тип операции:
• "receipt" - приход
• "expense" - расход
|-
|pay_type
|Целое
|Тип оплаты:
• "cash" - наличный
• "nocash" - безналичный
|}

Пример:

<pre>
Запрос:

GET

https://ip:port/common_api/1.0/get_client_operations?client_id=112&start_time=20130201092112&finish_time=20130221092112 HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"operations":[
{
"oper_id":112,
"oper_time":"20130219091328",
"sum":"21,8",
"order_id":11800,
"oper_type":"receipt",
"pay_type":"cash",
"comment":"jgznm"
},
{
"oper_id":112,
"oper_time":"20130220112245",
"sum":"4500",
"order_id":11801,
"oper_type":"receipt",
"pay_type":"cash",
"comment":"блин"
}
]
}
}
</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 HTTP/1.1
</pre>

Для получения данных из БД используются запросы типа GET. Для записи данных в БД используются запросы типа POST. В запросе типа GET параметры запроса передаются в URI.

Пример:

<pre>
GET https://ip:port/tm_tapi/1.0/get_info_by_phone?phone=89058800565&fields=PHONE_TYPEPHONE_
TO_DIAL&signature=661ce071eeefcb4f7fc8bc1f17bd520b HTTP/1.1
</pre>

В запросе типа POST параметры передаются в теле запроса в формате application/x-wwwform-
urlencoded.

Пример:

<pre>
POST https://ip:port/tm_tapi/1.0/change_order_state HTTP/1.1
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 HTTP/1.1

Секретный ключ:
321

Signature = MD5("phone=89058800565&fields=PHONE_TYPE" + "321") = ef17ea682d09e452af544a5758dba396
HTTP/1.1
</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 - если звонит номер из справочника телефоны; 0 - неизвестный номер)
|-
|PHONE_TO_DIAL
|Строка, <= 16 символов
|Номер телефона для отзвона по заказу
|-
|CREW_ID
|Целое
|ИД экипажа
|-
|IS_PRIOR
|true или false
|Признак предварительного заказа
|-
|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
|Целое
|ИД группы экипажа
|-
|CLIENT_BALANCE
|Дробное
|Баланс клиента
|-
|DRIVER_TIMECOUNT
|Целое
|Время пути водителя до адреса подачи в минутах
|-
|SOURCE_TIMECOUNT
|Целое
|Время оставшееся до подачи в минутах
|-
|SOUND_COLOR
|Строка
|Запись с информацией о цвете
|-
|SOUND_GOSNUMBER
|Строка
|Запись с информацией о государственном номере автомобиля
|-
|SOUND_MARK
|Строка
|Запись с информацией о марке автомобиля
|-
|GOSNUMBER
|Строка
|Государственный номер автомобиля
|-
|CAR_COLOR
|Строка
|Цвет автомобиля
|-
|CAR_MARK
|Строка
|Марка автомобиля
|}

Пример:

<pre>
Запрос:
GET https://ip:port/tm_tapi/1.0/get_info_by_phone?phone=89058800565l&fields=PHONE_TYPEPHONE_
TO_DIAL-CREW_ID-ORDER_ID&signature=d35ab2765f2968d48c096d5f5327db26 HTTP/1.1

Ответ:

<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>
</data>
</response>
</pre>

==== Запрос информации по ИД заказа ====

Метод: GET
Название запроса: get_info_by_order_id
Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|-
|fields
|Строка
|Список полей, которые необходимо вернуть. Поля перечисляются через ''-''
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

Специальные возвращаемые коды: нет
Возвращаемые данные в случае успешного выполнения запроса: зависит от того какие поля были переданы в поле fields.

{|
!Параметр
!Тип
!Описание
|-
|DRIVER_SOURCETIME
|Строка, <= 16 символов
|Время до подачи в минутах, указанное водителем
|-
|SOUND_COLOR
|Строка
|Запись с информацией о цвете
|-
|MARK
|Строка
|Марка автомобиля
|-
|COLOR
|Строка
|Цвет автомобиля
|-
|GOSNUMBER
|Строка
|Государственный номер автомобиля
|-
|SOUND_MARK
|Строка
|Запись с информацией о марке автомобиля
|-
|CREWGROUPID
|Целое
|ИД группы экипажа
|-
|IS_PRIOR
|true или false
|Признак предварительного заказа
|-
|DISCOUNTEDSUMM
|Строка
|Сумма заказа с учетом всех скидок
|-
|MOBILE_PHONE
|Строка, <= 16 символов
|Номер телефона водителя
|-
|CATEGORYID
|Целое
|ИД категории телефона
|-
|SOURCE_TIME
|Целое
|Время до подачи в минутах
|}

Пример:

<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
HTTP/1.1

Ответ:

<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></SOURCE_TIME>
</data>
</response>
</pre>

==== Смена состояния заказа ====
Метод: POST

Название запроса: change_order_state

Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|-
|need_state
|Целое
|Новое состояние заказа
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

Специальные возвращаемые коды:

{|
!Код
!Описание
|-
|100
|Заказ с таким ИД не найден.
|-
|101
|Изменение состояния не соответствует необходимым условиям.
|}

Возвращаемые данные в случае успешного выполнения запроса

{|
!Параметр
!Тип
!Описание
|-
|ORDER_ID
|Целое
|ИД созданного заказа
|-
|NEW_STATE
|Целое
|Новое состояние заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/tm_tapi/1.0/change_order_state HTTP/1.1
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"|Обязательные параметры
|-
|RECORD_DATE
|ГГГГММДДччммсс
|Дата записи
|-
|RECORD_LENGTH
|Целое
|Продолжительность записи (в секундах)
|-
|PHONE
|Строка, <= 16 символов
|Номер телефона
|-
|ORDERID
|Целое
|Заказ, с которого сделана запись
|-
|USERID
|Целое
|Пользователь, сделавший запись
|-
|FILE_PATH
|Строка,<=255 символов
|Путь к файлу записи
|-
|RECORD_GUID
|Строка,<= 80 символов
|GUID звонка
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

Специальные возвращаемые коды: нет
Возвращаемые данные в случае успешного выполнения запроса

{|
!Параметр
!Тип
!Описание
|-
|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: 206
RECORD_DATE=20121108145953&RECORD_LENGTH=6546&PHONE=654321&ORDERID=654&USERID=564&FILE_PATH=d%3A
%5CProjects%5Ctrunk%5C%5Ftrunk%5CTM%5CBin
%5C&RECORD_GUID=GUID456258&signature=cd11d50d65fa7e8ad73f80cdc7d296c7

Ответ:

<response>
<code>0</code>
<descr>OK</descr>
<data>
<RECORD_ID>25</RECORD_ID>
</data>
</response>
</pre>

==== Создать новый заказ ====

Метод: POST

Название запроса: make_new_order

Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|PHONE
|Строка, <= 16 символов
|Номер телефона
|-
|ORDER_STATE_ID
|Целое
|ИД состояния заказа
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|-
|colspan="3"|Необязательные параметры
|-
|CREW_GROUP_ID
|Целое
|ИД группы экипажа
|-
|TARIFF_ID
|Целое
|ИД тарифа
|-
|PHONE_PREFIX
|Строка
|Префикс, отрезаемый от номера телефона при поиске в базе данных. Для входящих звонков это код города с префиксом входящих номеров, обычно "8". Например, "83412"
|-
|DISCOUNTED_SU MM
|Строка
|Фиксированная сумма за заказ
|}

Специальные возвращаемые коды:

{|
!Код
!Описание
|-
|100
|Клиент не найден
|}

Возвращаемые данные в случае успешного выполнения запроса

{|
!Параметр
!Тип
!Описание
|-
|ORDER_ID
|Целое
|ИД созданного заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/tm_tapi/1.0/make_new_order HTTP/1.1
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>
</pre>

== Пример формы для заказа такси ==
{{url|{{корень FTP|forms/zakaz_taxi.zip}}}}

Данная форма является примером, на основе которого можно построить собственную форму для принятия интернет-заказов. Форму можно использовать либо в исходном варианте, либо применяя запросы [[TM API#Описание запросов|TM API]].
Для того, чтобы данная форма функционировала, необходимо открыть файл в любом текстовом редакторе и указать корректные IP-адрес [[Сервер Такси-Мастер|сервера Такси-Мастер]], порт [[TM API#Параметры TM API|TM API]] и секретный ключ. Далее вам следует загрузить файл на хостинг.

Именно так будет выглядеть данная форма для заказа такси.
{{картинка|Форма для заказа такси.jpg}}

[[Категория:ТМ2]]

TM API

2013-10-01T14:48:09Z

AnnaNikolskih: /* Регистрация клиента */

'''TM API''' - специальный набор инструментов [[Такси-Мастер]], который позволит объединить систему с вашим сайтом и различными полезными сервисами. Он предоставляется вам на свободных условиях.

Благодаря этому набору вы сможете:

# Создать механизм приема заказов через интернет.
# Сделать ваш сайт более информативным: публиковать полезную для клиентов информацию прямо из системы - список ближайших [[Справочник «Экипажи»|экипажей]], предварительный расчет стоимости поездки, мониторинг движения автомобиля такси в процессе выполнения [[заказ]]а, [[Модуль «Интеграция с картами»|карты города]] и контактную информацию.
# Расширить возможности своей службы за счет популярного онлайн-сервиса Яндекс Такси.

== Параметры TM API ==
Задать настройки для корректной работы TM API вы сможете в программе [[Такси-Мастер]] в меню {{tab|Настройки}} в одноименной ветке {{tab|TM API}}.
Параметры организуют и контролируют работу [[Модуль «Интернет-заказы»|модуля «Интернет-заказы»]].
# Установите флажок {{checkbox|Использовать TM API}}, чтобы приступить к его использованию.
# В поле {{поле|Локальный порт}} введите номер порта подключения к интернету, на котором работает и будет ожидать запросы о новых заказах [[TMServer]]. Рекомендуется оставить номер порта по умолчанию.
# Установите флажок {{checkbox|Можно использовать данное рабочее место TMServer для распознавания адресов}} для того, чтобы конкретно с данного рабочего места происходило распознавание адресов модулем "Интернет-заказы".
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

=== Ветка «Открытое API» ===
В данной ветке регулируется доступ к синхронизации Такси-Мастер со сторонним сервисом (сайтом), с помощью которого клиенты будут создавать интернет-заказы. С примером кода для работы вы можете ознакомиться в данной статье в разделе [[TM API#Общее описание протокола|Общее описание протокола]].
# Установите флажок {{checkbox|Использовать открытое API}} для того, чтобы запустить работу по обслуживанию модуля «Интернет-заказы». При установленном флажке сервер [[Модуль «Интернет-заказы»|модуля «Интернет-заказы»]] запускается и ожидает запросы о новых заказах.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы с модулем «Интернет-заказы», который будет выслан вам в письме от менеджера.
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

=== Ветка «API для телефонии» ===
В данной ветке регулируются настройки API для телефонии, т.е. взаимодействие [[Такси-Мастер]] с call-центром через программный интерфейс. С его помощью [[Call-центр Oktell|call-центр]] может дать команду Такси-Мастер создать [[зака]]з или запросить информацию о [[Справочник «Состояния заказа»|статусе текущего заказа]].
# Установите флажок {{checkbox|Использовать открытое API для телефонии}} для того, чтобы запустить работу по обслуживанию телефонии через API.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы.
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

=== Ветка «Платежные терминалы» ===
{{info|Ранее для связи [[Модуль интеграции с платежными системами|платежных систем]] и [[Такси-Мастер]] служила такая утилита, как TMWeb. В данный момент мы отказались от ее использования, а функции были распределены между двумя компонентами системы: TM API и [[TMServer]].}}

Параметры этой ветки отвечают за работу [[Модуль интеграции с платежными терминалами|модуля интеграции с платежными системами]].
# Установите флажок {{checkbox|Включить прием терминальных платежей}}. Данная функция позволит отображать все платежные операции по приходу средств от водителей через терминалы в [[База данных Такси-Мастер 2|базе данных]] программы.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы с платежными системами и сверки платежей, который будет выслан вам в письме от менеджера. Секретный ключ - это определенный набор символов, необходимый для формирования подписи при передаче информации о платеже.
# В полях {{поле|Логин}} и {{поле|Пароль}} введите данные учетной записи на сайте http://term.bitmaster.ru.
# Кнопка {{кнопка|Задать всем водителям терминальный аккаунт по их ИД}} служит для соединения TM API с сервером Такси-Мастер. В результате соединения записи о терминальных аккаунтах генерируются, заносятся (для тех водителей, у которых они отсутствуют) и обновляются (для тех водителей, у которых уже существуют терминальные аккаунты) в Такси-Мастер.
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

{{info|Обратите внимание, что для платежных систем также существует открытый и свободно распространяемый API, с помощью которого есть возможность связать [[Такси-Мастер]] и [[Модуль интеграции с платежными системами|платежные системы]]. Обратитесь в отдел дополнительных услуг, написав на {{ящик ОДУ}}, за получением кода для данного компонента системы.}}

== Общее описание протокола ==

=== Формат запроса ===

[[TMAPI]] принимает входящие запросы по протоколу HTTPS. В URI запроса после ip адреса и порта, который будет слушать TMWeb, должно идти название API (common_api) и версия
API. Пример:

<pre>
GET https://ip:port/common_api/1.0/get_crew_groups_list HTTP/1.1
</pre>

Для получения данных из БД используются запросы типа GET. Для записи данных в [[База данных Такси-Мастер|базу данных]] используются запросы типа POST. В запросе типа GET параметры запроса передаются в URI. Пример:
<pre>
GET https://ip:port/common_api/1.0/calc_order_cost?tariff_id=1&distance_city=10 HTTP/1.1
Signature: <...>
</pre>

В запросе типа POST параметры передаются в теле запроса в формате application/x-wwwform-urlencoded. Пример:

<pre>
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
</pre>

В любом запросе обязательно должен быть заголовок Signature. В нем передается MD5 хэш, рассчитанный для строки, которая получается сцеплением строки параметров запроса с секретным ключом. Секретный ключ задается в настройках модуля TMWeb в ТМ2. Пример:

<pre>
Запрос:
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
</pre>

=== Формат ответа ===

TMWeb всегда возвращает HTTP код 200 ОК. Результат выполнения запроса содержится в теле ответа в формате JSON. Общий вид возвращаемого результата:

<pre>
{
"code":<Числовой код результата>,
"descr":"<Строковое описание результата>",
"data":{<Дополнительная информация>}
}
</pre>

Существуют общие для всех запросов коды результатов:
{|
! Код
! Описание
|-
|0
|Успешное выполнение запроса
|-
|1
|Неизвестная ошибка
|-
|2
|Неизвестный тип API
|-
|3
|API отключено в настройках TMWeb
|-
|4
|Не совпадает секретный ключ
|-
|5
|Неподдерживаемая версия API
|-
|6
|Неизвестное название запроса
|-
|7
|Неверный тип запроса GET/POST
|-
|8
|Не хватает входного параметра (в доп. информации ответа будет название отсутствующего параметра)
|-
|9
|Некорректный входной параметр (в доп. информации ответа будет название некорректного параметра)
|-
|10
|Внутренняя ошибка обработки запроса
|}

== Описание запросов ==

=== Запрос-пинг ===
Для данного запроса не проверяется версия API, секретный ключ и тип запроса GET/ POST.

Метод: GET или POST

Название запроса: ping

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример:

<pre>
Запрос:
GET https://ip:port/common_api/1.0/ping HTTP/1.1
Ответ:
{
"code":0,
"descr":"OK",
"data":{}
}
</pre>

=== Запрос списка групп экипажей ===
Метод: GET

Название запроса: get_crew_groups_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crew_groups
|Массив
|Список групп экипажей
|-
|• id
|Целое
|ИД группы экипажей
|-
|• name
|Строка
|Название группы экипажей
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_crew_groups_list HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"crew_groups":[
{
"id":1,
"name":"CREW_GROUP1"
},
{
"id":2,
"name":"CREW_GROUP2"
}
]
}
}
</pre>

=== Запрос списка служб ЕДС ===

Метод: GET

Название запроса: get_uds_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр
!Тип
!Описание
|-
|uds
|Массив
|Список служб [[Модуль «Единая диспетчерская служба»|ЕДС]]
|-
|• id
|Целое
|ИД службы [[Модуль «Единая диспетчерская служба»|ЕДС]]
|-
|• name
|Строка
|Название службы [[Модуль «Единая диспетчерская служба»|ЕДС]]
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_uds_list HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"uds":[
{
"id":1,
"name":"UDS1"
},
{
"id":2,
"name":"UDS2"
}
]
}
}
</pre>

=== Запрос списка тарифов ===

Метод: GET

Название запроса: get_tariffs_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр
!Тип
!Описание
|-
|tariffs
|Массив
|Список [[Справочник «Тарифы»|тарифов]]
|-
|• id
|Целое
|ИД [[Справочник «Тарифы»|тарифа]]
|-
|• name
|Строка
|Название [[Справочник «Тарифы»|тарифа]]
|-
|• is_active
|true или false
|Активный [[Справочник «Тарифы»|тариф]]
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_tariffs_list HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"tariffs":[
{
"id":1,
"name":"TARIFF1"
"is_active":true
},
{
"id":2,
"name":"TARIFF2"
"is_active":true
}
]
}
}
</pre>

=== Запрос списка услуг ===
Метод: GET

Название запроса: get_services_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр
!Тип
!Описание
|-
|services
|Массив
|Список [[Справочник «Услуги»|услуг]]
|-
|• id
|Целое
|ИД [[Справочник «Услуги»|услуги]]
|-
|• name
|Строка
|Название [[Справочник «Услуги»|услуги]]
|-
|• sum
|Дробное
|Абсолютная сумма [[Справочник «Услуги»|услуги]], руб
|-
|• percent
|Дробное
|Процент [[Справочник «Услуги»|услуги]] от стоимости заказа, %
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_services_list HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"services":[
{
"id":1,
"name":"SERVICE1",
"sum":100,
"percent":0
},
{
"id":2,
"name":"SERVICE2"
"sum":0,
"percent":10
}
]
}
}
</pre>

=== Запрос списка скидок ===
Метод: GET

Название запроса: get_discounts_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр
!Тип
!Описание
|-
|discounts
|Массив
|Список [[Справочник «Скидки клиентов»|скидок]]
|-
|• id
|Целое
|ИД [[Справочник «Скидки клиентов»|скидки]]
|-
|• name
|Строка
|Название [[Справочник «Скидки клиентов»|скидки]]
|-
|• sum
|Дробное
|Абсолютная сумма [[Справочник «Скидки клиентов»|скидки]], руб
|-
|• percent
|Дробное
|Процент [[Справочник «Скидки клиентов»|скидки]] от стоимости заказа, %
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_discounts_list HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"discounts":[
{
"id":1,
"name":"DISCOUNT1",
"sum":100,
"percent":0
},
{
"id":2,
"name":"DISCOUNT2"
"sum":0,
"percent":10
}
]
}
}
</pre>

=== Создание нового заказа ===
Метод: POST

Название запроса: create_order

Параметры:

{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|phone
|Строка, <= 16 символов
|Номер телефона
|-
|source
|Строка
|Адрес подачи
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
!colspan="3"|Необязательные параметры
|-
|dest
|Строка
|Адрес назначения
|-
|customer
|Строка
|Заказчик
|-
|comment
|Строка
|Комментарий
|-
|crew_group_id
|Целое
|ИД группы экипажей
|-
|uds_id
|Целое
|ИД службы ЕДС
|-
|tariff_id
|Целое
|ИД тарифа
|-
|is_prior
|true или false
|Предварительный заказ
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Заказ с такими параметрами уже создан
|-
|101
|Тариф не найден
|-
|102
|Группа экипажа не найдена
|-
|103
|Служба ЕДС не найдена
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|order_id
|Целое
|ИД созданного заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_order HTTP/1.1
Signature: <...>
Content-Type: application/x-www-form-urlencoded
Content-Length: 127
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

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"order_id":12345
}
}
</pre>

=== Расчет суммы заказа ===

Метод: GET

Название запроса: calc_order_cost
{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|tariff_id
|Целое
|ИД тарифа
|-
Параметры:

!colspan="3"|Необязательные параметры
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|is_prior
|true или false
|Предварительный заказ
|-
|client_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»
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Тариф не найден
|-
|101
|Ошибка при расчете по тарифу
|-
|102
|Скидка не найдена
|-
|103
|Клиент не найден
|-
|104
|Район подачи не найден
|-
|105
|Район назначения не найден
|-
|106
|Дисконтная карта не найдена
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|sum
|Дробное
|Рассчитанная общая сумма заказа
|-
|info
|Массив
|Дополнительная информация по расчету суммы заказа
|-
| • comment
|Строка
|Описание позиции дополнительной информации по расчету суммы заказа
|-
| • sum
|Строка
|Сумма позиции дополнительной информации по расчету суммы заказа
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/calc_order_cost?
tariff_id=1&source_time=20120501100000&is_prior=false&client_id=1&discount_id=1&disc_card_id=1&sour
ce_zone_id=1&dest_zone_id=2&distance_city=10&distance_country=20&source_distance_country=5&is_count
ry=true&waiting_minutes=10&is_hourly=false&hourly_minutes=60&is_prize=true&back_way=false&services=
1;2;3 HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"sum":1000,
"info":[
{
"comment":"SUM1",
"sum":"100"
},
{
"comment":"SUM2",
"sum":"200"
}
]
}
}
</pre>

=== Запрос информации об экипаже ===
Метод: GET

Название запроса: get_crew_info

Параметры:
{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|crew_id
|Целое
|ИД экипажа
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Экипаж не найден
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crew_id
|Целое
|ИД экипажа
|-
|code
|Строка
|Позывной экипажа
|-
|name
|Строка
|Наименование экипажа
|-
|driver_id
|Целое
|ИД водителя
|-
|car_id
|Целое
|ИД автомобиля
|-
|crew_group_id
|Целое
|ИД группы экипажа
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_crew_info?crew_id=1 HTTP/1.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
}
}
</pre>

=== Запрос информации о водителе ===
Метод: GET

Название запроса: get_driver_info

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|driver_id
|Целое
|ИД водителя
|-
!colspan="3"|Необязательные параметры
|-
|need_photo
|true или false
|Нужна ли фотография водителя
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Водитель не найден
|}

Возвращаемые параметры в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|driver_id
|Целое
|ИД водителя
|-
|name
|Строка
|ФИО водителя
|-
|birthday
|ДД.ММ.ГГГГ
|День рождения водителя
|-
|car_id
|Целое
|ИД основного автомобиля водителя
|-
|license
|Строка
|Удостоверение водителя
|-
|home_phone
|Строка
|Домашний телефон водителя
|-
|mobile_phone
|Строка
|Мобильный телефон водителя
|-
|is_locked
|true или false
|Водитель заблокирован
|-
|is_dismissed
|true или false
|Водитель уволен
|-
|driver_photo
|Base64
|Фото водителя (только если need_photo = true)
|}

Пример:

<pre>
Запрос:

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",
"birthday":"01.01.1980",
"car_id":1,
"license":"1234567890",
"home_phone":"123456",
"mobile_phone":"+79123456789",
"is_locked":false,
"is_dismissed":false
}
}
</pre>

=== Запрос информации об автомобиле ===
Метод: GET

Название запроса: get_car_info

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|car_id
|Целое
|ИД автомобиля
|-
!colspan="3"|Необязательные параметры
|-
|need_photo
|true или false
|Нужна ли фотография автомобиля
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Автомобиль не найден
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|car_id
|Целое
|ИД автомобиля
|-
|name
|Строка
|Наименование автомобиля
|-
|code
|Строка
|Позывной автомобиля
|-
|gos_number
|Строка
|Государственный номер автомобиля
|-
|color
|Строка
|Цвет автомобиля
|-
|mark
|Строка
|Марка автомобиля
|-
|short_name
|Строка
|Краткое название автомобиля
|-
|production_year
|Целое
|Год выпуска автомобиля
|-
|car_photo
|Base64
|Фото автомобиля (только если need_photo = true)
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_car_info?car_id=1&need_photo=false HTTP/1.1
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
}
}
</pre>

=== Запрос координат экипажей ===
Метод: GET

Название запроса: get_crews_coords

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Необязательные параметры
|-
|crew_id
|Целое
|ИД экипажа, по которому нужно вернуть координаты. Если не задано, то будут возвращены координаты всех экипажей на линии.
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Координаты не найдены
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crews_coords
|Массив
|Список координат экипажей
|-
|• crew_id
|Целое
|ИД экипажа
|-
|• crew_code
|Строка
|Позывной экипажа
|-
|• coords_time
|ГГГГММДДччммсс
|Время получения координат
|-
|• lat
|Дробное
|Долгота
|-
|• lon
|Дробное
|Широта
|-
|• state_kind
|Строка
|Тип состояния экипажа. Может принимать значения:
• "not_available" — экипаж не на линии

• "waiting" — экипаж свободен, ожидает заказы

• "on_order" — экипаж на заказе

• "on_break" — экипаж на перерыве
|}

Пример:

<pre>

Запрос:
GET https://ip:port/common_api/1.0/get_crews_coords HTTP/1.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"
},
{
"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 HTTP/1.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"
}
]
}
}
</pre>

=== Запрос адресов, содержащих нужную строку ===
Метод: GET

Название запроса: get_addresses_like

Параметры:

{|
!Параметры
!Тип
!Описание
|-
! colspan="3"|Обязательные параметры
|-
|get_streets
|true или false
|Искать улицы
|-
|get_houses
|true или false
|Искать пункты
|-
|get_streets
|true или false
|Искать дома. Не может быть равно true, если get_streets = true или get_points = true.
|-
|street
|Строка
|Часть названия улицы или пункта, если идет поиск улиц или пунктов, или полное название улицы, если идет поиск домов
|-
!colspan="3"|Необязательные параметры
|-
|house
|Строка
|Часть номера дома. Нужно только если get_houses = true.
|-
|max_addresses_count
|Целое
|Максимальное количество адресов в ответе
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Подходящие адреса не найдены
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|addresses
|Массив
|Список подходящих адресов
|-
|• street
|Строка
|Название улицы или пункта
|-
|• house
|Строка
|Номер дома
|-
|• kind
|Строка
|Тип адреса. Может принимать значения:
• "street" — улица

• "house" — дом

• "point" — пункт
|-
|• comment
|Строка
|Комментарий
|}

Пример:

<pre>

Запрос:

GET https://ip:port/common_api/1.0/get_addresses_like?get_streets=true&get_points=true&
get_houses=false&street=STREE HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"addresses":[
{
"street":"STREET1",
"house":"",
"kind":"street",
"comment":""
},
{
"street":"STREET2",
"house":"",
"kind":"street",
"comment":""
},
{
"street":"POINT_STREET1",
"house":"",
"kind":"point",
"comment":"Point at street STREET1"
}
]
}
}

Запрос:

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 HTTP/1.1
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":""
}
]
}
}
</pre>

=== Анализ маршрута ===
Метод: GET

Название запроса: analyze_route

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|source
|Строка
|Адрес подачи
|-
|dest
|Строка
|Адрес назначения
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Адрес подачи не распознан
|-
|101
|Адрес назначения не распознан
|-
|102
|Маршрут не распознан
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|source_lat
|Дробное
|Широта адреса подачи
|-
|source_lon
|Дробное
|Долгота адреса подачи
|-
|source_zone_id
|Целое
|ИД района подачи
|-
|dest_lat
|Дробное
|Широта адреса назначения
|-
|dest_lon
|Дробное
|Долгота адреса назначения
|-
|dest_zone_id
|Целое
|ИД района назначения
|-
|city_dist
|Дробное
|Километраж по городу
|-
|country_dist
|Дробное
|Километраж за городом
|-
|source_country_dist
|Дробное
|Километраж до адреса подачи, если адрес подачи за городом
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/analyze_route?source=STREET1,1&dest=STREET2,2 HTTP/1.1
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
}
}
</pre>

=== Запрос информации о состоянии заказа ===

Метод: GET

Название запроса: get_order_state

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|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
|Целое
|ИД автомобиля
|-
|start_time
|ГГГГММДДччммсс
|Время создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|finish_time
|ГГГГММДДччммсс
|Время завершения заказа
|-
|source
|Строка
|Адрес подачи
|-
|destination
|Строка
|Адрес назначения
|-
|passenger
|Строка
|Пассажир
|-
|phone
|Строка
|Номер телефона
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_order_state?order_id=1 HTTP/1.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
"start_time":"17.01.2013 12:56:41",
"source_time":"17.01.2013 13:26:17",
"finish_time":"17.01.2013 13:03:43",
"source":"1",
"destination":"2",
"passenger":"Слепаков",
"phone":"8800"
}
}
</pre>

=== Создание задачи СМС серверу ===

Метод: POST

Название запроса: send_sms

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|phone
|Строка, <= 16 символов
|Номер телефона
|-
|message
|Строка
|Текст СМС
|}

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример:

<pre>
Запрос:

POST /common_api/1.0/send_sms HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Content-Length: 33

Signature: <...>

message=SMSText&phone=89050057216

Ответ:

{
"code":0,
"descr":"OK",
"data":{}
}
</pre>

=== Проверка авторизации ===

Метод: GET

Название запроса: check_authorization

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|login
|Строка, <= 60 символов
|Логин
|-
|password
|Строка, <= 60 символов
|Пароль
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент с логином LOGIN и/или неверный пароль
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|client_id
|Целое
|ИД клиента
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/check_authorization?login=LOGIN&password=PASSWORD HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"client_id":131
}
}
</pre>

=== Регистрация клиента ===

Метод: POST

Название запроса: register_client

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|name
|Строка, <= 60 символов
|ФИО
|-
|login
|Строка, <= 60 символов
|Логин
|-
|password
|Строка, <= 60 символов
|Пароль
|-
|phones
|Строка
|Номера телефонов (через запятую)
|-
!colspan="3"|Необязательные параметры
|-
|address
|Строка
|Домашний адрес
|-
|birthday
|Строка
|Дата рождения
|-
|gender
|Строка
|Пол. Может принимать значения:
• "male" - мужской

• "female" - женский
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Клиент с номером телефона=PHONE уже существует
|-
|101
|Клиент с логином=LOGIN уже существует
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|client_id
|Целое
|ИД созданного клиента
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_order HTTP/1.1

Signature: <...>

Content-Type: application/x-www-form-urlencoded

Content-Length: 127

name=NAME&phones=88,99&login=LOGIN&password=PASSWORD&birthday=19930218115517&gender=male&address=ADDRESS

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"client_id":140
}
}
</pre>

=== Запрос информации по клиенту ===

Метод: GET

Название запроса: get_client_info

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|get_client_info
|Целое
|ИД клиента
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|client_id
|Целое
|ИД клиента
|-
|number
|Строка
|Номер договора
|-
|address
|Строка
|Домашний адрес
|-
|gender
|Строка
|Пол. Может принимать значения:

• "male" - мужской

• "female" - женский
|-
|birthday
|ДД.ММ.ГГГГ
|Дата рождения
|-
|phones
|Строка
|Номера телефонов (через запятую)
|-
|login
|Строка
|Логин
|-
|password
|Строка
|Пароль
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_client_info?client_id=140 HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"client_id":140,
"name":"Васильев Артём",
"number":"000140",
"address":"Бутово,45",
"gender":"male",
"birthday":"18.02.1993",
"phones":"[\"88\",\"99\"]",
"login":"artem",
"password":"vasilev"
}
}
</pre>

=== Изменение информации по клиенту ===

Метод: POST

Название запроса: register_client

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента
|-
!colspan="3"|Необязательные параметры
|-
|name
|Строка, <= 60 символов
|ФИО
|-
|login
|Строка, <= 60 символов
|Логин
|-
|password
|Строка, <= 60 символов
|Пароль
|-
|phones
|Строка
|Номера телефонов (через запятую)
|-
|address
|Строка
|Домашний адрес
|-
|birthday
|ДД.ММ.ГГГГ
|Дата рождения
|-
|gender
|Строка
|Пол. Может принимать значения:
• "male" - мужской

• "female" - женский
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Клиент с номером телефона=PHONE уже существует
|-
|101
|Клиент с ИД=ID имеет такой же номер телефона=PHONE
|-
|102
|Клиент с логином=LOGIN уже существует
|}

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_order HTTP/1.1
Signature: <...>
Content-Type: application/x-www-form-urlencoded
Content-Length: 127

client_id=140&name=NAME&phones=88,99&login=LOGIN&password=PASSWORD&birthday=19930218115517&gender=male&address=ADDRESS

Ответ:

{
"code":0,
"descr":"OK",
"data":{}
}
</pre>

=== Запрос текущих заказов ===

Метод: GET

Название запроса: get_current_orders

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента (может отсутствовать, если phone заполнен)
|-
|phone
|Строка, <= 16 символов
|Телефон клиента (может отсутствовать, если client_id заполнен)
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|id
|Целое
|ИД заказа
|-
|state_id
|Целое
|ИД состояния заказа
|-
|start_time
|ГГГГММДДччммсс
|Дата создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|birthday
|ДД.ММ.ГГГГ
|Дата рождения
|-
|source
|Строка
|Адрес подачи
|-
|destination
|Строка
|Адрес назначения
|-
|passenger
|Строка
|Пассажир
|-
|crew_id
|Целое
|ИД экипажа
|-
|prior_crew_id
|Целое
|ИД предварительного экипажа
|-
|driver_id
|Целое
|ИД водителя
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_current_orders?client_id=140&phone=18 HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"orders":[
{
"id":20648,
"state_id":44,
"start_time":"20130204181111",
"source_time":"20130204181111",
"source":"1-й пр-т \/Москва\/,",
"destination":"12-й мкр,",
"passenger":"маша",
"crew_id":0,
"prior_crew_id":0,
"driver_id":0
},
{
"id":20670,
"state_id":44,
"start_time":"20130207153022",
"source_time":"20130207153022",
"source":"11-й мкр,",
"destination":"1-й пр-т \/Москва\/,",
"passenger":"саша",
"crew_id":0,
"prior_crew_id":0,
"driver_id":0
}
]
}
}
</pre>

=== Запрос выполненных заказов ===

Метод: GET

Название запроса: get_finished_orders

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента (может отсутствовать, если phone заполнен)
|-
|phone
|Строка, <= 16 символов
|Телефон клиента (может отсутствовать, если client_id заполнен)
|-
|start_time
|ГГГГММДДччммсс
|Начало периода
|-
|finish_time
|ГГГГММДДччммсс
|Конец периода
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|id
|Целое
|ИД заказа
|-
|state_id
|Целое
|ИД состояния заказа
|-
|start_time
|ГГГГММДДччммсс
|Дата создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|finish_time
|ГГГГММДДччммсс
|Время завершения заказа
|-
|birthday
|ДД.ММ.ГГГГ
|Дата рождения
|-
|source
|Строка
|Адрес подачи
|-
|destination
|Строка
|Адрес назначения
|-
|sum
|Дробное
|Стоимость заказа без учета скидок(наценок)
|-
|passenger
|Строка
|Пассажир
|-
|crew_id
|Целое
|ИД экипажа
|-
|prior_crew_id
|Целое
|ИД предварительного экипажа
|-
|driver_id
|Целое
|ИД водителя
|-
|car_id
|Целое
|ИД автомобиля
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_finished_orders?client_id=140&phone= HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"orders":[
{
"id":20651,
"state_id":34,
"source_time":"20130205110812",
"start_time":"20130205110812",
"finish_time":"20130205115618",
"source":"прпроп",
"destination":"рррррр",
"passenger":"вера",
"sum":"908",
"crew_id":"6",
"prior_crew_id":0,
"driver_id":"4",
"car_id":"6"
},
{
"id":20669,
"state_id":34,
"source_time":"20130205130500",
"start_time":"20130205130500",
"finish_time":"20130205134511",
"source":"1",
"destination":"2",
"passenger":"маша",
"sum":"454",
"crew_id":"6",
"prior_crew_id":0,
"driver_id":"4",
"car_id":"6"
}
]
}
}
</pre>

=== Проведение операции по клиенту ===

Метод: POST

Название запроса: create_client_operation

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента
|-
|oper_time
|ГГГГММДДччммсс
|Время создания операции
|-
|sum
|Дробное
|Сумма
|-
|oper_type
|Целое
|Тип операции:
• "receipt" - приход

• "expense" - расход
|-
|pay_type
|Целое
|Тип оплаты:
• "cash" - наличный

• "nocash" - безналичный
|-
!colspan="3"|Необязательные параметры
|-
|comment
|Строка
|Комментарий
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|oper_id
|Целое
|ИД операции
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_client_operation HTTP/1.1

Signature: <...>

Content-Type: application/x-www-form-urlencoded

Content-Length: 127

client_id=112&oper_time=20130221100719&oper_sum=300&oper_type=receipt&pay_type=cash&comment=COMMENT

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"oper_id":31

}
}
</pre>

=== Запрос операций по клиенту ===

Метод: GET

Название запроса: get_client_operations

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента (может отсутствовать, если phone заполнен)
|-
|phone
|Строка, <= 16 символов
|Телефон клиента (может отсутствовать, если client_id заполнен)
|-
|start_time
|ГГГГММДДччммсс
|Начало периода
|-
|finish_time
|ГГГГММДДччммсс
|Конец периода
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|oper_id
|Целое
|ИД операции
|-
|oper_time
|ГГГГММДДччммсс
|Время создания операции
|-
|sum
|Дробное
|Сумма
|-
|order_id
|Целое
|Заказ, связанный с операцией
|-
|oper_type
|Целое
|Тип операции:
• "receipt" - приход
• "expense" - расход
|-
|pay_type
|Целое
|Тип оплаты:
• "cash" - наличный
• "nocash" - безналичный
|}

Пример:

<pre>
Запрос:

GET

https://ip:port/common_api/1.0/get_client_operations?client_id=112&start_time=20130201092112&finish_time=20130221092112 HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"operations":[
{
"oper_id":112,
"oper_time":"20130219091328",
"sum":"21,8",
"order_id":11800,
"oper_type":"receipt",
"pay_type":"cash",
"comment":"jgznm"
},
{
"oper_id":112,
"oper_time":"20130220112245",
"sum":"4500",
"order_id":11801,
"oper_type":"receipt",
"pay_type":"cash",
"comment":"блин"
}
]
}
}
</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 HTTP/1.1
</pre>

Для получения данных из БД используются запросы типа GET. Для записи данных в БД используются запросы типа POST. В запросе типа GET параметры запроса передаются в URI.

Пример:

<pre>
GET https://ip:port/tm_tapi/1.0/get_info_by_phone?phone=89058800565&fields=PHONE_TYPEPHONE_
TO_DIAL&signature=661ce071eeefcb4f7fc8bc1f17bd520b HTTP/1.1
</pre>

В запросе типа POST параметры передаются в теле запроса в формате application/x-wwwform-
urlencoded.

Пример:

<pre>
POST https://ip:port/tm_tapi/1.0/change_order_state HTTP/1.1
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 HTTP/1.1

Секретный ключ:
321

Signature = MD5("phone=89058800565&fields=PHONE_TYPE" + "321") = ef17ea682d09e452af544a5758dba396
HTTP/1.1
</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 - если звонит номер из справочника телефоны; 0 - неизвестный номер)
|-
|PHONE_TO_DIAL
|Строка, <= 16 символов
|Номер телефона для отзвона по заказу
|-
|CREW_ID
|Целое
|ИД экипажа
|-
|IS_PRIOR
|true или false
|Признак предварительного заказа
|-
|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
|Целое
|ИД группы экипажа
|-
|CLIENT_BALANCE
|Дробное
|Баланс клиента
|-
|DRIVER_TIMECOUNT
|Целое
|Время пути водителя до адреса подачи в минутах
|-
|SOURCE_TIMECOUNT
|Целое
|Время оставшееся до подачи в минутах
|-
|SOUND_COLOR
|Строка
|Запись с информацией о цвете
|-
|SOUND_GOSNUMBER
|Строка
|Запись с информацией о государственном номере автомобиля
|-
|SOUND_MARK
|Строка
|Запись с информацией о марке автомобиля
|-
|GOSNUMBER
|Строка
|Государственный номер автомобиля
|-
|CAR_COLOR
|Строка
|Цвет автомобиля
|-
|CAR_MARK
|Строка
|Марка автомобиля
|}

Пример:

<pre>
Запрос:
GET https://ip:port/tm_tapi/1.0/get_info_by_phone?phone=89058800565l&fields=PHONE_TYPEPHONE_
TO_DIAL-CREW_ID-ORDER_ID&signature=d35ab2765f2968d48c096d5f5327db26 HTTP/1.1

Ответ:

<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>
</data>
</response>
</pre>

==== Запрос информации по ИД заказа ====

Метод: GET
Название запроса: get_info_by_order_id
Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|-
|fields
|Строка
|Список полей, которые необходимо вернуть. Поля перечисляются через ''-''
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

Специальные возвращаемые коды: нет
Возвращаемые данные в случае успешного выполнения запроса: зависит от того какие поля были переданы в поле fields.

{|
!Параметр
!Тип
!Описание
|-
|DRIVER_SOURCETIME
|Строка, <= 16 символов
|Время до подачи в минутах, указанное водителем
|-
|SOUND_COLOR
|Строка
|Запись с информацией о цвете
|-
|MARK
|Строка
|Марка автомобиля
|-
|COLOR
|Строка
|Цвет автомобиля
|-
|GOSNUMBER
|Строка
|Государственный номер автомобиля
|-
|SOUND_MARK
|Строка
|Запись с информацией о марке автомобиля
|-
|CREWGROUPID
|Целое
|ИД группы экипажа
|-
|IS_PRIOR
|true или false
|Признак предварительного заказа
|-
|DISCOUNTEDSUMM
|Строка
|Сумма заказа с учетом всех скидок
|-
|MOBILE_PHONE
|Строка, <= 16 символов
|Номер телефона водителя
|-
|CATEGORYID
|Целое
|ИД категории телефона
|-
|SOURCE_TIME
|Целое
|Время до подачи в минутах
|}

Пример:

<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
HTTP/1.1

Ответ:

<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></SOURCE_TIME>
</data>
</response>
</pre>

==== Смена состояния заказа ====
Метод: POST

Название запроса: change_order_state

Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|-
|need_state
|Целое
|Новое состояние заказа
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

Специальные возвращаемые коды:

{|
!Код
!Описание
|-
|100
|Заказ с таким ИД не найден.
|-
|101
|Изменение состояния не соответствует необходимым условиям.
|}

Возвращаемые данные в случае успешного выполнения запроса

{|
!Параметр
!Тип
!Описание
|-
|ORDER_ID
|Целое
|ИД созданного заказа
|-
|NEW_STATE
|Целое
|Новое состояние заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/tm_tapi/1.0/change_order_state HTTP/1.1
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"|Обязательные параметры
|-
|RECORD_DATE
|ГГГГММДДччммсс
|Дата записи
|-
|RECORD_LENGTH
|Целое
|Продолжительность записи (в секундах)
|-
|PHONE
|Строка, <= 16 символов
|Номер телефона
|-
|ORDERID
|Целое
|Заказ, с которого сделана запись
|-
|USERID
|Целое
|Пользователь, сделавший запись
|-
|FILE_PATH
|Строка,<=255 символов
|Путь к файлу записи
|-
|RECORD_GUID
|Строка,<= 80 символов
|GUID звонка
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

Специальные возвращаемые коды: нет
Возвращаемые данные в случае успешного выполнения запроса

{|
!Параметр
!Тип
!Описание
|-
|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: 206
RECORD_DATE=20121108145953&RECORD_LENGTH=6546&PHONE=654321&ORDERID=654&USERID=564&FILE_PATH=d%3A
%5CProjects%5Ctrunk%5C%5Ftrunk%5CTM%5CBin
%5C&RECORD_GUID=GUID456258&signature=cd11d50d65fa7e8ad73f80cdc7d296c7

Ответ:

<response>
<code>0</code>
<descr>OK</descr>
<data>
<RECORD_ID>25</RECORD_ID>
</data>
</response>
</pre>

==== Создать новый заказ ====

Метод: POST

Название запроса: make_new_order

Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|PHONE
|Строка, <= 16 символов
|Номер телефона
|-
|ORDER_STATE_ID
|Целое
|ИД состояния заказа
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|-
|colspan="3"|Необязательные параметры
|-
|CREW_GROUP_ID
|Целое
|ИД группы экипажа
|-
|TARIFF_ID
|Целое
|ИД тарифа
|-
|PHONE_PREFIX
|Строка
|Префикс, отрезаемый от номера телефона при поиске в базе данных. Для входящих звонков это код города с префиксом входящих номеров, обычно "8". Например, "83412"
|-
|DISCOUNTED_SU MM
|Строка
|Фиксированная сумма за заказ
|}

Специальные возвращаемые коды:

{|
!Код
!Описание
|-
|100
|Клиент не найден
|}

Возвращаемые данные в случае успешного выполнения запроса

{|
!Параметр
!Тип
!Описание
|-
|ORDER_ID
|Целое
|ИД созданного заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/tm_tapi/1.0/make_new_order HTTP/1.1
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>
</pre>

== Пример формы для заказа такси ==
{{url|{{корень FTP|forms/zakaz_taxi.zip}}}}

Данная форма является примером, на основе которого можно построить собственную форму для принятия интернет-заказов. Форму можно использовать либо в исходном варианте, либо применяя запросы [[TM API#Описание запросов|TM API]].
Для того, чтобы данная форма функционировала, необходимо открыть файл в любом текстовом редакторе и указать корректные IP-адрес [[Сервер Такси-Мастер|сервера Такси-Мастер]], порт [[TM API#Параметры TM API|TM API]] и секретный ключ. Далее вам следует загрузить файл на хостинг.

Именно так будет выглядеть данная форма для заказа такси.
{{картинка|Форма для заказа такси.jpg}}

[[Категория:ТМ2]]

TM API

2013-10-01T14:36:04Z

AnnaNikolskih: /* Запрос информации о состоянии заказа */

'''TM API''' - специальный набор инструментов [[Такси-Мастер]], который позволит объединить систему с вашим сайтом и различными полезными сервисами. Он предоставляется вам на свободных условиях.

Благодаря этому набору вы сможете:

# Создать механизм приема заказов через интернет.
# Сделать ваш сайт более информативным: публиковать полезную для клиентов информацию прямо из системы - список ближайших [[Справочник «Экипажи»|экипажей]], предварительный расчет стоимости поездки, мониторинг движения автомобиля такси в процессе выполнения [[заказ]]а, [[Модуль «Интеграция с картами»|карты города]] и контактную информацию.
# Расширить возможности своей службы за счет популярного онлайн-сервиса Яндекс Такси.

== Параметры TM API ==
Задать настройки для корректной работы TM API вы сможете в программе [[Такси-Мастер]] в меню {{tab|Настройки}} в одноименной ветке {{tab|TM API}}.
Параметры организуют и контролируют работу [[Модуль «Интернет-заказы»|модуля «Интернет-заказы»]].
# Установите флажок {{checkbox|Использовать TM API}}, чтобы приступить к его использованию.
# В поле {{поле|Локальный порт}} введите номер порта подключения к интернету, на котором работает и будет ожидать запросы о новых заказах [[TMServer]]. Рекомендуется оставить номер порта по умолчанию.
# Установите флажок {{checkbox|Можно использовать данное рабочее место TMServer для распознавания адресов}} для того, чтобы конкретно с данного рабочего места происходило распознавание адресов модулем "Интернет-заказы".
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

=== Ветка «Открытое API» ===
В данной ветке регулируется доступ к синхронизации Такси-Мастер со сторонним сервисом (сайтом), с помощью которого клиенты будут создавать интернет-заказы. С примером кода для работы вы можете ознакомиться в данной статье в разделе [[TM API#Общее описание протокола|Общее описание протокола]].
# Установите флажок {{checkbox|Использовать открытое API}} для того, чтобы запустить работу по обслуживанию модуля «Интернет-заказы». При установленном флажке сервер [[Модуль «Интернет-заказы»|модуля «Интернет-заказы»]] запускается и ожидает запросы о новых заказах.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы с модулем «Интернет-заказы», который будет выслан вам в письме от менеджера.
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

=== Ветка «API для телефонии» ===
В данной ветке регулируются настройки API для телефонии, т.е. взаимодействие [[Такси-Мастер]] с call-центром через программный интерфейс. С его помощью [[Call-центр Oktell|call-центр]] может дать команду Такси-Мастер создать [[зака]]з или запросить информацию о [[Справочник «Состояния заказа»|статусе текущего заказа]].
# Установите флажок {{checkbox|Использовать открытое API для телефонии}} для того, чтобы запустить работу по обслуживанию телефонии через API.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы.
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

=== Ветка «Платежные терминалы» ===
{{info|Ранее для связи [[Модуль интеграции с платежными системами|платежных систем]] и [[Такси-Мастер]] служила такая утилита, как TMWeb. В данный момент мы отказались от ее использования, а функции были распределены между двумя компонентами системы: TM API и [[TMServer]].}}

Параметры этой ветки отвечают за работу [[Модуль интеграции с платежными терминалами|модуля интеграции с платежными системами]].
# Установите флажок {{checkbox|Включить прием терминальных платежей}}. Данная функция позволит отображать все платежные операции по приходу средств от водителей через терминалы в [[База данных Такси-Мастер 2|базе данных]] программы.
# В поле {{поле|Секретный ключ}} укажите номер секретного ключа для работы с платежными системами и сверки платежей, который будет выслан вам в письме от менеджера. Секретный ключ - это определенный набор символов, необходимый для формирования подписи при передаче информации о платеже.
# В полях {{поле|Логин}} и {{поле|Пароль}} введите данные учетной записи на сайте http://term.bitmaster.ru.
# Кнопка {{кнопка|Задать всем водителям терминальный аккаунт по их ИД}} служит для соединения TM API с сервером Такси-Мастер. В результате соединения записи о терминальных аккаунтах генерируются, заносятся (для тех водителей, у которых они отсутствуют) и обновляются (для тех водителей, у которых уже существуют терминальные аккаунты) в Такси-Мастер.
# Перезапустите [[Такси-Мастер]] и [[TMServer]] для запуска работы модуля.

{{info|Обратите внимание, что для платежных систем также существует открытый и свободно распространяемый API, с помощью которого есть возможность связать [[Такси-Мастер]] и [[Модуль интеграции с платежными системами|платежные системы]]. Обратитесь в отдел дополнительных услуг, написав на {{ящик ОДУ}}, за получением кода для данного компонента системы.}}

== Общее описание протокола ==

=== Формат запроса ===

[[TMAPI]] принимает входящие запросы по протоколу HTTPS. В URI запроса после ip адреса и порта, который будет слушать TMWeb, должно идти название API (common_api) и версия
API. Пример:

<pre>
GET https://ip:port/common_api/1.0/get_crew_groups_list HTTP/1.1
</pre>

Для получения данных из БД используются запросы типа GET. Для записи данных в [[База данных Такси-Мастер|базу данных]] используются запросы типа POST. В запросе типа GET параметры запроса передаются в URI. Пример:
<pre>
GET https://ip:port/common_api/1.0/calc_order_cost?tariff_id=1&distance_city=10 HTTP/1.1
Signature: <...>
</pre>

В запросе типа POST параметры передаются в теле запроса в формате application/x-wwwform-urlencoded. Пример:

<pre>
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
</pre>

В любом запросе обязательно должен быть заголовок Signature. В нем передается MD5 хэш, рассчитанный для строки, которая получается сцеплением строки параметров запроса с секретным ключом. Секретный ключ задается в настройках модуля TMWeb в ТМ2. Пример:

<pre>
Запрос:
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
</pre>

=== Формат ответа ===

TMWeb всегда возвращает HTTP код 200 ОК. Результат выполнения запроса содержится в теле ответа в формате JSON. Общий вид возвращаемого результата:

<pre>
{
"code":<Числовой код результата>,
"descr":"<Строковое описание результата>",
"data":{<Дополнительная информация>}
}
</pre>

Существуют общие для всех запросов коды результатов:
{|
! Код
! Описание
|-
|0
|Успешное выполнение запроса
|-
|1
|Неизвестная ошибка
|-
|2
|Неизвестный тип API
|-
|3
|API отключено в настройках TMWeb
|-
|4
|Не совпадает секретный ключ
|-
|5
|Неподдерживаемая версия API
|-
|6
|Неизвестное название запроса
|-
|7
|Неверный тип запроса GET/POST
|-
|8
|Не хватает входного параметра (в доп. информации ответа будет название отсутствующего параметра)
|-
|9
|Некорректный входной параметр (в доп. информации ответа будет название некорректного параметра)
|-
|10
|Внутренняя ошибка обработки запроса
|}

== Описание запросов ==

=== Запрос-пинг ===
Для данного запроса не проверяется версия API, секретный ключ и тип запроса GET/ POST.

Метод: GET или POST

Название запроса: ping

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример:

<pre>
Запрос:
GET https://ip:port/common_api/1.0/ping HTTP/1.1
Ответ:
{
"code":0,
"descr":"OK",
"data":{}
}
</pre>

=== Запрос списка групп экипажей ===
Метод: GET

Название запроса: get_crew_groups_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crew_groups
|Массив
|Список групп экипажей
|-
|• id
|Целое
|ИД группы экипажей
|-
|• name
|Строка
|Название группы экипажей
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_crew_groups_list HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"crew_groups":[
{
"id":1,
"name":"CREW_GROUP1"
},
{
"id":2,
"name":"CREW_GROUP2"
}
]
}
}
</pre>

=== Запрос списка служб ЕДС ===

Метод: GET

Название запроса: get_uds_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр
!Тип
!Описание
|-
|uds
|Массив
|Список служб [[Модуль «Единая диспетчерская служба»|ЕДС]]
|-
|• id
|Целое
|ИД службы [[Модуль «Единая диспетчерская служба»|ЕДС]]
|-
|• name
|Строка
|Название службы [[Модуль «Единая диспетчерская служба»|ЕДС]]
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_uds_list HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"uds":[
{
"id":1,
"name":"UDS1"
},
{
"id":2,
"name":"UDS2"
}
]
}
}
</pre>

=== Запрос списка тарифов ===

Метод: GET

Название запроса: get_tariffs_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр
!Тип
!Описание
|-
|tariffs
|Массив
|Список [[Справочник «Тарифы»|тарифов]]
|-
|• id
|Целое
|ИД [[Справочник «Тарифы»|тарифа]]
|-
|• name
|Строка
|Название [[Справочник «Тарифы»|тарифа]]
|-
|• is_active
|true или false
|Активный [[Справочник «Тарифы»|тариф]]
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_tariffs_list HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"tariffs":[
{
"id":1,
"name":"TARIFF1"
"is_active":true
},
{
"id":2,
"name":"TARIFF2"
"is_active":true
}
]
}
}
</pre>

=== Запрос списка услуг ===
Метод: GET

Название запроса: get_services_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр
!Тип
!Описание
|-
|services
|Массив
|Список [[Справочник «Услуги»|услуг]]
|-
|• id
|Целое
|ИД [[Справочник «Услуги»|услуги]]
|-
|• name
|Строка
|Название [[Справочник «Услуги»|услуги]]
|-
|• sum
|Дробное
|Абсолютная сумма [[Справочник «Услуги»|услуги]], руб
|-
|• percent
|Дробное
|Процент [[Справочник «Услуги»|услуги]] от стоимости заказа, %
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_services_list HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"services":[
{
"id":1,
"name":"SERVICE1",
"sum":100,
"percent":0
},
{
"id":2,
"name":"SERVICE2"
"sum":0,
"percent":10
}
]
}
}
</pre>

=== Запрос списка скидок ===
Метод: GET

Название запроса: get_discounts_list

Параметры: нет

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса:

{|
!Параметр
!Тип
!Описание
|-
|discounts
|Массив
|Список [[Справочник «Скидки клиентов»|скидок]]
|-
|• id
|Целое
|ИД [[Справочник «Скидки клиентов»|скидки]]
|-
|• name
|Строка
|Название [[Справочник «Скидки клиентов»|скидки]]
|-
|• sum
|Дробное
|Абсолютная сумма [[Справочник «Скидки клиентов»|скидки]], руб
|-
|• percent
|Дробное
|Процент [[Справочник «Скидки клиентов»|скидки]] от стоимости заказа, %
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_discounts_list HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"discounts":[
{
"id":1,
"name":"DISCOUNT1",
"sum":100,
"percent":0
},
{
"id":2,
"name":"DISCOUNT2"
"sum":0,
"percent":10
}
]
}
}
</pre>

=== Создание нового заказа ===
Метод: POST

Название запроса: create_order

Параметры:

{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|phone
|Строка, <= 16 символов
|Номер телефона
|-
|source
|Строка
|Адрес подачи
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
!colspan="3"|Необязательные параметры
|-
|dest
|Строка
|Адрес назначения
|-
|customer
|Строка
|Заказчик
|-
|comment
|Строка
|Комментарий
|-
|crew_group_id
|Целое
|ИД группы экипажей
|-
|uds_id
|Целое
|ИД службы ЕДС
|-
|tariff_id
|Целое
|ИД тарифа
|-
|is_prior
|true или false
|Предварительный заказ
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Заказ с такими параметрами уже создан
|-
|101
|Тариф не найден
|-
|102
|Группа экипажа не найдена
|-
|103
|Служба ЕДС не найдена
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|order_id
|Целое
|ИД созданного заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_order HTTP/1.1
Signature: <...>
Content-Type: application/x-www-form-urlencoded
Content-Length: 127
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

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"order_id":12345
}
}
</pre>

=== Расчет суммы заказа ===

Метод: GET

Название запроса: calc_order_cost
{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|tariff_id
|Целое
|ИД тарифа
|-
Параметры:

!colspan="3"|Необязательные параметры
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|is_prior
|true или false
|Предварительный заказ
|-
|client_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»
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Тариф не найден
|-
|101
|Ошибка при расчете по тарифу
|-
|102
|Скидка не найдена
|-
|103
|Клиент не найден
|-
|104
|Район подачи не найден
|-
|105
|Район назначения не найден
|-
|106
|Дисконтная карта не найдена
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|sum
|Дробное
|Рассчитанная общая сумма заказа
|-
|info
|Массив
|Дополнительная информация по расчету суммы заказа
|-
| • comment
|Строка
|Описание позиции дополнительной информации по расчету суммы заказа
|-
| • sum
|Строка
|Сумма позиции дополнительной информации по расчету суммы заказа
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/calc_order_cost?
tariff_id=1&source_time=20120501100000&is_prior=false&client_id=1&discount_id=1&disc_card_id=1&sour
ce_zone_id=1&dest_zone_id=2&distance_city=10&distance_country=20&source_distance_country=5&is_count
ry=true&waiting_minutes=10&is_hourly=false&hourly_minutes=60&is_prize=true&back_way=false&services=
1;2;3 HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"sum":1000,
"info":[
{
"comment":"SUM1",
"sum":"100"
},
{
"comment":"SUM2",
"sum":"200"
}
]
}
}
</pre>

=== Запрос информации об экипаже ===
Метод: GET

Название запроса: get_crew_info

Параметры:
{|
!Параметр
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|crew_id
|Целое
|ИД экипажа
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Экипаж не найден
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crew_id
|Целое
|ИД экипажа
|-
|code
|Строка
|Позывной экипажа
|-
|name
|Строка
|Наименование экипажа
|-
|driver_id
|Целое
|ИД водителя
|-
|car_id
|Целое
|ИД автомобиля
|-
|crew_group_id
|Целое
|ИД группы экипажа
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_crew_info?crew_id=1 HTTP/1.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
}
}
</pre>

=== Запрос информации о водителе ===
Метод: GET

Название запроса: get_driver_info

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|driver_id
|Целое
|ИД водителя
|-
!colspan="3"|Необязательные параметры
|-
|need_photo
|true или false
|Нужна ли фотография водителя
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Водитель не найден
|}

Возвращаемые параметры в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|driver_id
|Целое
|ИД водителя
|-
|name
|Строка
|ФИО водителя
|-
|birthday
|ДД.ММ.ГГГГ
|День рождения водителя
|-
|car_id
|Целое
|ИД основного автомобиля водителя
|-
|license
|Строка
|Удостоверение водителя
|-
|home_phone
|Строка
|Домашний телефон водителя
|-
|mobile_phone
|Строка
|Мобильный телефон водителя
|-
|is_locked
|true или false
|Водитель заблокирован
|-
|is_dismissed
|true или false
|Водитель уволен
|-
|driver_photo
|Base64
|Фото водителя (только если need_photo = true)
|}

Пример:

<pre>
Запрос:

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",
"birthday":"01.01.1980",
"car_id":1,
"license":"1234567890",
"home_phone":"123456",
"mobile_phone":"+79123456789",
"is_locked":false,
"is_dismissed":false
}
}
</pre>

=== Запрос информации об автомобиле ===
Метод: GET

Название запроса: get_car_info

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|car_id
|Целое
|ИД автомобиля
|-
!colspan="3"|Необязательные параметры
|-
|need_photo
|true или false
|Нужна ли фотография автомобиля
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Автомобиль не найден
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|car_id
|Целое
|ИД автомобиля
|-
|name
|Строка
|Наименование автомобиля
|-
|code
|Строка
|Позывной автомобиля
|-
|gos_number
|Строка
|Государственный номер автомобиля
|-
|color
|Строка
|Цвет автомобиля
|-
|mark
|Строка
|Марка автомобиля
|-
|short_name
|Строка
|Краткое название автомобиля
|-
|production_year
|Целое
|Год выпуска автомобиля
|-
|car_photo
|Base64
|Фото автомобиля (только если need_photo = true)
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_car_info?car_id=1&need_photo=false HTTP/1.1
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
}
}
</pre>

=== Запрос координат экипажей ===
Метод: GET

Название запроса: get_crews_coords

Параметры:
{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Необязательные параметры
|-
|crew_id
|Целое
|ИД экипажа, по которому нужно вернуть координаты. Если не задано, то будут возвращены координаты всех экипажей на линии.
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Координаты не найдены
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|crews_coords
|Массив
|Список координат экипажей
|-
|• crew_id
|Целое
|ИД экипажа
|-
|• crew_code
|Строка
|Позывной экипажа
|-
|• coords_time
|ГГГГММДДччммсс
|Время получения координат
|-
|• lat
|Дробное
|Долгота
|-
|• lon
|Дробное
|Широта
|-
|• state_kind
|Строка
|Тип состояния экипажа. Может принимать значения:
• "not_available" — экипаж не на линии

• "waiting" — экипаж свободен, ожидает заказы

• "on_order" — экипаж на заказе

• "on_break" — экипаж на перерыве
|}

Пример:

<pre>

Запрос:
GET https://ip:port/common_api/1.0/get_crews_coords HTTP/1.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"
},
{
"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 HTTP/1.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"
}
]
}
}
</pre>

=== Запрос адресов, содержащих нужную строку ===
Метод: GET

Название запроса: get_addresses_like

Параметры:

{|
!Параметры
!Тип
!Описание
|-
! colspan="3"|Обязательные параметры
|-
|get_streets
|true или false
|Искать улицы
|-
|get_houses
|true или false
|Искать пункты
|-
|get_streets
|true или false
|Искать дома. Не может быть равно true, если get_streets = true или get_points = true.
|-
|street
|Строка
|Часть названия улицы или пункта, если идет поиск улиц или пунктов, или полное название улицы, если идет поиск домов
|-
!colspan="3"|Необязательные параметры
|-
|house
|Строка
|Часть номера дома. Нужно только если get_houses = true.
|-
|max_addresses_count
|Целое
|Максимальное количество адресов в ответе
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Подходящие адреса не найдены
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|addresses
|Массив
|Список подходящих адресов
|-
|• street
|Строка
|Название улицы или пункта
|-
|• house
|Строка
|Номер дома
|-
|• kind
|Строка
|Тип адреса. Может принимать значения:
• "street" — улица

• "house" — дом

• "point" — пункт
|-
|• comment
|Строка
|Комментарий
|}

Пример:

<pre>

Запрос:

GET https://ip:port/common_api/1.0/get_addresses_like?get_streets=true&get_points=true&
get_houses=false&street=STREE HTTP/1.1
Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"addresses":[
{
"street":"STREET1",
"house":"",
"kind":"street",
"comment":""
},
{
"street":"STREET2",
"house":"",
"kind":"street",
"comment":""
},
{
"street":"POINT_STREET1",
"house":"",
"kind":"point",
"comment":"Point at street STREET1"
}
]
}
}

Запрос:

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 HTTP/1.1
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":""
}
]
}
}
</pre>

=== Анализ маршрута ===
Метод: GET

Название запроса: analyze_route

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|source
|Строка
|Адрес подачи
|-
|dest
|Строка
|Адрес назначения
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Адрес подачи не распознан
|-
|101
|Адрес назначения не распознан
|-
|102
|Маршрут не распознан
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|source_lat
|Дробное
|Широта адреса подачи
|-
|source_lon
|Дробное
|Долгота адреса подачи
|-
|source_zone_id
|Целое
|ИД района подачи
|-
|dest_lat
|Дробное
|Широта адреса назначения
|-
|dest_lon
|Дробное
|Долгота адреса назначения
|-
|dest_zone_id
|Целое
|ИД района назначения
|-
|city_dist
|Дробное
|Километраж по городу
|-
|country_dist
|Дробное
|Километраж за городом
|-
|source_country_dist
|Дробное
|Километраж до адреса подачи, если адрес подачи за городом
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/analyze_route?source=STREET1,1&dest=STREET2,2 HTTP/1.1
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
}
}
</pre>

=== Запрос информации о состоянии заказа ===

Метод: GET

Название запроса: get_order_state

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|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
|Целое
|ИД автомобиля
|-
|start_time
|ГГГГММДДччммсс
|Время создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|finish_time
|ГГГГММДДччммсс
|Время завершения заказа
|-
|source
|Строка
|Адрес подачи
|-
|destination
|Строка
|Адрес назначения
|-
|passenger
|Строка
|Пассажир
|-
|phone
|Строка
|Номер телефона
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_order_state?order_id=1 HTTP/1.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
"start_time":"17.01.2013 12:56:41",
"source_time":"17.01.2013 13:26:17",
"finish_time":"17.01.2013 13:03:43",
"source":"1",
"destination":"2",
"passenger":"Слепаков",
"phone":"8800"
}
}
</pre>

=== Создание задачи СМС серверу ===

Метод: POST

Название запроса: send_sms

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|phone
|Строка, <= 16 символов
|Номер телефона
|-
|message
|Строка
|Текст СМС
|}

Специальные возвращаемые коды: нет

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример:

<pre>
Запрос:

POST /common_api/1.0/send_sms HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Content-Length: 33

Signature: <...>

message=SMSText&phone=89050057216

Ответ:

{
"code":0,
"descr":"OK",
"data":{}
}
</pre>

=== Проверка авторизации ===

Метод: GET

Название запроса: check_authorization

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|login
|Строка, <= 60 символов
|Логин
|-
|password
|Строка, <= 60 символов
|Пароль
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент с логином LOGIN и/или неверный пароль
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|client_id
|Целое
|ИД клиента
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/check_authorization?login=LOGIN&password=PASSWORD HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"client_id":131
}
}
</pre>

=== Регистрация клиента ===

Метод: POST

Название запроса: register_client

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|name
|Строка, <= 60 символов
|ФИО
|-
|login
|Строка, <= 60 символов
|Логин
|-
|password
|Строка, <= 60 символов
|Пароль
|-
|phones
|Строка
|Номера телефонов (через запятую)
|-
!colspan="3"|Необязательные параметры
|-
|address
|Строка
|Домашний адрес
|-
|birthday
|ДД.ММ.ГГГГ
|Дата рождения
|-
|gender
|Строка
|Пол. Может принимать значения:
• "male" - мужской

• "female" - женский
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Клиент с ИД=ID имеет такой же номер телефона=PHONE
|-
|101
|Клиент с логином=LOGIN уже существует
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|client_id
|Целое
|ИД созданного клиента
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_order HTTP/1.1

Signature: <...>

Content-Type: application/x-www-form-urlencoded

Content-Length: 127

name=NAME&phones=88,99&login=LOGIN&password=PASSWORD&birthday=19930218115517&gender=male&address=ADDRESS

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"client_id":140
}
}
</pre>

=== Запрос информации по клиенту ===

Метод: GET

Название запроса: get_client_info

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|get_client_info
|Целое
|ИД клиента
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|client_id
|Целое
|ИД клиента
|-
|number
|Строка
|Номер договора
|-
|address
|Строка
|Домашний адрес
|-
|gender
|Строка
|Пол. Может принимать значения:

• "male" - мужской

• "female" - женский
|-
|birthday
|ДД.ММ.ГГГГ
|Дата рождения
|-
|phones
|Строка
|Номера телефонов (через запятую)
|-
|login
|Строка
|Логин
|-
|password
|Строка
|Пароль
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_client_info?client_id=140 HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"client_id":140,
"name":"Васильев Артём",
"number":"000140",
"address":"Бутово,45",
"gender":"male",
"birthday":"18.02.1993",
"phones":"[\"88\",\"99\"]",
"login":"artem",
"password":"vasilev"
}
}
</pre>

=== Изменение информации по клиенту ===

Метод: POST

Название запроса: register_client

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента
|-
!colspan="3"|Необязательные параметры
|-
|name
|Строка, <= 60 символов
|ФИО
|-
|login
|Строка, <= 60 символов
|Логин
|-
|password
|Строка, <= 60 символов
|Пароль
|-
|phones
|Строка
|Номера телефонов (через запятую)
|-
|address
|Строка
|Домашний адрес
|-
|birthday
|ДД.ММ.ГГГГ
|Дата рождения
|-
|gender
|Строка
|Пол. Может принимать значения:
• "male" - мужской

• "female" - женский
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Клиент с номером телефона=PHONE уже существует
|-
|101
|Клиент с ИД=ID имеет такой же номер телефона=PHONE
|-
|102
|Клиент с логином=LOGIN уже существует
|}

Возвращаемые данные в случае успешного выполнения запроса: нет

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_order HTTP/1.1
Signature: <...>
Content-Type: application/x-www-form-urlencoded
Content-Length: 127

client_id=140&name=NAME&phones=88,99&login=LOGIN&password=PASSWORD&birthday=19930218115517&gender=male&address=ADDRESS

Ответ:

{
"code":0,
"descr":"OK",
"data":{}
}
</pre>

=== Запрос текущих заказов ===

Метод: GET

Название запроса: get_current_orders

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента (может отсутствовать, если phone заполнен)
|-
|phone
|Строка, <= 16 символов
|Телефон клиента (может отсутствовать, если client_id заполнен)
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|id
|Целое
|ИД заказа
|-
|state_id
|Целое
|ИД состояния заказа
|-
|start_time
|ГГГГММДДччммсс
|Дата создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|birthday
|ДД.ММ.ГГГГ
|Дата рождения
|-
|source
|Строка
|Адрес подачи
|-
|destination
|Строка
|Адрес назначения
|-
|passenger
|Строка
|Пассажир
|-
|crew_id
|Целое
|ИД экипажа
|-
|prior_crew_id
|Целое
|ИД предварительного экипажа
|-
|driver_id
|Целое
|ИД водителя
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_current_orders?client_id=140&phone=18 HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"orders":[
{
"id":20648,
"state_id":44,
"start_time":"20130204181111",
"source_time":"20130204181111",
"source":"1-й пр-т \/Москва\/,",
"destination":"12-й мкр,",
"passenger":"маша",
"crew_id":0,
"prior_crew_id":0,
"driver_id":0
},
{
"id":20670,
"state_id":44,
"start_time":"20130207153022",
"source_time":"20130207153022",
"source":"11-й мкр,",
"destination":"1-й пр-т \/Москва\/,",
"passenger":"саша",
"crew_id":0,
"prior_crew_id":0,
"driver_id":0
}
]
}
}
</pre>

=== Запрос выполненных заказов ===

Метод: GET

Название запроса: get_finished_orders

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента (может отсутствовать, если phone заполнен)
|-
|phone
|Строка, <= 16 символов
|Телефон клиента (может отсутствовать, если client_id заполнен)
|-
|start_time
|ГГГГММДДччммсс
|Начало периода
|-
|finish_time
|ГГГГММДДччммсс
|Конец периода
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|id
|Целое
|ИД заказа
|-
|state_id
|Целое
|ИД состояния заказа
|-
|start_time
|ГГГГММДДччммсс
|Дата создания заказа
|-
|source_time
|ГГГГММДДччммсс
|Время подачи
|-
|finish_time
|ГГГГММДДччммсс
|Время завершения заказа
|-
|birthday
|ДД.ММ.ГГГГ
|Дата рождения
|-
|source
|Строка
|Адрес подачи
|-
|destination
|Строка
|Адрес назначения
|-
|sum
|Дробное
|Стоимость заказа без учета скидок(наценок)
|-
|passenger
|Строка
|Пассажир
|-
|crew_id
|Целое
|ИД экипажа
|-
|prior_crew_id
|Целое
|ИД предварительного экипажа
|-
|driver_id
|Целое
|ИД водителя
|-
|car_id
|Целое
|ИД автомобиля
|}

Пример:

<pre>
Запрос:

GET https://ip:port/common_api/1.0/get_finished_orders?client_id=140&phone= HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"orders":[
{
"id":20651,
"state_id":34,
"source_time":"20130205110812",
"start_time":"20130205110812",
"finish_time":"20130205115618",
"source":"прпроп",
"destination":"рррррр",
"passenger":"вера",
"sum":"908",
"crew_id":"6",
"prior_crew_id":0,
"driver_id":"4",
"car_id":"6"
},
{
"id":20669,
"state_id":34,
"source_time":"20130205130500",
"start_time":"20130205130500",
"finish_time":"20130205134511",
"source":"1",
"destination":"2",
"passenger":"маша",
"sum":"454",
"crew_id":"6",
"prior_crew_id":0,
"driver_id":"4",
"car_id":"6"
}
]
}
}
</pre>

=== Проведение операции по клиенту ===

Метод: POST

Название запроса: create_client_operation

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента
|-
|oper_time
|ГГГГММДДччммсс
|Время создания операции
|-
|sum
|Дробное
|Сумма
|-
|oper_type
|Целое
|Тип операции:
• "receipt" - приход

• "expense" - расход
|-
|pay_type
|Целое
|Тип оплаты:
• "cash" - наличный

• "nocash" - безналичный
|-
!colspan="3"|Необязательные параметры
|-
|comment
|Строка
|Комментарий
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|oper_id
|Целое
|ИД операции
|}

Пример:

<pre>
Запрос:

POST https://ip:port/common_api/1.0/create_client_operation HTTP/1.1

Signature: <...>

Content-Type: application/x-www-form-urlencoded

Content-Length: 127

client_id=112&oper_time=20130221100719&oper_sum=300&oper_type=receipt&pay_type=cash&comment=COMMENT

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"oper_id":31

}
}
</pre>

=== Запрос операций по клиенту ===

Метод: GET

Название запроса: get_client_operations

Параметры:

{|
!Параметры
!Тип
!Описание
|-
!colspan="3"|Обязательные параметры
|-
|client_id
|Целое
|ИД клиента (может отсутствовать, если phone заполнен)
|-
|phone
|Строка, <= 16 символов
|Телефон клиента (может отсутствовать, если client_id заполнен)
|-
|start_time
|ГГГГММДДччммсс
|Начало периода
|-
|finish_time
|ГГГГММДДччммсс
|Конец периода
|}

Специальные возвращаемые коды:
{|
!Код
!Описание
|-
|100
|Не найден клиент ИД=CLIENT_ID
|}

Возвращаемые данные в случае успешного выполнения запроса:
{|
!Параметр
!Тип
!Описание
|-
|oper_id
|Целое
|ИД операции
|-
|oper_time
|ГГГГММДДччммсс
|Время создания операции
|-
|sum
|Дробное
|Сумма
|-
|order_id
|Целое
|Заказ, связанный с операцией
|-
|oper_type
|Целое
|Тип операции:
• "receipt" - приход
• "expense" - расход
|-
|pay_type
|Целое
|Тип оплаты:
• "cash" - наличный
• "nocash" - безналичный
|}

Пример:

<pre>
Запрос:

GET

https://ip:port/common_api/1.0/get_client_operations?client_id=112&start_time=20130201092112&finish_time=20130221092112 HTTP/1.1

Signature: <...>

Ответ:

{
"code":0,
"descr":"OK",
"data":{
"operations":[
{
"oper_id":112,
"oper_time":"20130219091328",
"sum":"21,8",
"order_id":11800,
"oper_type":"receipt",
"pay_type":"cash",
"comment":"jgznm"
},
{
"oper_id":112,
"oper_time":"20130220112245",
"sum":"4500",
"order_id":11801,
"oper_type":"receipt",
"pay_type":"cash",
"comment":"блин"
}
]
}
}
</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 HTTP/1.1
</pre>

Для получения данных из БД используются запросы типа GET. Для записи данных в БД используются запросы типа POST. В запросе типа GET параметры запроса передаются в URI.

Пример:

<pre>
GET https://ip:port/tm_tapi/1.0/get_info_by_phone?phone=89058800565&fields=PHONE_TYPEPHONE_
TO_DIAL&signature=661ce071eeefcb4f7fc8bc1f17bd520b HTTP/1.1
</pre>

В запросе типа POST параметры передаются в теле запроса в формате application/x-wwwform-
urlencoded.

Пример:

<pre>
POST https://ip:port/tm_tapi/1.0/change_order_state HTTP/1.1
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 HTTP/1.1

Секретный ключ:
321

Signature = MD5("phone=89058800565&fields=PHONE_TYPE" + "321") = ef17ea682d09e452af544a5758dba396
HTTP/1.1
</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 - если звонит номер из справочника телефоны; 0 - неизвестный номер)
|-
|PHONE_TO_DIAL
|Строка, <= 16 символов
|Номер телефона для отзвона по заказу
|-
|CREW_ID
|Целое
|ИД экипажа
|-
|IS_PRIOR
|true или false
|Признак предварительного заказа
|-
|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
|Целое
|ИД группы экипажа
|-
|CLIENT_BALANCE
|Дробное
|Баланс клиента
|-
|DRIVER_TIMECOUNT
|Целое
|Время пути водителя до адреса подачи в минутах
|-
|SOURCE_TIMECOUNT
|Целое
|Время оставшееся до подачи в минутах
|-
|SOUND_COLOR
|Строка
|Запись с информацией о цвете
|-
|SOUND_GOSNUMBER
|Строка
|Запись с информацией о государственном номере автомобиля
|-
|SOUND_MARK
|Строка
|Запись с информацией о марке автомобиля
|-
|GOSNUMBER
|Строка
|Государственный номер автомобиля
|-
|CAR_COLOR
|Строка
|Цвет автомобиля
|-
|CAR_MARK
|Строка
|Марка автомобиля
|}

Пример:

<pre>
Запрос:
GET https://ip:port/tm_tapi/1.0/get_info_by_phone?phone=89058800565l&fields=PHONE_TYPEPHONE_
TO_DIAL-CREW_ID-ORDER_ID&signature=d35ab2765f2968d48c096d5f5327db26 HTTP/1.1

Ответ:

<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>
</data>
</response>
</pre>

==== Запрос информации по ИД заказа ====

Метод: GET
Название запроса: get_info_by_order_id
Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|-
|fields
|Строка
|Список полей, которые необходимо вернуть. Поля перечисляются через ''-''
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

Специальные возвращаемые коды: нет
Возвращаемые данные в случае успешного выполнения запроса: зависит от того какие поля были переданы в поле fields.

{|
!Параметр
!Тип
!Описание
|-
|DRIVER_SOURCETIME
|Строка, <= 16 символов
|Время до подачи в минутах, указанное водителем
|-
|SOUND_COLOR
|Строка
|Запись с информацией о цвете
|-
|MARK
|Строка
|Марка автомобиля
|-
|COLOR
|Строка
|Цвет автомобиля
|-
|GOSNUMBER
|Строка
|Государственный номер автомобиля
|-
|SOUND_MARK
|Строка
|Запись с информацией о марке автомобиля
|-
|CREWGROUPID
|Целое
|ИД группы экипажа
|-
|IS_PRIOR
|true или false
|Признак предварительного заказа
|-
|DISCOUNTEDSUMM
|Строка
|Сумма заказа с учетом всех скидок
|-
|MOBILE_PHONE
|Строка, <= 16 символов
|Номер телефона водителя
|-
|CATEGORYID
|Целое
|ИД категории телефона
|-
|SOURCE_TIME
|Целое
|Время до подачи в минутах
|}

Пример:

<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
HTTP/1.1

Ответ:

<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></SOURCE_TIME>
</data>
</response>
</pre>

==== Смена состояния заказа ====
Метод: POST

Название запроса: change_order_state

Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|order_id
|Целое
|ИД заказа
|-
|need_state
|Целое
|Новое состояние заказа
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

Специальные возвращаемые коды:

{|
!Код
!Описание
|-
|100
|Заказ с таким ИД не найден.
|-
|101
|Изменение состояния не соответствует необходимым условиям.
|}

Возвращаемые данные в случае успешного выполнения запроса

{|
!Параметр
!Тип
!Описание
|-
|ORDER_ID
|Целое
|ИД созданного заказа
|-
|NEW_STATE
|Целое
|Новое состояние заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/tm_tapi/1.0/change_order_state HTTP/1.1
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"|Обязательные параметры
|-
|RECORD_DATE
|ГГГГММДДччммсс
|Дата записи
|-
|RECORD_LENGTH
|Целое
|Продолжительность записи (в секундах)
|-
|PHONE
|Строка, <= 16 символов
|Номер телефона
|-
|ORDERID
|Целое
|Заказ, с которого сделана запись
|-
|USERID
|Целое
|Пользователь, сделавший запись
|-
|FILE_PATH
|Строка,<=255 символов
|Путь к файлу записи
|-
|RECORD_GUID
|Строка,<= 80 символов
|GUID звонка
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|}

Специальные возвращаемые коды: нет
Возвращаемые данные в случае успешного выполнения запроса

{|
!Параметр
!Тип
!Описание
|-
|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: 206
RECORD_DATE=20121108145953&RECORD_LENGTH=6546&PHONE=654321&ORDERID=654&USERID=564&FILE_PATH=d%3A
%5CProjects%5Ctrunk%5C%5Ftrunk%5CTM%5CBin
%5C&RECORD_GUID=GUID456258&signature=cd11d50d65fa7e8ad73f80cdc7d296c7

Ответ:

<response>
<code>0</code>
<descr>OK</descr>
<data>
<RECORD_ID>25</RECORD_ID>
</data>
</response>
</pre>

==== Создать новый заказ ====

Метод: POST

Название запроса: make_new_order

Параметры:

{|
!Параметр
!Тип
!Описание
|-
|colspan="3"|Обязательные параметры
|-
|PHONE
|Строка, <= 16 символов
|Номер телефона
|-
|ORDER_STATE_ID
|Целое
|ИД состояния заказа
|-
|signature
|Строка
|Поле для проверки секретного ключа.
|-
|colspan="3"|Необязательные параметры
|-
|CREW_GROUP_ID
|Целое
|ИД группы экипажа
|-
|TARIFF_ID
|Целое
|ИД тарифа
|-
|PHONE_PREFIX
|Строка
|Префикс, отрезаемый от номера телефона при поиске в базе данных. Для входящих звонков это код города с префиксом входящих номеров, обычно "8". Например, "83412"
|-
|DISCOUNTED_SU MM
|Строка
|Фиксированная сумма за заказ
|}

Специальные возвращаемые коды:

{|
!Код
!Описание
|-
|100
|Клиент не найден
|}

Возвращаемые данные в случае успешного выполнения запроса

{|
!Параметр
!Тип
!Описание
|-
|ORDER_ID
|Целое
|ИД созданного заказа
|}

Пример:

<pre>
Запрос:

POST https://ip:port/tm_tapi/1.0/make_new_order HTTP/1.1
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>
</pre>

== Пример формы для заказа такси ==
{{url|{{корень FTP|forms/zakaz_taxi.zip}}}}

Данная форма является примером, на основе которого можно построить собственную форму для принятия интернет-заказов. Форму можно использовать либо в исходном варианте, либо применяя запросы [[TM API#Описание запросов|TM API]].
Для того, чтобы данная форма функционировала, необходимо открыть файл в любом текстовом редакторе и указать корректные IP-адрес [[Сервер Такси-Мастер|сервера Такси-Мастер]], порт [[TM API#Параметры TM API|TM API]] и секретный ключ. Далее вам следует загрузить файл на хостинг.

Именно так будет выглядеть данная форма для заказа такси.
{{картинка|Форма для заказа такси.jpg}}

[[Категория:ТМ2]]