Como mudo um cliente Cargoes Flow para o Dockflow?

Perguntas e respostas de instruções
1

Meu cliente chama a API de rastreamento Cargoes Flow. O que eu altero para executá-la no Dockflow?

Dois valores:

  1. Altere o host. Um cliente que mantém seu próprio caminho pode usar https://api.dockflow.com/compat/cargoes-flow/flow/api/public_tracking/v1
  2. Coloque uma chave de API do Dockflow em X-DPW-ApiKey. Crie a chave no Console de API com o escopo Downstream. X-DPW-Org-Token é aceito e ignorado.

Não existe especificação pública para testar, então a primeira migração para esta superfície é feita em conjunto com o Dockflow, como validação. Entre em contato com o suporte para planejá-la.

Um exemplo prático, com uma chave fictícia:

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

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

Resposta:

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

As linhas são tudo ou nada: uma linha inválida em formData significa que nada é criado, e a resposta é FAILED com errorDetail em HTTP 200.

Consulte com GET /shipments e shipmentNumber=DF74123. Adicione includeUniqueContainers=true para uma linha por contêiner. Emissões e trechos rodoviários permanecem vazios. Cada entrega de webhook carrega um cabeçalho X-Dockflow-Signature.

Mapeamento completo de campos e a verificação de assinatura: