Octalog
  1. ⏩ Clientes e Embarcadores
  • 🎯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
      POST
    • Cancelamento de Pedido
      POST
  • ⏪ Transportadoras e Parceiros
    • 🎯 Visão Geral Transportadoras e Parceiros
    • Exemplo do pedido enviado pelo Octalog
    • Configuração da API da Transportadora para receber pedidos
    • Consultar a configuração para recebimento de pedidos na API da transportadora
    • Atualização de Tracking do Pedido
  • TOKEN - Autenticação de Acesso à API
    POST
  • Prazo de Entrega
    GET
  • Status do Pedido
    GET
  1. ⏩ Clientes e Embarcadores

🎯 Visão Geral Clientes e Embarcadores

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

1.
Envio dos pedidos para o Octalog;
2.
Recebimento dos eventos de rastreamento (Tracking).
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
token: {TOKEN_DE_ACESSO}

Autenticação#

Para utilizar 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.
Com essas credenciais, utilize o TOKEN - Autenticação de Acesso à API para gerar o Token que deverá ser enviado em todas as chamadas da API.
Importante: O Token possui prazo de expiração. Quando expirado, um novo Token deverá ser obtido através do Endpoint de Autenticação.

Envio de Pedidos#

Os pedidos devem ser enviados ao Octalog somente após o faturamento.
O envio antecipado pode gerar solicitações de coleta para pedidos que ainda não estão prontos para expedição.
Utilize o Envio de Pedidos para Octalog para transmitir as informações.

Recomendações#

É possível enviar um ou vários pedidos em uma única requisição.
O processamento é feito individualmente para cada pedido enviado.

Campos importantes#

IDPrazoEntrega
Informe um identificador válido de prazo de entrega. Os valores disponíveis podem ser consultados no Prazo de Entrega.
TotalVolumes
Informe a quantidade total de volumes do pedido. Este campo é utilizado para identificar corretamente cada volume durante todo o processo logístico.
DadosFiscais
O preenchimento não é obrigatório para todas as operações. Entretanto, é necessário quando houver emissão de CT-e.

Fluxo de Envio#

O fluxo recomendado é o seguinte:
1.
Autenticar utilizando o Endpoint de Autenticação.
2.
Receber o Token de Acesso.
3.
Enviar os pedidos utilizando o Endpoint de Envio de Pedidos.
4.
Cada requisição pode conter desde até 50 pedidos, conforme a necessidade da integração.

Retorno de Tracking#

Os eventos de rastreamento são enviados pelo Octalog através de Webhook.
Para receber essas informações, sua aplicação deverá disponibilizar um endpoint HTTP público capaz de receber as notificações enviadas pelo Octalog.
A documentação dos Webhooks encontra-se na seção Envio de Pedidos para Octalog.

Exemplo de envio#

Cada chamada do Webhook poderá conter:
um único evento de rastreamento; ou
vários eventos (lote), reduzindo a quantidade de requisições realizadas.
Após disponibilizar o endpoint de recebimento, ele deverá ser configurado no ambiente do Octalog.

Configuração do Webhook#

O Endpoint de Configuração do Webhook permite definir como os eventos de rastreamento serão enviados.
Durante a configuração deverão ser informados:
URL: responsável por receber os eventos;
LimiteEnvio: Quantidade máxima de eventos enviados por requisição;
DataInicioEnvio: Data inicial para envio dos eventos (evitando o processamento de eventos antigos);
Headers personalizados que deverão acompanhar todas as requisições.
Os Headers configurados não são validados pelo Octalog. Eles são apenas encaminhados exatamente como configurados para a API do cliente.
Também é possível definir quais status de pedidos deverão gerar notificações.
A relação completa dos status disponíveis pode ser consultada no Status do Pedido.
Página anterior
🎯Integração Octalog
Próxima página
Exemplo do Retorno de Tracking
Built with