Erros Comuns

Introdução

Utilizamos códigos HTTP para distinguir entre requisições realizadas com sucesso e aquelas que apresentam falhas. Cada erro é acompanhado por um tipo, uma mensagem e uma descrição detalhada.

Erros de categoria 4xx indicam problemas relacionados à entrada de dados incorretos ou insuficientes.

Erros de categoria 5xx sinalizam problemas internos do serviço.

Segue uma lista exemplar de códigos e mensagens de erro que podem ser encontrados ao utilizar nossa API.

HTTP Code: 400

{
  "erros": {
    "type": "VALIDATION_ERROR",
    "message": "Não foi possível executar a operação.",
    "description": "Ocorreu um erro ao validar os dados recebidos."
  }
}

HTTP Code: 400

{
  "erros": {
    "type": "MISSING-REQUIRED_FIELD_ERROR",
    "message": "Não foi possível executar a operação.",
    "description": "Nenhum dado foi informado na requisição."
  }
}

HTTP Code: 400

{
  "erros": {
    "type": "UNKNOWN_ERROR",
    "message": "Não foi possível executar a operação.",
    "description": "Ocorreu um erro inesperado."
  }
}

HTTP Code: 401

{
  "erros": {
    "type": "UNAUTHORIZED",
    "message": "Não autorizado.",
    "description": "Verifique credenciais."
  }
}

HTTP Code: 403

{
  "erros": {
    "type": "FORBIDDEN",
    "message": "Não permitido.",
    "description": "Consulte o administrador."
  }
}

HTTP Code: 404

{
  "erros": {
    "type": "NOT_FOUND",
    "message": "Não encontrado.",
    "description": "Verifique endpoint ou ID."
  }
}

HTTP Code: 429

{
  "erros": {
    "type": "TOO_MANY_REQUESTS",
    "message": "Limite atingido.",
    "description": "Aguarde e tente novamente."
  }
}

HTTP Code: 500

{
  "erros": {
    "type": "SERVER_ERROR",
    "message": "Erro interno.",
    "description": "Tente mais tarde."
  }
}

Para testes e maiores informações acesse nosso repositório no Postman. SNDesk Postman