Guia
Início rápido: primeira chamada à API pública do Seu Rastreio
Para quem lidera a operação e quem implementa a integração.
A API pública liga o seu e-commerce, ERP e automações ao rastreio, CEP e demais recursos com uma chave de API — tudo isso de forma previsível para o negócio (contrato e orçamento) e para a tecnologia (HTTP, autenticação, erros com mensagem clara). O desenho é simples: (1) gerar a chave no Dashboard → Chaves de API (o valor costuma começar com `sr_live_` e só é mostrado na criação — armazene em cofre de segredos e em gestão de acessos), (2) enviar um GET de prova a `/api/public/rastreio/{código}` ou `/api/public/cep/{cep}` com o header `Authorization: Bearer`, e (3) ler o JSON de sucesso ou a mensagem de falha, como em /api-docs/inicio-rapido.
A chave não publica no front-end aberto, não vaza em repositório e não circula no WhatsApp. Integração sólida acontece no back-end ou em ferramentas aprovadas.
Três passos para a primeira resposta 200
- Gerar a chave de API. No painel: Chaves de API → nova chave, copie o prefixo sr_live_ e trate como segredo.
- Fazer o GET de teste. Use curl, Postman ou o cliente do time com Authorization: Bearer e rastreio ou CEP, seguindo os exemplos oficiais.
- Ler a resposta. Em sucesso, valide o JSON; em falha, use message e helpUrl, quando houver, para ajuste rápido.
Depois do primeiro 200, qual o desenho típico
A mesma chave abre os recursos publicados em /api-docs: rastreio (histórico conforme plano), CEP, pedidos, logística reversa (quando contratada), webhooks e tudo o que a doc do produto exibir. Cotas, códigos HTTP e tabelas de resposta vivem em cada rota; em dúvida de escala ou módulo, abra o canal comercial em /contato.
Perguntas frequentes
Dúvidas comuns de quem coloca a integração em produção.
- Dá para homologar sem plano pago completo?
- Planos e o que exige o contrato de cada módulo estão em /planos. Cada rota de /api-docs indica o que depende de recursos premium (por exemplo, histórico de rastreio). Crie a chave no painel e alinhe com a mesa o que a mesa paga hoje.
Próximo passo: documentação oficial
Parâmetros, tabelas de resposta, limites e exemplos em código — tudo na referência de API pública.
Atualizado em 23/04/2026