Respostas e erros¶
Resposta de sucesso¶
Uma operação simples retorna:
{
"success": true,
"data": {}
}
Listagens retornam data como array e os metadados em pagination.
Resposta de erro¶
Erros seguem este formato:
{
"success": false,
"error": {
"code": "VALIDATION_ERROR",
"message": "Validation failed",
"details": []
}
}
Os códigos HTTP mais comuns são:
| Status | Significado |
|---|---|
400 |
Request inválido, schema estrito ou regra de negócio rejeitada |
401 |
Token ausente, inválido, expirado ou sessão revogada |
403 |
Usuário autenticado sem permissão para a operação |
404 |
Recurso inexistente ou fora do escopo do clube |
409 |
Conflito de estado ou duplicidade |
429 |
Limite de requisições atingido |
502 |
Falha na comunicação com um provedor externo |
Requests com campos desconhecidos devem ser corrigidos pelo cliente; não envie propriedades extras esperando que sejam ignoradas.