Skip to main content

Tratamento de Erros

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

Códigos de estado HTTP


Corpo da resposta de erro

Todas as respostas de erro devolvem um corpo JSON com success: false. A estrutura varia consoante 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

Devolve 401 ou 404 dependendo do endpoint. Inclua sempre X-Tenant nos endpoints de recursos.
Ao criar um certificado, o file_uuid deve referenciar um ficheiro que ainda não foi associado a outro certificado. Uma vez que um ficheiro é utilizado, 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 devolve 422.
Se passar um course_uuid ou student_uuid que pertence a um tenant diferente, a API devolve 422 com "The selected ... is invalid." — a procura de entidades é sempre filtrada por tenant.