Cargoes FlowクライアントをDockflowに切り替えるには？

ハウツーQ&A
1

私のクライアントはCargoes Flowの追跡APIを呼び出しています。Dockflowで実行するには何を変更すればよいですか？

2つの値です：

  1. ホストを変更します。自前のパスを維持するクライアントは、https://api.dockflow.com/compat/cargoes-flow/flow/api/public_tracking/v1 を使用できます。
  2. DockflowのAPIキーをX-DPW-ApiKeyに設定します。APIコンソールで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内の1行でも不正があれば何も作成されず、応答はFAILEDとなり、errorDetailがHTTP 200で返されます。

GET /shipments と shipmentNumber=DF74123 で読み取ります。コンテナごとに1行にするには includeUniqueContainers=true を追加してください。排出量と陸送区間は空のままです。各webhook配信にはX-Dockflow-Signatureヘッダーが付与されます。

フィールドマッピングの詳細と署名検証：