API ПОЛУЧЕНИЯ XML ДЛЯ МЕРКУРИЯ ИЗ ON-LINE ЛОГИСТИКА
ПОДКЛЮЧЕНИЕ ПОЛЬЗОВАТЕЛЯ (ЗАКАЗЧИКА) К API ON-LINE ЛОГИСТИКА
Для подключения пользователя к API надо в ON-LINE ЛОГИСТИКА сгенерировать ключ доступа.
Для этого администратор Лог оператора должен зайти в нужного пользователя (пользователя под которым Клиент вносит заказы) и там сгенерируем ключ, который надо передать пользователю.
Доступ производится от лица пользователя, владельца ключа.
HTTPS API
Самый неправильный способ получения данных по транспортному средству для Меркурия, так как информация добавляется в онлайн режиме. При выборе этого способа обновления в системе Меркурий будут происходить с запозданием.
Забирать XML по HTTPS протоколу (просто скачать файл) для нужной ему накладной можно по ссылке:
https://altlog.ru/mercury/get_xml.htm?api-key={API-KEY}&issueNumber={WB_NUMBER}&issueDate={WB_DATE}
Где:
altlog.ru - домен логистического оператора. Обычно это домен второго уровня, например online.altlog.ru
{API-KEY} - Ключ доступа клиента
{WB_NUMBER} - Номер накладной
{WB_DATE} - Дата накладной
WEBSERVICE
Если Заказчиком выбран вариант получения информации через веб-сервис логистического оператора – ему нужно использовать следующие параметры для подключения:
Веб-сервис: https://altlog.ru/wsdl/ExternalExchange.php?wsdl
Операция: GetTransportInfo
Авторизация: Используется Basic HTTP-аутентификация
Логин и пароль тот же что и при внесении заказов
Входящие параметры:
issueNumber - номер накладной (тип строка, обязательный).
issueDate - дата накладной (тип дата без времени, обязательный). Заполняется Поставщиком для поиска его документа с учетом даты документа в интервале issueDate +/- 3.
ОПИСАНИЕ ОТВЕТА СЕРВЕРА
Пример структуры отдельного файла:
<waybills>
<waybill>
<issueNumber>102514428</issueNumber>
<issueDate>2017-09-27T00:00:00</issueDate>
<transportInfo>
<transportType>1</transportType>
<vehicleMark>MAN</vehicleMark>
<transportNumber>
<vehicleNumber>О044АУ31</vehicleNumber>
<trailerNumber>АН252531</trailerNumber>
</transportNumber>
</transportInfo>
<shipmentRoute>
<routePoint>
<sqnId>1</sqnId>
<location>
<name>Склад Перевозчика (Ростов-на-Дону)</name>
<address>346720, Ростовская обл, Аксайский р-н, Аксай г, Западная ул, дом № 35 Е</address>
</location>
<enterprise>
<GUID>8fcfd230-0b46-4303-8566-f7f9f9c9acf2</GUID>
<name>Склад Перевозчика (Ростов-на-Дону)</name>
<address>346720, Ростовская обл, Аксайский р-н, Аксай г, Западная ул, дом № 35 Е</address>
</enterprise>
<transshipment>true</transshipment>
<nextTransport>
<transportType>1</transportType>
<vehicleMark>DAF</vehicleMark>
<transportNumber>
<vehicleNumber>Р617НВ161</vehicleNumber>
<trailerNumber>ЕА663726</trailerNumber>
</transportNumber>
</nextTransport>
</routePoint>
</shipmentRoute>
</waybill>
</waybills>
waybills - корневой элемент XML структуры. Содержит список транспортной информации для каждого документа. Один документ - один узел xml структуры.
waybill - корневой элемент XML структуры, может быть несколько в отдельном файле WBL*.
Название |
Описание |
Обязательно для заполнения |
Тип данных |
Размер поля |
Формат или константа |
---|---|---|---|---|---|
issueNumber |
Номер заказа \ накладной |
Х |
Символьный |
255 |
|
issueDate |
Дата заказа \ накладной |
Х |
Дата |
dateTime |
transportInfo (первое ТС) или nextTransport (следующее ТС) - корневой элемент XML структуры
Название |
Описание |
Обязательно для заполнения |
Тип данных |
Размер поля |
Формат или константа |
---|---|---|---|---|---|
transportType |
Тип транспортного средства |
Х |
Числовой |
1 |
1 = Автомобильный. 2 = Железнодорожный. 3 = Авиатранспортный. 4 = Морской (контейнер). 5 = Морской (трюм). |
vehicleMark |
Марка транспортного средства |
Х |
Символьный |
255 |
transportNumber - корневой элемент XML структуры
Название |
Описание |
Обязательно для заполнения |
Тип данных |
Размер поля |
Формат или константа |
---|---|---|---|---|---|
vehicleNumber |
Номер автомобиля |
Х |
Символьный |
255 |
|
trailerNumber |
Номер прицепа (полуприцепа) |
Символьный |
255 |
shipmentRoute - корневой элемент XML структуры. Содержит список пунктов перегрузки груза.
routePoint - корневой элемент XML структуры, может быть несколько.
Название |
Описание |
Обязательно для заполнения |
Тип данных |
Размер поля |
Формат или константа |
---|---|---|---|---|---|
sqnId |
Порядковый номер точки маршрута \ пункта перегрузки. |
Х |
Числовой |
1 |
|
transshipment |
Признак того, осуществляется ли в данной точке перегрузка. |
Х |
Булево |
true = да. false = нет. |
location - корневой элемент XML структуры
Название . |
Описание |
Обязательно для заполнения |
Тип данных |
Размер поля |
Формат или константа |
---|---|---|---|---|---|
name |
Название пункта перегрузки |
Х |
Символьный |
255 |
|
address |
Адрес пункта перегрузки. |
Х |
Символьный |
255 |
enterprise - корневой элемент XML структуры
Название |
Описание |
Обязательно для заполнения |
Тип данных |
Размер поля |
Формат или константа |
---|---|---|---|---|---|
GUID |
Глобальный уникальный идентификатор предприятия в реестре Россельхознадзора в продуктивном Меркурии. |
Х |
Символьный |
36 |
|
GUIDtest |
Глобальный уникальный идентификатор предприятия в тестовой версии Меркурия. |
Х |
Символьный |
36 |
|
name |
Название пункта перегрузки. |
Х |
Символьный |
255 |
|
address |
Адрес пункта перегрузки. |
Х |
Символьный |
255 |