¿Cómo cambio un cliente de Cargoes Flow a Dockflow?

Preguntas y respuestas prácticas
1

Mi cliente llama a la API de seguimiento Cargoes Flow. ¿Qué tengo que cambiar para que funcione en Dockflow?

Dos valores:

  1. Cambia el host. Un cliente que conserva su propia ruta puede usar https://api.dockflow.com/compat/cargoes-flow/flow/api/public_tracking/v1
  2. Coloca una clave de API de Dockflow en X-DPW-ApiKey. Crea la clave en la API Console con el alcance Downstream. X-DPW-Org-Token se acepta y se ignora.

No existe una especificación pública contra la que probar, así que el primer paso a esta superficie se ejecuta junto con Dockflow, a modo de validación. Contacta con soporte para planificarlo.

Un caso resuelto, con una clave falsa:

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

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

Respuesta:

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

Las filas son todo o nada: una fila incorrecta en formData significa que no se crea nada, y la respuesta es FAILED con errorDetail en HTTP 200.

Consúltalo con GET /shipments y shipmentNumber=DF74123. Añade includeUniqueContainers=true para obtener una fila por caja. Las emisiones y los tramos por carretera quedan vacíos. Cada entrega de webhook incluye una cabecera X-Dockflow-Signature.

Mapeo completo de campos y la verificación de la firma: