跳至正文

危险货物 REST API

该 API 的功能

DGAssistant 与管理系统之间的连接

托运货物。DGAssistant 的 JSON REST API 可自贵方的管理或物流系统创建危险货物托运,并返回托运人申报单、检查表与货包标记,且均已依照适用法规完成校验。商务数据留在贵方系统;法规知识与单证由 DGAssistant 提供。

集拼。该 API 同样涵盖多个托运人货物的归集,并沿两条主线展开。合同主线是总托运货物——订舱、海运或空运集拼、公路拼车——包含其当事方、各类参考号、所挂靠的托运货物、状态流转与历史记录。实物主线是运输组件(集装箱、车辆、挂车或集装器)与运输行程(航次、航班或行程)及其挂靠港站,并包含账户下的船舶、车辆与地点。本服务半数以上的内容均用于这一部分。

打开危险货物 API 规范

两种调用方式:批量与交互

批量。单次调用即携带托运货物的完整规格及其全部货物。此方式面向发送已组装完毕托运货物的管理与物流系统。

交互。先创建托运货物,再逐项添加货物。每次返回均带有刚添加内容的校验提示,使贵方应用程序可在办理过程中向用户展示。

预设数据或即时数据

预设数据。产品与当事方——托运人、承运人、收货人、装货人与驾驶员——事先创建,API 直接引用其编码。这是最简便的方式,也是我们推荐的方式,因为法规分类一次确定,此后每批托运货物均可复用。

即时数据。产品与当事方在创建托运货物的同一次调用中定义。适用于不维护自有目录或仅偶尔发运危险货物的系统。

可返回的单证

API 返回的单证与系统所生成的单证相同。托运货物与集拼的单证可取得 PDF、XLSX 或 DOCX 格式,托运货物的单证还可直接由本服务通过电子邮件发送;运单的单证为 PDF 格式。

  • 每批托运货物:适用规章的运输单证(ADR 运输单证、IMO 危险货物申报单或 IMDG 多式联运表格,以及 IATA 托运人申报单)、检查表、全尺寸或自定义小尺寸的货包标记,空运时还有空运单数据表。
  • 总托运货物:集拼舱单、集装箱清单、各单元的装箱单、按托运人分列的装载清单与主单据数据表。
  • 运输单元:集装箱/车辆装箱证明书、危险货物多式联运表格、单元隔离报告、签署证明书前的检查表与集拼标签。
  • 运输行程:危险货物舱单、船上单元间隔离报告、ADR 1.1.3.6 豁免限值报告、行程限制表、装载清单、机长通知单(NOTOC)与车辆合并运输单证。
  • 运单:草稿、已签署件、所附 ADR 运输单证与存证报告。

该 API 的校验内容

在托运货物层面。同车(船、机)运输货物之间的隔离要求、适用包装说明以及有限数量与例外数量制度的数量限值、货物对该运输方式的可运性、包装的合法性以及申报的完整性。若存在不符,返回内容会指明未满足的规则及相应数值,以便在贵方应用程序中展示。

在集拼层面。运输组件内部的隔离、同一行程中所装各组件之间的隔离、按 ADR 1.1.3.6 计算该行程限值并给出明细,以及以数据形式返回的行程限制,例如隧道限制代码或是否载有高危后果危险货物。

所涵盖的法规与运输方式

公路适用 ADR,海运适用 IMDG,空运适用 IATA,并涵盖 49 CFR。三大法规统一管理而非各自独立模块,因此更换运输方式的托运货物无须重新办理。

混合包装、集合包装、罐体、散装运输、空的未清洁包装、废物、第 1 类爆炸品(含每一货包的净爆炸物质量)以及第 7 类放射性物质均获支持,并附各自所需的数据项。单证文本可以十九种语言输出。

可用性

本服务在三个区域发布——欧洲、美洲与亚太——各有独立地址,使对接与账户所在区域相对应。基础设施采用冗余配置并接受全天候监控。

如何开始

申请为期两周的免费试用,并同时取得服务凭据。身份验证采用 OAuth 2.0 的「client credentials」方式:贵方系统获取访问令牌,并在每次请求中发送。

完整规范以 OpenAPI 格式发布,可在编写任何一行对接代码之前阅读、查阅,并据以生成贵方所用语言的客户端。

API 规范的各个部分

部分
概览API 及其使用限制的介绍,附规范的 OpenAPI 3.0 和 2.0 文件以及所有部分的索引。打开
身份验证以「client credentials」方式签发的 OAuth2 访问令牌,可在所有需要身份验证的操作中替代 HTTP Basic 身份验证。打开
连接检查检查 API 的可用性、API 用户的凭据,以及带身份验证与不带身份验证的请求。打开
主数据托运货物、产品与集拼所引用的危险货物与放射性核素、包装与包装说明、代码、国家与地点。打开
产品目录中的简单产品与混合包装产品,包括为托运货物以交互方式创建混合包装产品。打开
当事方预设的当事方:托运人、收货人、装货人、承运人、供应商与驾驶员。打开
车辆、挂车与船舶账户下的车辆、挂车与船舶,及其车辆牌照号、ADR 车辆类型与危险货物运输符合证书。打开
地点与限制账户下的港口、机场与场站,以及在此计划或装载运输组件时适用的限制。打开
托运货物创建包含全部内容(批量)或首项内容(交互)的托运货物,以及托运货物的查询与删除。打开
托运货物内容向以交互方式处理的托运货物添加或从中移除的产品、混合包装与集合包装。打开
托运货物单证托运货物的单证(运输单证、检查表、货包标记等)、通过电子邮件发送单证,以及冻结单证。打开
运单CMR 运单、电子运单(e-CMR)与国内运单,涵盖从检查路线是否属于 e-CMR 议定书适用范围,到签发、交付与作废的全过程。打开
拼箱请求客户账户或其安全顾问代为提交的拼箱请求,以及集拼方的决定。打开
总托运货物总托运货物及其所含托运货物与审批流程。打开
运输组件运输组件及其内容、隔离检查与移动记录。打开
运输与挂靠港站航次、航班与公路行程及其挂靠港站与运输组件、隔离检查、装载限值计算(ADR 1.1.3.6)与限制。打开
集拼单证总托运货物、运输组件与运输的单证。打开
Webhook账户的 Webhook 订阅、订阅测试及近期推送记录。打开

若要了解对接有多快捷简便,可免费试用两周,不附带任何义务