Convenções

Convenções

Padrões usados em todos os endpoints da API.

Formato

Todas as requisições e respostas usam JSON. Envie o cabeçalho Content-Type: application/json em qualquer requisição com corpo.

Resposta de sucesso

As respostas de sucesso seguem o formato padrão abaixo:

{
  "code": 200,
  "success": true,
  "data": { /* payload do endpoint */ }
}

Resposta de erro

Os erros retornam um objeto com a flag success em false e uma mensagem descritiva:

{
  "code": 400,
  "success": false,
  "error": "Mensagem explicando o problema"
}

Códigos comuns