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

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

API Деловых Линий

API Деловых Линий – это набор сервисов, открытых для использования сторонними разработчиками. Наш API может быть использован как в самостоятельных проектах, так и в проектах по расширению функциональности, направленных на автоматизацию взаимодействия с Деловыми Линиями. 

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

Как начать работать

  1. Зарегистрируйтесь на сайте для разработчиков.
  2. Получите API-ключ на e-mail. Это идентификатор вашего приложения при выполнении всех запросов.
  3. Используйте SDK или разработайте собственное решение на основе нашего API.

API Деловых Линий предоставляется бесплатно.

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

Заказать перевозку сборных грузов

Когда требуется заказать перевозку между терминалами Деловых Линий. В одной машине едут заказы разных клиентов.

Метод «Перевозка сборных грузов» позволяет:

Для грузов до 30 кг действует специальный тариф «Доставка малогабаритного груза». Чтобы им воспользоваться, при оформлении заказа следует выбирать соответствующий вид доставки (передавать в параметре "delivery.deliveryType.type" значение "small").

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

Малогабаритным считается груз с параметрами:

  • Вес — не более 30 кг
  • Стороны (Д × Ш × В) не превышают 0,54 × 0,39 × 0,39 м
  • Объём — не более 0,1 м3

Оформить мультиотправку

Чтобы объединить несколько заявок в одну, используйте метод «Мультизаявка». Подходит для случаев, когда нужно отправить груз от одного адреса разным получателям.

Отправить с помощью Pre-Alert

Этот способ отправки позволяет принять и распределить груз по партиям на терминале Деловых Линий.  Присутствие вашего экспедитора не требуется, что ускоряет отправку груза. Используйте метод «Пакетный заказ Pre-Alert».

Заказать выделенный транспорт

Когда для груза одного отправителя требуется целая машина. Транспорт следует без заездов на терминалы — от дверей до дверей.

Используйте методы:

Рассчитать стоимость и сроки

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

Уточнить возможность и условия заказа дополнительных услуг (упаковки, отправки в день заказа и других) с учетом параметров перевозки (населённого пункта отправки/получения, веса груза и т. д.) поможет метод «Проверка ограничений».

Отследить заказ

Используйте метод «Журнал заказов» для поиска по номеру заказа, который присвоен в Деловых Линиях, или по вашему внутреннему номеру (orderNumber). Найти заказ без номера можно поиском по параметрам

Метод позволяет получить детальную информацию: данные участников перевозки, услуги по накладной, номер накладной и счет-фактуры, параметры груза и другие данные.

Перевозка состоит из нескольких этапов, каждому соответствует свой статус.  Ознакомьтесь с ними в справочнике статусов.

Управлять заказом

Заказ можно отменить или внести в него изменения:

Отменить заказ или доставку до адреса

Заказать доставку до адреса, если груз уже отправлен и заказана доставка только до терминала. Чтобы рассчитать стоимость такой доставки, используйте калькулятор услуги «Доставка до адреса»

— Изменить получателя или плательщика

— Изменить адрес и время отправки и доставки

Смотреть историю заявок на изменение и отслеживать их статусы

Проверить, какие изменения доступны

Пользоваться личным кабинетом

Личный кабинет клиента Деловых Линий позволяет:

  • Управлять заказами
  • Смотреть подробную информацию по перевозкам
  • Пользоваться адресной книгой
  • Получать отчеты по перевозкам

Все возможности личного кабинета

В запросе методов, для которых требуется авторизация, необходимо передавать параметр sessionID. Для получения ID сессии используется метод «Авторизация пользователя».

Полный доступ к личному кабинету

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

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

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

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

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

Чтобы выбрать формат, передайте заголовок content-type:

  • Для JSON — application/json (стандарт RFC4627)
  • Для XML — text/xml (стандарт RFC3023)

Наш API работает в кодировке utf-8, взаимодействует с помощью метода POST.

Ограничения по количеству запросов:

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

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

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

Рекомендации

Данные адресной книги

Часто используемые данные в адресной книге можно сохранять (см. методы одноименного раздела). Неиспользуемые записи удаляются через 6 месяцев.

Передача данных контрагента

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

Упрощенная отправка

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

Передача адреса

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

Мы используем нестандартный формат кодов КЛАДР: для поиска кодов населённых пунктов предусмотрен специальный сервис. Найти страну, населенный пункт или улицу можно по названию или получить полный справочник населенных пунктов/улиц.

Отладка

Чтобы протестировать метод оформления заявок, создайте черновик (передать в параметре "inOrder" значение "false") или оформите предварительный заказ (выбрать доставку от терминала, то есть передать в параметре "delivery.derival.variant" значение "terminal").

Примеры запросов

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