Erros
Formato de resposta
Todos os erros devolvem um corpo JSON:
{
"error": {
"code": "validation_failed",
"message": "The given data was invalid.",
"details": {
"email": ["The email has already been taken."]
}
},
"request_id": "req_01HXXXXXX"
}
Inclua sempre o request_id quando contactar o suporte acerca de um erro.
Códigos de Estado HTTP
| Estado | Significado |
|---|---|
200 OK | Sucesso |
201 Created | Recurso criado |
400 Bad Request | Pedido mal formado |
401 Unauthorized | Token em falta ou inválido |
403 Forbidden | Token válido mas permissões insuficientes |
404 Not Found | Recurso não encontrado |
409 Conflict | Conflito (por exemplo, e-mail já utilizado) |
422 Unprocessable Entity | Validação falhou |
429 Too Many Requests | Limite de taxa excedido |
500 Internal Server Error | Erro no lado do servidor |
Códigos de erro
| Código | Descrição |
|---|---|
validation_failed | O corpo do pedido falhou na validação |
unauthorized | Token em falta ou expirado |
forbidden | Token não tem o âmbito necessário |
not_found | O recurso não existe |
conflict | Violação de restrição única |
rate_limited | Demasiados pedidos |
internal_error | Erro de servidor inesperado |