Erros e Códigos HTTP
A API usa códigos HTTP convencionais para indicar sucesso ou falha.
Códigos de status
| Código | Significado |
|---|---|
| 200 | Sucesso |
| 201 | Criado com sucesso |
| 400 | Dados inválidos — verifique o body da requisição |
| 401 | Não autenticado — API Key ausente ou inválida |
| 403 | Sem permissão — escopo insuficiente |
| 404 | Recurso não encontrado |
| 409 | Conflito — recurso já existe |
| 429 | Rate limit excedido — aguarde e tente novamente |
| 500 | Erro interno do servidor |
Formato do erro
Todas as respostas de erro seguem o mesmo formato:
Resposta de erro
{
"error": "Mensagem descritiva do erro"
}Exemplo: chave inválida
401 Unauthorized
{
"error": "Invalid or missing API key"
}Exemplo: escopo insuficiente
403 Forbidden
{
"error": "Missing required scope: read:orders"
}