如何将 Cargoes Flow 客户端切换到 Dockflow？

操作指南问答
1

我的客户要调用 Cargoes Flow 的追踪 API。要把它迁移到 Dockflow 上运行，我需要改什么？

两处值：

  1. 修改主机地址。如果客户端保留自己的路径，可以使用 https://api.dockflow.com/compat/cargoes-flow/flow/api/public_tracking/v1
  2. 将 Dockflow API 密钥填入 X-DPW-ApiKey。在 API Console 中创建密钥，并选择 Downstream 作用域。X-DPW-Org-Token 会被接受但会被忽略。

目前没有公开规范可供对照测试，因此首次迁移到这个接口时的运行需要与 Dockflow 一起进行，作为验证。请联系支持团队来安排。

下面是一个示例，使用假密钥：

POST /compat/cargoes-flow/createShipments
X-DPW-ApiKey: prod_acme_FAKE-TOKEN

{"uploadType":"FORM_BY_MBL_NUMBER","formData":[{"mblNumber":"MB-4471","oceanLine":"MAEU"}]}

响应：

{"result":"SUCCESS","errorDetail":[],
 "shipments":[{"shipmentNumber":"DF74123","mblNumber":"MB-4471","created":true}]}

所有行要么全部成功，要么全部失败：formData 中只要有一行出错，就不会创建任何内容，响应为 FAILED，错误详情放在 HTTP 200 响应中。

用 GET /shipments 和 shipmentNumber=DF74123 读取。添加 includeUniqueContainers=true 可以按箱返回单行。排放和公路运输段保持为空。每次 webhook 投递都会带上一个 X-Dockflow-Signature 响应头。

完整字段映射和签名校验：