A API do Paylog permite que um sistema autorizado consulte ou mantenha clientes, produtos, pacotes, pedidos, rastreamento e cotações de frete.
A versão estável usa o prefixo /api/v1 e autenticação por token no cabeçalho Authorization.
Vai desenvolver uma integração?
Comece em três etapas
- Consulte a introdução e os endpoints disponíveis.
- Crie um token de API no painel Paylog.
- Envie o token como
Bearernas requisições do seu sistema.
Authorization: Bearer SEU_TOKEN
Um token permite acesso à sua conta pela API. Nunca coloque a credencial em código público, aplicativos distribuídos ao cliente, tickets ou capturas de tela.
Referências disponíveis
A documentação técnica inclui:
- autenticação e convenções;
- clientes, produtos e pacotes;
- criação, consulta e rastreamento de pedidos;
- calculadora de frete;
- referência OpenAPI 3.1;
- Webhooks V2;
- recursos para agentes e ferramentas de desenvolvimento.
Consultar todos os recursos da API
Rastreamento e comprovante de entrega
O endpoint de rastreamento (GET /api/v1/pedidos/{id}/rastreamento) devolve a linha do tempo completa do envio e mais dois blocos úteis:
url_rastreamento— o link público de rastreamento do Paylog (https://ev.paylog.cash/rastreio/{codigo}). Funciona com qualquer transportadora, não pede login e mostra a linha do tempo junto com as imagens do comprovante. É o link para enviar ao seu cliente. A página da própria transportadora, quando existir, continua emurl_transportadora.comprovante_entrega— a foto da entrega, a imagem da assinatura, o nome de quem recebeu e o do signatário.
Cada transportadora envia um conjunto diferente. A J&T Express manda as duas imagens (foto e assinatura) mais o signatário; os Correios mandam só a foto do recibo. O objeto fica null até o primeiro comprovante ser capturado, o que costuma acontecer algumas horas depois da entrega. Trate cada campo como opcional.