Skip to main content

Erros

A API Pública usa códigos HTTP padrão para indicar sucesso ou falha. Nas rotas documentadas aqui, há três formatos de erro: o padrão HTTP, o de validação e o de rate limit.

Formato padrão (4xx/5xx HTTP)

Para erros como 401, 403, 404, 400:

Formato de validação (422)

Quando headers, path params ou body estão inválidos:

Formato de rate limit (429)

Tabela de códigos

Exemplos por código

401 — API Key com formato incorreto

401 — API Key inválida ou revogada

403 — Plano sem acesso

422 — Header obrigatório ausente

404 — Recurso não encontrado

422 — Erro de validação

429 — Rate limit excedido

500 — Erro interno

Boas práticas de tratamento

Sempre verifique o código HTTP antes de processar a resposta. Implemente retry apenas para erros 429 e 5xx.
  1. 401/403: verifique se a API Key está correta e se a conta possui acesso à API pública
  2. 404: confirme que o ID existe e pertence à sua empresa
  3. 422: valide os dados antes de enviar; confira campos obrigatórios e formatos
  4. 429: implemente backoff exponencial; respeite Retry-After e X-RateLimit-Reset
  5. 500: tente novamente após alguns segundos; se persistir, entre em contato com o suporte