Mein Kunde ruft die Cargoes Flow Tracking API auf. Was muss ich ändern, um sie auf Dockflow laufen zu lassen?
Zwei Werte:
- Ändere den Host. Ein Client, der seinen eigenen Pfad beibehält, kann https://api.dockflow.com/compat/cargoes-flow/flow/api/public_tracking/v1 verwenden.
- Trage einen Dockflow-API-Schlüssel in X-DPW-ApiKey ein. Erstelle den Schlüssel in der API Console mit dem Scope Downstream. X-DPW-Org-Token wird akzeptiert und ignoriert.
Es gibt keine öffentliche Spezifikation, gegen die man testen könnte, daher erfolgt der erste Umstieg auf diese Oberfläche gemeinsam mit Dockflow als Validierung. Wende dich an den Support, um ihn zu planen.
Ein durchgespieltes Beispiel mit einem Fake-Schlüssel:
POST /compat/cargoes-flow/createShipments
X-DPW-ApiKey: prod_acme_FAKE-TOKEN
{"uploadType":"FORM_BY_MBL_NUMBER","formData":[{"mblNumber":"MB-4471","oceanLine":"MAEU"}]}
Antwort:
{"result":"SUCCESS","errorDetail":[],
"shipments":[{"shipmentNumber":"DF74123","mblNumber":"MB-4471","created":true}]}
Zeilen gelten nach dem Alles-oder-nichts-Prinzip: Eine fehlerhafte Zeile in formData bedeutet, dass nichts angelegt wird, und die Antwort lautet FAILED mit errorDetail bei HTTP 200.
Lies sie mit GET /shipments und shipmentNumber=DF74123 aus. Füge includeUniqueContainers=true hinzu, um eine Zeile pro Container zu erhalten. Emissions und Road Legs bleiben leer. Jede Webhook-Zustellung enthält einen X-Dockflow-Signature-Header.
Vollständige Feldzuordnung und die Signaturprüfung: