Erros e respostas

A API usa códigos HTTP convencionais para indicar o resultado de cada requisição.

Códigos de resposta

CódigoSignificadoO que fazer
200Sucesso
401Não autenticadoConfira se o header se chama exatamente API-KEY
404Recurso não encontradoConfirme que está usando o ID público encriptado retornado pela API, não o código numérico interno

Estrutura das respostas de sucesso

Listagens retornam um array em data + paginação em meta:

{ "data": [ ... ], "meta": { "current_page": 1, "total": 100 } }

Detalhes (/recurso/{id}) retornam o objeto direto em data:

{ "data": { "id": "epz7Z...", ... } }

Dicas de tratamento

  • Trate 401 como erro de configuração (chave/ambiente) — repetir a chamada não resolve. Alerte e interrompa.
  • Trate 404 como dado inexistente ou ID incorreto — valide a origem do ID antes de retentar.
  • Sempre envie o header Accept: application/json.
📘

Recebendo 401 mesmo com a chave certa? Verifique se não está usando uma chave de desenvolvimento contra a URL de produção (ou vice-versa). Veja Ambientes.



Did this page help you?