Octalog
  1. ⏪ Transportadoras e Parceiros
  • 🎯Integração Octalog
  • ⏩ Clientes e Embarcadores
    • 🎯 Visão Geral Clientes e Embarcadores
    • Retorno de tracking, API do Cliente (webhook)
      • Exemplo do Retorno de Tracking
      • Configuração para Recebimento do Tracking
      • Consultar sua configuração do Webhook
    • Envio de Pedidos para Octalog
    • Cancelamento de Pedido
  • ⏪ Transportadoras e Parceiros
    • 🎯 Visão Geral Transportadoras e Parceiros
    • Exemplo do pedido enviado pelo Octalog
      POST
    • Configuração da API da Transportadora para receber pedidos
      POST
    • Consultar a configuração para recebimento de pedidos na API da transportadora
      GET
    • Atualização de Tracking do Pedido
      POST
  • TOKEN - Autenticação de Acesso à API
    POST
  • Prazo de Entrega
    GET
  • Status do Pedido
    GET
  1. ⏪ Transportadoras e Parceiros

🎯 Visão Geral Transportadoras e Parceiros

A integração é dividida por duas etapas principais:#

1.
Envio dos pedidos do Octalog para Transportadora;
2.
Retorno dos eventos de rastreamento (Tracking) da transportadora para o Octalog.
Todos os endpoints da API exigem o envio de um Token de Autenticação no Header da requisição.
Todas as datas no horário de Brasilia

Header Obrigatório#

Autenticação#

Para consumir a API é necessário obter um Token de Acesso.
As credenciais (usuário e senha) são fornecidas pelo Octalog. Caso ainda não as possua, solicite-as através dos canais de atendimento.
Utilize o endpoint TOKEN - Autenticação de Acesso à API para gerar o Token que deverá ser enviado em todas as requisições autenticadas.
Importante: O Token possui prazo de validade. Após sua expiração, será necessário gerar um novo Token utilizando novamente o endpoint de autenticação.

Envio de Pedidos#

Os pedidos serão enviados pelo Octalog.
Para receber os pedidos, a Transportadora deverá disponibilizar um endpoint HTTP público capaz de receber as requisições enviadas pelo Octalog.
Após disponibilizar o endpoint, sua URL deverá ser configurada no Octalog através do endpoint Configuração da API da Transportadora para receber pedidos.

Funcionamento#

Cada chamada do Webhook poderá conter:
um único pedido; ou
vários pedidos em uma única requisição (lote).
O processamento dos pedidos é de responsabilidade da Transportadora. Recomenda-se que cada pedido seja processado individualmente, mesmo quando recebido em lote.

Campos Importantes#

Pedido#

O pedido e CNPJ do remetente é único no Octalog. Este identificador deverá ser utilizado em todas as atualizações de rastreamento enviadas posteriormente.

TotalVolumes#

Quantidade total de volumes pertencentes ao pedido. A operação realiza rastreamento por volume, este campo deverá ser considerado durante todo o processo logístico.

IDPrazoEntrega#

Identificador do prazo de entrega contratado para o pedido. Prazo de Entrega

DadosFiscais#

Contém os dados fiscais da operação. Essas informações poderão ser utilizadas pela Transportadora na emissão de documentos fiscais, quando aplicável.

Configuração do Webhook#

O endpoint de configuração permite informar ao Octalog como os pedidos deverão ser enviados.
Durante a configuração deverão ser informados:
URL: Endpoint responsável pelo recebimento dos pedidos;
LimiteEnvio: Quantidade máxima de pedidos enviados por requisição;
Headers: Cabeçalhos personalizados que deverão acompanhar todas as requisições.
Importante: Os Headers personalizados não são validados pelo Octalog. Eles serão encaminhados exatamente conforme configurados, podendo ser utilizados pela Transportadora para autenticação ou outras validações.

Envio de Tracking#

Após o processamento do pedido, a Transportadora deverá informar ao Octalog todas as movimentações logísticas através do endpoint Atualização de Tracking do Pedido.
Cada requisição poderá conter até 50 eventos de rastreamento.

Recomendações#

Envie os eventos em ordem cronológica.
Não envie o mesmo evento mais de uma vez.
Envie os eventos imediatamente após sua ocorrência, sempre que possível.
O rastreamento seja realizado por volume, informe corretamente a identificação do volume correspondente.

Campos Importantes#

Pedido#

Identificador do pedido recebido no Webhook.

Volume#

Identificador do volume ao qual o evento pertence, quando aplicável.

Status#

Código do status logístico correspondente ao evento.
A relação completa dos status aceitos pode ser consultada no endpoint Status do Pedido.

DataEvento#

Data e hora em que o evento ocorreu.
É recomendado utilizar a data e hora reais da ocorrência do evento.

Fluxo da Integração#

O fluxo recomendado para integração é o seguinte:
1.
Autenticar utilizando o endpoint de Autenticação;
2.
Receber o Token de Acesso;
3.
Configurar o endpoint de Webhook para recebimento dos pedidos;
4.
O Octalog envia os pedidos para a Transportadora;
5.
A Transportadora recebe e processa os pedidos;
6.
Conforme os eventos logísticos ocorrerem, a Transportadora envia os eventos de Tracking ao Octalog;
7.
O Octalog disponibiliza essas atualizações aos embarcadores e demais sistemas integrados.
Página anterior
Cancelamento de Pedido
Próxima página
Exemplo do pedido enviado pelo Octalog
Built with