API модуля мобильных устройств — различия между версиями
Johny (обсуждение | вклад) м (→Создание/изменение курьеров) |
Johny (обсуждение | вклад) (→Создание/изменение курьеров) |
||
Строка 4: | Строка 4: | ||
== Создание/изменение курьеров == | == Создание/изменение курьеров == | ||
+ | Запрос отправляется по адресу https://home.courierexe.ru/api/clientapi.php | ||
+ | |||
<source lang="xml"> | <source lang="xml"> | ||
<?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
<upload> | <upload> | ||
− | <auth | + | <auth login="login" pass="pass" /> |
<table>kurier</table> | <table>kurier</table> | ||
<item> | <item> | ||
Строка 19: | Строка 21: | ||
</item> | </item> | ||
</upload> | </upload> | ||
+ | </source> | ||
+ | |||
+ | Запрос содержит тег upload - загрузка на сервер. auth - авторизация по login и pass. table - имя таблицы. | ||
+ | Далее следуют один или несколько контейнеров item, каждый содержит 1 запись для добавления или изменения на сервере. | ||
+ | |||
+ | Описание полей: | ||
+ | code - int, идентификатор записи. Если запись с таким code уже есть - она будет заменена. | ||
+ | name - ФИО курьера | ||
+ | phonem - телефон курьера. Используется для обратного звонка при интеграции с телефонией. | ||
+ | dateput - дата увольнения, чтобы блокировать курьера. Если курьер работает - NULL, если уволен - укажите дату увольнения в формате YYYY-MM-DD | ||
+ | |||
+ | В случае успеха запроса сервер вернет: | ||
+ | <source lang="xml"> | ||
+ | <?xml version="1.0" encoding="UTF-8"?> | ||
+ | <upload error="0">OK</upload> | ||
</source> | </source> | ||
Версия 18:46, 21 июля 2015
Для взаимодействия модуля мобильных устройств со сторонними системами предусмотрено XML API.
Содержание
Создание/изменение клиентов
Создание/изменение курьеров
Запрос отправляется по адресу https://home.courierexe.ru/api/clientapi.php
<?xml version="1.0" encoding="UTF-8"?>
<upload>
<auth login="login" pass="pass" />
<table>kurier</table>
<item>
<code>2681</code>
<name>Иванов Иван Иванович</name>
<phonem>8-916-123-45-67</phonem>
<dateput>NULL</dateput>
</item>
<item>
...
</item>
</upload>
Запрос содержит тег upload - загрузка на сервер. auth - авторизация по login и pass. table - имя таблицы. Далее следуют один или несколько контейнеров item, каждый содержит 1 запись для добавления или изменения на сервере.
Описание полей: code - int, идентификатор записи. Если запись с таким code уже есть - она будет заменена. name - ФИО курьера phonem - телефон курьера. Используется для обратного звонка при интеграции с телефонией. dateput - дата увольнения, чтобы блокировать курьера. Если курьер работает - NULL, если уволен - укажите дату увольнения в формате YYYY-MM-DD
В случае успеха запроса сервер вернет:
<?xml version="1.0" encoding="UTF-8"?>
<upload error="0">OK</upload>
Создание заказов
Получение статусов заказов
Получение изображений к заказам
Получение треков курьеров
API модуля мобильных устройств почти полностью совпадает с обычным API, за исключением авторизации:
<?xml version="1.0" encoding="UTF-8" ?>
<neworder>
<auth2 clientcode="655" extra="8" login="MEASOFT2" pass="pass"></auth2>
<order orderno="11_11_11">
<coords>
<lat>55.768679</lat>
<lon>37.589042</lon>
</coords>
<code>1851117</code>
<courier>927</courier>
<barcode>11_11_11</barcode>
<sender>
<company>МВД</company>
<person>Иванов И.И.</person>
<phone>123-45-67</phone>
<town>Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</sender>
<receiver>
<company>МВД</company>
<person>Чип & Дейл</person>
<phone>123-45-67</phone>
<zipcode>125480</zipcode>
<town>Санкт-Петербург</town>
<address>Петровка 38 офис 35</address>
<date>2014-03-22</date>
<time_min>09:00</time_min>
<time_max>14:00</time_max>
</receiver>
<return>NO</return>
<return_service>1</return_service>
<weight>5.1</weight>
<quantity>2</quantity>
<paytype>CASH</paytype>
<service>2</service>
<price>387.5</price>
<inshprice>387.5</inshprice>
<enclosure>Детские игрушки</enclosure>
<instruction>Проверить при покупателе, подписать акт</instruction>
</order>
</neworder>
Вместо блока <auth></auth> используется <auth2></auth2> Поле clientcode - код клиента в системе
При создании нового заказа в блоке <order></order>
так же добавлены новые поля:
<coords> - координаты
<lat>55.768679</lat>
<lon>37.589042</lon>
</coords>
<code>1851117</code> код заказа
<courier>927</courier> код курьера