Hoe schakel ik een Cargoes Flow-client over naar Dockflow?

Hoe-te Q&A
1

Mijn klant gebruikt de Cargoes Flow tracking-API. Wat moet ik aanpassen om die op Dockflow te laten draaien?

Twee waarden:

  1. Wijzig de host. Een client die zijn eigen pad behoudt, kan https://api.dockflow.com/compat/cargoes-flow/flow/api/public_tracking/v1 gebruiken.
  2. Zet een Dockflow-API-sleutel in X-DPW-ApiKey. Maak de sleutel aan in de API Console met de scope Downstream. X-DPW-Org-Token wordt geaccepteerd en genegeerd.

Er bestaat geen openbare specificatie om tegen te testen, dus de eerste stap naar dit oppervlak verloopt samen met Dockflow, als validatie. Neem contact op met support om dit te plannen.

Een uitgewerkt voorbeeld, met een nep-sleutel:

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

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

Antwoord:

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

Rijen zijn alles of niets: één foutieve rij in formData betekent dat er niets wordt aangemaakt, en het antwoord is FAILED met errorDetail op HTTP 200.

Lees het met GET /shipments en shipmentNumber=DF74123. Voeg includeUniqueContainers=true toe voor één rij per doos. Emissies en wegtransport blijven leeg. Elke webhook-aflevering bevat een X-Dockflow-Signature-header.

Volledige veldmapping en de handtekeningcontrole: