Início Rápido
Três passos para sua primeira chamada à API.
1. Gere sua chave de API
Acesse o Dashboard → Chaves de API e clique em Gerar nova chave. A chave começa com sr_live_ e só aparece uma vez — copie e guarde com cuidado.
2. Faça sua primeira chamada
Rastreie uma encomenda dos Correios:
curl -H "Authorization: Bearer sr_live_sua_chave_aqui" \
"https://seurastreio.com.br/api/public/rastreio/BR123456789BR"Ou consulte um CEP:
curl -H "Authorization: Bearer sr_live_sua_chave_aqui" \
"https://seurastreio.com.br/api/public/cep/02037001"3. Leia a resposta
Todas as respostas são JSON. As de sucesso incluem success: true; as de erro trazem message em português e (quando aplicável) helpUrl.
{
"codigo": "BR123456789BR",
"status": "found",
"success": true,
"eventoMaisRecente": {
"descricao": "Objeto entregue ao destinatário",
"data": "2026-01-15T14:30:00.000Z",
"local": "São Paulo/SP"
},
"linkDetalhesCompletos": "https://seurastreio.com.br/objetos/BR123456789BR"
}Testes interativos
Para experimentar sem código, gere uma chave no dashboard e use ferramentas como curl, httpie ou Postman. A chave funciona em produção e em ambiente local.