Перейти к содержанию

Интерфейс REST для опасных грузов

Что делает интерфейс

Связь между DGAssistant и учётной системой

Отправки. Интерфейс REST с JSON создаёт отправку опасного груза из вашей учётной или логистической системы и возвращает декларацию грузоотправителя, контрольный перечень и маркировку упаковок, уже проверенные по применимым правилам. Ваша система хранит коммерческие данные; DGAssistant даёт знание правил и документы.

Консолидация. Интерфейс охватывает и объединение отправок нескольких грузоотправителей по двум его осям. Договорная ось — основная отправка: бронирование, морская или воздушная консолидация, дорожная сборная партия, — с её участниками, её ссылками, присоединёнными отправками, переходами состояний и историей. Физическая ось — транспортная единица (контейнер, транспортное средство, прицеп или средство пакетирования) и транспортный рейс (рейс судна, полёт или поездка) с его заходами, вместе с судами, транспортными средствами и пунктами учётной записи. Более половины службы посвящено этой части.

Открыть спецификацию интерфейса для опасных грузов

Два режима работы: пакетный и диалоговый

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

Диалоговый. Сначала отправка открывается, затем грузы добавляются по одному. Каждый ответ несёт сообщения проверки только что добавленного, чтобы ваше приложение могло показать их пользователю во время подготовки отправки.

Заранее описанные данные или данные в самом вызове

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

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

Документы, которые он возвращает

API возвращает те же документы, которые формирует приложение. Документы отправки и консолидации выгружаются в PDF, XLSX или DOCX, документы отправки можно также отправить по электронной почте прямо из службы; документы транспортной накладной — в PDF.

  • По каждой отправке: транспортный документ применимых правил —транспортный документ ДОПОГ, декларация ИМО об опасных грузах или мультимодальная форма МКМПОГ и декларация грузоотправителя ИАТА—, контрольный перечень, маркировка упаковок в полном размере или в малом пользовательском размере, а при воздушной перевозке — лист данных для авиагрузовой накладной.
  • По основной отправке: консолидированный манифест, список контейнеров, упаковочный лист каждой единицы, погрузочная ведомость по грузоотправителям и лист данных основного документа.
  • По транспортной единице: свидетельство о загрузке контейнера или транспортного средства, мультимодальная форма для опасных грузов, отчёт о разделении единицы, контрольный перечень перед подписанием свидетельства и консолидационная этикетка.
  • По рейсу: манифест опасных грузов, отчёт о разделении между единицами на борту, отчёт о пороге изъятия по ДОПОГ 1.1.3.6, лист ограничений рейса, погрузочная ведомость, уведомление командиру воздушного судна (NOTOC) и консолидированный транспортный документ транспортного средства.
  • По транспортной накладной: черновик, подписанный экземпляр, приложенный транспортный документ ДОПОГ и доказательственный отчёт.

Что проверяет интерфейс

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

В консолидации. Разделение внутри транспортной единицы, разделение между единицами, загруженными в один рейс, расчёт порога 1.1.3.6 ДОПОГ для рейса с его расшифровкой и ограничения маршрута, возвращаемые как данные, например код ограничения проезда через туннели или наличие грузов повышенной опасности.

Охваченные правила и виды перевозки

ДОПОГ для дороги, МКМПОГ для моря, ИАТА для воздуха и 49 CFR. Три основных свода правил ведутся вместе, а не как отдельные модули, чтобы отправку, меняющую вид перевозки, не приходилось готовить заново.

Совместная упаковка, транспортные пакеты, цистерны, перевозка навалом, порожняя неочищенная тара, отходы, взрывчатые вещества класса 1 —с массой нетто взрывчатого вещества на упаковку— и радиоактивные материалы класса 7 поддерживаются со всеми данными, которых каждый из них требует. Тексты документов выпускаются на девятнадцати языках.

Доступность

Служба опубликована в трёх регионах — Европа, Америка и Азиатско-Тихоокеанский регион, — у каждого свой адрес, чтобы подключение работало с тем регионом, где ведётся учётная запись. Инфраструктура зарезервирована и находится под непрерывным наблюдением.

Как начать

Запросите бесплатную двухнедельную пробную версию, а вместе с ней — учётные данные службы. Проверка подлинности использует OAuth 2.0 по схеме «client credentials»: ваша система получает токен доступа и передаёт его в каждом запросе.

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

Разделы спецификации интерфейса

Раздел
ОбзорОписание интерфейса и ограничений его использования, файлы спецификации OpenAPI 3.0 и 2.0 и перечень всех её разделов.Открыть
Проверка подлинностиТокены доступа OAuth2, выдаваемые по схеме «client credentials», как альтернатива проверке подлинности HTTP Basic во всех операциях, требующих проверки подлинности.Открыть
Проверки подключенияПроверка доступности интерфейса, учётных данных пользователя интерфейса и запросов с проверкой подлинности и без неё.Открыть
Справочные данныеОпасные грузы и радионуклиды, тара и инструкции по упаковке, коды, страны и пункты, на которые ссылаются отправки, продукты и консолидация.Открыть
ПродуктыПростые продукты и продукты в совместной упаковке из каталога, включая создание продукта в совместной упаковке для отправки в диалоговом режиме.Открыть
УчастникиЗаранее описанные участники: грузоотправители, грузополучатели, погрузчики, перевозчики, поставщики и водители.Открыть
Транспортные средства, прицепы и судаТранспортные средства, прицепы и суда учётных записей с регистрационным номером, обозначением по ДОПОГ и документом о соответствии.Открыть
Пункты и ограниченияПорты, аэропорты и терминалы учётных записей и ограничения, действующие, когда в них планируется или загружается транспортная единица.Открыть
ОтправкиСоздание отправки со всем её содержимым (пакетный режим) или с первым содержимым (диалоговый режим), а также получение и удаление отправок.Открыть
Содержимое отправкиПродукты, совместные упаковки и транспортные пакеты, добавляемые в отправку, обрабатываемую в диалоговом режиме, или удаляемые из неё.Открыть
Документы отправкиДокументы отправки (транспортный документ, контрольный перечень, маркировка упаковок и другие), их отправка по электронной почте и зафиксированные документы.Открыть
Транспортные накладныеНакладные КДПГ (CMR), электронные (e-CMR) и национальные транспортные накладные: от проверки охвата маршрута Протоколом e-CMR до оформления, доставки и аннулирования.Открыть
Заявки на консолидациюЗаявки на консолидацию от учётных записей клиентов или от их консультанта по вопросам безопасности от их имени и решения консолидатора.Открыть
Основные отправкиОсновные отправки с входящими в них отправками и порядком их утверждения.Открыть
Транспортные единицыТранспортные единицы, их содержимое, проверки разделения и история перемещений.Открыть
Рейсы и заходыМорские рейсы, авиарейсы и автомобильные поездки с их заходами и транспортными единицами, проверки разделения, расчёт порогового значения загрузки (ДОПОГ 1.1.3.6) и ограничения.Открыть
Документы консолидацииДокументы основных отправок, транспортных единиц и рейсов.Открыть
ВебхукиПодписки учётной записи на вебхуки, их проверка и последние доставки.Открыть

Чтобы убедиться, насколько быстро и просто идёт подключение, воспользуйтесь двухнедельной пробной версией без обязательств