Documentação da API
API REST para rastreamento de encomendas (Correios e Total Express), consulta de CEP e logística reversa. Autenticação via chave de API gratuita.
Prefere passo a passo e resumos para integração? Acesse os guias (como fazer) — o conteúdo aponta para esta documentação como referência técnica.
Rastreamento
Eventos atualizados de encomendas. Detecta Correios e Total Express automaticamente.
CEP
Consulta de endereço via código postal brasileiro.
Logística Reversa
Crie e acompanhe coletas reversas dos Correios via API.
Autenticação
Todas as rotas em /api/public/* exigem uma chave de API enviada no header Authorization:
Authorization: Bearer sr_live_sua_chave_aquiGere uma chave gratuita no Dashboard → Chaves de API. Sem chave válida a API responde 401 com helpUrl apontando para o dashboard.
Características
- CORS habilitado — chame de qualquer domínio.
- Rate limit — 60 requisições por minuto por IP.
- Respostas em cache — rastreios cacheados por 10min, CEP por 1h.
- Limite mensal por plano — rastreios e logística reversa têm cota mensal por time. Quando atingida a API responde
429comcurrentemax.
Transportadoras suportadas
Correios
SEDEX, PAC e todas as modalidades.
AA123456789BRTotal Express
Rastreamento via API.
TXAQ187563341txA transportadora é detectada automaticamente pelo formato do código.
Próximo passo: veja o guia de início rápido com chamadas prontas para colar no terminal.