Acessar a documentação da API para integrar uma nova transportadora na plataforma da Abbiamo

Modificado em Sex, 11 Jul, 2025 na (o) 1:06 PM

OBJETIVO

Este artigo tem como objetivo explicar como acessar a documentação técnica da API da Abbiamo para iniciar o processo de integração de uma nova transportadora. O material é público e pode ser consultado a qualquer momento pela equipe técnica da transportadora.

PASSO A PASSO

1. Solicite a integração da transportadora

O primeiro passo é formalizar a solicitação de integração junto à equipe da Abbiamo, informando os dados operacionais, tipo de transporte e escopo logístico da nova transportadora.

2. Acesse a documentação pública da API

A documentação oficial da API da Abbiamo está disponível publicamente no link abaixo:
https://abbiamo.readme.io/reference/welcome-carrier
Esse material poderá ser acessado a qualquer momento para análise prévia pela equipe técnica da transportadora, mesmo antes da homologação oficial.

3. Explore os conteúdos técnicos disponíveis

Na documentação, a transportadora encontrará:
Endpoints da API (coleta, tracking, cancelamento, devolução, entre outros).
Formato dos payloads (JSON) e headers obrigatórios.
Detalhamento dos eventos de tracking.
Especificações técnicas para autenticação (Bearer Token).
Estrutura esperada de Webhooks.
Exemplos de chamadas e respostas.

4. Inicie o desenvolvimento técnico

Com base na documentação, a transportadora pode iniciar a implementação técnica internamente, adiantando etapas importantes antes da homologação.

5. Aguarde a aprovação e liberação do ambiente de homologação

Após a solicitação formal e análise da Abbiamo, a transportadora receberá:
Token de acesso exclusivo para o ambiente de testes.
URL da sandbox.
Orientações específicas para executar os testes simulados.

6. Siga os fluxos obrigatórios definidos para homologação

Além da documentação; Abbiamo fornecerá um guia complementar com os testes obrigatórios:

Cenários Obrigatórios a serem simulados:

Criação de entrega e status inicial.
Saída para entrega (start-delivery).
Entrega realizada com sucesso (successful).
Falha na Entrega (failed-to-deliver).
Pedido devolvido (returned).
Cancelamento antes da coleta (canceled).
Atualização de destinatário (order_receiver_update).

Considerações Finais:

A previsão de conclusão da integração é de 30 dias corridos, contados a partir da criação do ambiente de teste.
Durante esse período, o time técnico da Abbiamo estará alocado exclusivamente nessa frente.
ATENÇÃO: Atrasos podem comprometer a prioridade da sua transportadora na fila de homologação.
Recomendamos atenção especial ao cronograma.
A documentação da API pode ser consultada livremente em qualquer momento, antes ou durante o processo de integração.
A homologação técnica é obrigatória para que a transportadora opere no ambiente de produção.
O domínio dos fluxos e estrutura dos dados é essencial para uma integração bem sucedida.