Поиск по сайту

API
Главная / API - Общая информация

API клиентского сайта Деловые Линии

Регистрация

Наш API абсолютно бесплатен.

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

Обратите внимание, что в случае недобросовестного использования нашего сервиса блокировка осуществляется по ключу приложения.

Возможности API

Для оформления заказа следует использовать метод "Перевозка сборных грузов". Он позволяет оформить заказ на доставку груза от адреса отправителя до адреса получателя или до терминала компании "Деловые Линии", откуда получатель самостоятельно заберет груз. Если планируется отправка от терминала, то при помощи данного метода можно оформить предзаказ.

Примечание. Если груз малогабаритный, то при оформлении заказа следует выбирать соответствующий вид доставки (передавать в параметре "delivery.deliveryType.type" значение "small"). Малогабаритным считается груз, параметры которого не превышают следующие значения:

  • масса меньше либо равна 30 кг;

  • Д*Ш*В меньше либо равны 0,54*0,39*0,39 м;

  • объём меньше либо равен 0,1 куб. м.

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

Прежде чем оформлять заказ, можно рассчитать его стоимость — точную или ориентировочную, а также уточнить возможность и условия заказа определённых услуг (дополнительной упаковки, отправки в день оформления заказа и т. д.) с учётом параметров перевозки (населённого пункта отправки/доставки, веса груза и т. д.). Для отслеживания заказов предусмотрен "Журнал", если же номер заказа неизвестен, воспользуйтесь поиском по параметрам. 

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

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

При необходимости заказ можно отменить или внести в него изменения:

Внимание! Обработка заявки на внесение изменений занимает некоторое время. Отследить статус заявки на внесение изменений вам поможет метод "История изменений заказа". 

Для проверки возможности внесения изменений в заказ предусмотрен отдельный метод — "Доступные изменения заказа". 

Заказы с одинаковым адресом отправки можно объединить в мультизаявку, а в случае отправки нескольких заказов с одного терминала есть возможность оформить пакетный заказ Pre-Alert (для использования решения Pre-Alert клиенту необходимо связаться с менеджером компании "Деловые Линии" и сообщить о своём желании работать по данной технологии).

При заказе услуги "Перевозка сборного груза" груз включают в партию вместе с грузами других клиентов, перевозка осуществляется по стандартному маршруту, а не напрямую. "Деловые Линии" также предоставляют услуги по доставке выделенным малотоннажным транспортом или еврофурами, при этом перевозка осуществляется напрямую. Также есть возможность арендовать транспорт на несколько часов.

Часть вышеперечисленных методов, например, отмена заказа, доступна только после авторизации пользователя. В запросе таких методов необходимо передавать параметр sessionID. Для получения ID сессии используется метод "Авторизация пользователя". Чтобы получить логин и пароль, необходимые для выполнения авторизации, пользователю следует зарегистрироваться на сайте компании "Деловые Линии". Для использования некоторых сервисов, например, смены плательщика, необходим "полный доступ", то есть нужно подтвердить принадлежность учётной записи конкурентному физическому/юридическому лицу. Пользователь может работать от имени нескольких юридических/физических лиц, при этом для каждого из лиц можно оформить "полный доступ". Для работы с данными юридических/физических лиц, связанных с учётной записью, предусмотрен метод "Список контрагентов", он в том числе позволяет уточнить, оформлен ли "полный доступ" для физического/юридического лица. 

Примечание. Как сказано выше, "Список контрагентов" — это метод для работы данными контрагентов-заказчиков, связанных с учётной записью, для работы с данными прочих участников перевозки предусмотрен метод "Контрагенты"

Особенности реализации

Наш API умеет общаться при помощи двух форматов данных: JSON и XML. Вы можете использовать любой из них в зависимости от ваших предпочтений.
Различия в функционале между ними — отсутствуют.

Взаимодействовать с нашим API необходимо при помощи метода POST, а выбор формата между JSON и XML осуществляется через передачу заголовка content-type.
Для JSON мы принимаем content-type равный application/json (стандарт RFC4627), для XML — text/xml  (стандарт RFC3023).

Наш API работает в кодировке utf-8.

По умолчанию для всех пользователей установлены следующие ограничения по количеству запросов:

  • лимит запросов от приложения в час: 1600;
  • лимит запросов от приложения в минуту: 45.

Для увеличения лимита вы можете обратиться к курирующему менеджеру напрямую или через форму обратной связи

Рекомендуемый тайм-аут соединения — 10 секунд.

В настоящий момент существуют следующие возможности для тестирования метода оформления заказов в рабочем API: создать черновик (передать в параметре "inOrder" значение "false") или оформить предварительный заказ (выбрать доставку от терминала, то есть передать в параметре "delivery.derival.variant" значение "terminal"). Как черновик, так и предварительный заказ впоследствии необходимо отменить в личном кабинете на сайте.

Особенности работы с API

В нашем API предусмотрена возможность сохранять часто используемые данные в адресной книге (см. методы одноименного раздела). Однако следует иметь в виду, что неиспользуемые записи будут удалены через 6 месяцев.

При передаче данных контрагента необходимо в том числе передать наименование и UID ОПФ (организационно-правовой формы). Получить эти данные можно при помощи метода "Поиск ОПФ" или же метода "Поиск контрагентов" (метод позволяет найти контрагента в реестрах ЕГРЮЛ/ЕГРИП по ИНН или наименованию).

Если при оформлении заказа нет возможности получить полные данные контрагента-получателя, то можно воспользоваться услугой "Упрощённая отправка". В этом случае достаточно сообщить имя и номер телефона получателя. Для получения услуги необходимо при оформлении заказа передать значение "true" в параметре "members.receiver.counteragent.isAnonym".

Для передачи данных адреса в наших методах используется класс "Address". При этом адрес можно передать в виде строки (параметр "search") или с использованием КЛАДР (классификатора адресов Российской Федерации) в виде набора параметров (параметры "street", "house", "building", "structure" и "flat"). При этом следует учесть, что в нашем API используется нестандартный формат кодов КЛАДР. Для поиска кодов КЛАДР населённых пунктов предусмотрен специальный сервис, также можно можно найти страну, населенный пункт или улицу по названию или получить полный справочник населенных пунктов/улиц.