Hoe laat ik een ShipsGo v2-client naar Dockflow wijzen zonder hem te herschrijven?

Hoe-te Q&A
1

Ik heb een client gebouwd voor de ShipsGo v2 ocean API. Kan die op Dockflow draaien met dezelfde paden en bodies?

Ja. Wijzig twee waarden:

  1. Stel de base-URL in op https://api.dockflow.com/compat/shipsgo/v2
  2. Zet een Dockflow API-sleutel in X-Shipsgo-User-Token. Maak de sleutel aan in de API Console met de scope Downstream.

Een uitgewerkt voorbeeld, met een nep-token. Maak een zending aan:

POST /compat/shipsgo/v2/ocean/shipments
X-Shipsgo-User-Token: prod_acme_FAKE-TOKEN

{"reference":"PO-5521","booking_number":"BK-7741"}

Het antwoord bevat het zending-id. Lees het terug met dat id. Dit antwoord is ingekort:

GET /compat/shipsgo/v2/ocean/shipments/74123

{"message":"SUCCESS","shipment":{"id":74123,
 "reference":"PO-5521","booking_number":"BK-7741",
 "status":"BOOKED"}}

Drie dingen verschillen. Lijstfilters anders dan id en containernummer worden geweigerd, followers en tags blijven leeg, en luchtvaartroutes worden niet ondersteund. De lijst is gesorteerd op laatste wijziging, oudste eerst, en elke order_by wordt geweigerd. Totdat de import is uitgevoerd, toont een uitlezing alleen het nummer dat je hebt verstuurd. Webhook-bestemmingen worden toegevoegd door Dockflow support, en elke levering bevat een X-Shipsgo-Webhook-Signature.

Volledige veldmapping en de handtekeningcontrole: