Comment basculer un client Cargoes Flow vers Dockflow ?

Tutoriel « Questions-Réponses »
1

Mon client appelle l’API de suivi Cargoes Flow. Que dois-je modifier pour l’exécuter sur Dockflow ?

Deux valeurs :

  1. Changez l’hôte. Un client qui conserve son propre chemin peut utiliser https://api.dockflow.com/compat/cargoes-flow/flow/api/public_tracking/v1
  2. Placez une clé API Dockflow dans X-DPW-ApiKey. Créez la clé dans la console API avec le scope Downstream. X-DPW-Org-Token est accepté et ignoré.

Aucune spécification publique n’existe pour tester, donc le premier passage vers cette interface se fait avec Dockflow, à titre de validation. Contactez le support pour le planifier.

Un exemple concret, avec une fausse clé :

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

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

Réponse :

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

Les lignes sont tout ou rien : une seule ligne invalide dans formData signifie que rien n’est créé, et la réponse est FAILED avec errorDetail sur HTTP 200.

Lisez-la avec GET /shipments et shipmentNumber=DF74123. Ajoutez includeUniqueContainers=true pour une ligne par conteneur. Les émissions et les trajets routiers restent vides. Chaque livraison de webhook porte un en-tête X-Dockflow-Signature.

Correspondance complète des champs et vérification de la signature :