Skip to main content

Tratamento de Erros

A API utiliza códigos de status HTTP padrão e retorna corpos de erro JSON consistentes para todos os casos de falha.

Códigos de status HTTP


Corpo da resposta de erro

Todas as respostas de erro retornam um corpo JSON com success: false. A estrutura varia conforme o tipo de erro.

Erro de validação (422)

O objeto errors mapeia nomes de campos para um array de mensagens legíveis.

Erro de autenticação (401)

Não encontrado (404)

Erro genérico do servidor (500)


Tratando erros no código


Erros comuns

Retorna 401 ou 404 dependendo do endpoint. Sempre inclua X-Tenant nos endpoints de recursos.
Ao criar um certificado, o file_uuid deve referenciar um arquivo que ainda não foi vinculado a outro certificado. Uma vez que um arquivo é utilizado, ele não pode ser reutilizado.
Todos os campos UUID devem estar no formato padrão v4: 550e8400-e29b-41d4-a716-446655440000. Passar um inteiro onde um UUID é esperado retorna 422.
Se você passar um course_uuid ou student_uuid que pertence a um tenant diferente, a API retorna 422 com "The selected ... is invalid." — a busca de entidades é sempre filtrada por tenant.