API Reference

⚠️ Erros Comuns

A API Pública retorna erros em formato JSON, com o código de status HTTP correspondente. Abaixo estão os erros mais comuns e como tratá-los.


🔑 Erros de autenticação

CódigoErroCausa comum
401 UnauthorizedInvalid tokenO token está incorreto
403 ForbiddenAPI token not configuredA plataforma ainda não gerou um token no painel administrativo.
401 UnauthorizedAPI token is requiredO cabeçalho Authorization não foi enviado.

🧍‍♂️ Erros de usuário

CódigoErroCausa comum
422 Unprocessable Entityemail already takenJá existe um usuário com esse e-mail.
422 Unprocessable Entityphone is invalidNúmero de telefone fora do padrão aceito.
422 Unprocessable EntityThere is no user with the provided emailTentativa de deletar ou inscrever um usuário que não existe.

🧾 Erros de inscrição

CódigoErroCausa comum
422 Unprocessable Entitygroup_id does not existO grupo informado não foi encontrado no banco de dados.
422 Unprocessable Entityemail is requiredCampo obrigatório não informado.

💬 Formato dos erros

Todos os erros retornam o seguinte formato:

{
  "message": "Descrição do erro"
}

✅ Dicas para evitar erros

  • Verifique se o token foi adicionado corretamente no cabeçalho.
  • Use um e-mail válido e já cadastrado na plataforma.
  • Confira se o group_id realmente existe antes de enviar.
  • Utilize um JSON válido com todos os campos obrigatórios.