WebAPI. Руководство по интеграции
Москва 2017
Оглавление
Введение 3
Начало сессии (Login) 4
Завершение сессии (Logout) 4
Проверить обслуживание по направлению 4
Вызов курьера 5
Отмена вызова курьера 6
Создание заявки на доставку (создание отправлений) 6
Удаление заявки на доставку (удаление отправления) 8
Регистрация клиента 9
Информация о клиенте 9
Получение печатной этикетки 10
Получение печатной накладной 10
Получение информации по заявке на доставку 11
Получение статусов заявок на доставку 13
Получение списка заявок на доставку 13
Поиск отправления по номеру накладной/вх. накладной 14
История изменения статуса отправления 15
Получение списка заявок на сбор 15
Тарифный калькулятор 16
Расчет стоимости по номеру отправления 17
Получение списка пунктов выдачи заказов(ПВЗ) 17
Получение списка возможных отчетов 18
Получение отчета 18
Получение ведущего менеджера 19
Получение контактной информации отправителя и получателя 19
Добавление/Изменение контактной информации отправителя и получателя 20
Удаление контактной информации отправителя и получателя 20
Расчет стоимости доставки по реестру 21
Приложение 1. Список услуг GD 23
Введение
Для начала работы клиента с API, необходимо завести ему Логин и Пароль в РС "API Авторизация"
ID сессии хранятся в РС "Cессии ЛК"
ID сессии имеет срок годности 2 часа.
В каждом запросе разделитель является символ "
Все запросы и ответы формируются в JSON.
Адрес тестового сервера:
http://test. global-delivery. ru/api-delivery/<метод>
Адрес продуктивного сервера:
http://production. global-delivery. ru/api-delivery/<метод>
Тестовые параметры подключения:
Login – Test
Password - Test
Начало сессии (Login)
URL: /login
Метод: POST
Описание
Команда предназначена для начала сеанса работы. В запросе отправляемся логин и пароль, в случае правильности, возвращается уникальный номер сессии, который действителен в течение 2х часов, если по ней не было Logout. Вся дальнейшая работа ведется на основании номера сессии (одну сессию можно использовать для любого запроса, пока она валидна).
Структура запроса
{
"Login":"логин (50 символов)",
"Password":" пароль (20 символов)"
}
Структура ответа
{
“Success”: ”<true/false>”,
“SessionId”: ”<уникальный идентификатор сессии (GUID 16 байт)>”,
“ErrorCode”: <код ошибки>”,
“ErrorMessage”: ”<текстовое сообщение об ошибке (200 символов)>”
}
Завершение сессии (Logout)
URL: /logout
Метод: POST
Описание
Команда предназначена для завершения сеанса работы. В запросе отправляется идентификатор сессии. В ответ возвращается признак успешности выполнения.
Структура запроса
{
"SessionId": " уникальный идентификатор сессии (GUID 16 байт )"
}
Структураответа
{
“Success”: ”<true/false>”,
“ErrorCode”: ”<кодошибки>”,
“ErrorMessage”: ”<текстовое сообщение об ошибке (200 символов)>”
}
Проверить обслуживание по направлению
Метод позволяет получить ответ, по входящим параметрам, проводит ли компания доставку грузов по направлению.
URL: / Route
Метод: POST
Структура запроса
{
{
"ToCity": "<город получатель>",
"FromCity": "<город отправитель>",
"ToRegion": "<регион получатель>",
"FromRegion": "<регион отправитель>"
}
Структура ответа
{
"Success": "<Признак успешности запроса>",
"ErrorMessage": ”<Описание ошибки>”,
"ErrorCode": "Код ошибки>”
}
Вызов курьера
Создает забор груза с указанными внутри заказами. При вызове курьера с типом Двери-Двери необходимо использовать метод createshipments с видом доставки Д-Д
При создании нового вызова значение OrderNumber будет пустым. После обработки метода API вернет OrderNumber системы. Для изменения уже созданного вызова, не обходимо передавать OrderNumber полученный в первой транзакции создания.URL: /couriercall
Метод: POST
Описание:
В Header запроса:
“SessionId”: ”<уникальный идентификатор сессии (GUID 16 байт)>”
Структура тела запроса:
{
"ICN":" индивидуальный номер клиента ", обязательное поле,
“OrderNumber“: “<номер накладной>”,
“FullAddress“: “<Полный адрес сбора>”,
“PostalCode”: “<почтовый индекс>”
“Region”: “<Регион>”,
“City“: “<Город>”,
“Area“ : “<Район>”,
“Settlement“: “<Населенный пункт>”,
“Street”: “<Улица>”,
“House”: “<Дом>”,
“Building”: “<Строение>”,
“Block”: “<Корпус>”,
“Flat”: “<Квартира/офис>”,
“Name“: “<Контактное лицо>”, обязательное поле,
“Phone“: “<Контактный телефон>”, обязательное поле,
“AddPhone“: “<Добавочный номер к Phone>”,
“PickupDate“ “<Дата сбора>”, обязательное поле,//формат ггггммдд
“PickupTimeFrom“: “<Ожидаемое время сбора с>”,//формат чч:мм
“PickupTimeTo“: “<Ожидаемое время сбора по>”,//формат чч:мм
“Weight”: “<Общий вес, кг.>” примерное значение,
“Comment“: “<Комментарий для курьера>”,
“Shipments”: “<Массив с номерами отправлений привязанными к вызову>”
[“SPE0001234”, “SPE0001235” ]
"Services": [“<Массив услуг>”
{ "code": "<артикул услуги>",
"count": "<количественное выражение, если требуется>"
}
]
}
Структура ответа
{
“Success”: ”<Признак успешности регистрации вызова курьера >,//<true/false>
“OrderNumber ”: ”<Номер вызова/сбора>”,
“ErrorCode”: ”<код ошибки>”
“ErrorMessage”: ”<Описание ошибки>”
}
Отмена вызова курьера
Для отмены вызова необходимо передавать OrderNumber полученный в транзакции создания.
URL: /couriercallcancel
Метод: POST
В Header запроса:
“SessionId”: ”<уникальный идентификатор сессии (GUID 16 байт)>”
Структура запроса
{
“OrderNumber“: “<Номер вызова/сбора>”, обязательно
}
Структура ответа
{
“OrderNumber“: “<Номер вызова/сбора>”,
“Success”: ”<Результат запроса>”//<true/false>,
|
Из за большого объема этот материал размещен на нескольких страницах:
1 2 3 4 5 6 |
