12 Erros catalogados
Erros compartilhados entre diferentes endpoints para tratar situações de forma padronizada.
| Campo | Mensagem | Causas | Código Http |
| Requisição | A requisição contém dados inválidos ou incompletos. | A requisição enviada possui dados inválidos ou está incompleta, o que impossibilita o processamento correto pelo sistema. | 400 – Bad Request |
| O usuário não tem acesso a este metodo, realize a autenticação novamente, caso persista verifique com seu administrador. | O grupo atribuído ao usuário não possui permissão para acessar este método, impossibilitando a execução da operação, em casos de atualização de permissão é necessário autenticar novamente. | 401 – Unauthorized | |
| O limite de requisições por minuto foi atingido. Aguarde um momento antes de tentar novamente. | Ocorre quando o limite de requisições simultâneas ou por intervalo de tempo definido foi alcançado, resultando em um bloqueio temporário para evitar sobrecarga no sistema. Aguarde o intervalo necessário antes de tentar novamente. | 429 – Too Many Requests | |
| Parâmetros | Um ou mais valores estão vazios ou nulos. | Um ou mais valores obrigatórios não foram fornecidos ou estão nulos, o que impede o processamento da requisição. Verifique os campos obrigatórios esperados pelo método. | 400 – Bad Request |
| Token | Token não encontrado, verifique o envio no Headers. | O token de autenticação não foi encontrado no cabeçalho X-Auth-Token da requisição, o que impede a validação da autorização para acessar o recurso. | 401 – Unauthorized |
| Token inválido, realize uma nova autenticação e tente novamente. | O token fornecido na requisição está inválido, podendo estar malformado, corrompido ou não corresponder a um token válido para a integração. Certifique-se de que o token está correto e, se necessário, gere um novo e tente novamente. | 401 – Unauthorized | |
| Token expirado. Realize a autenticação novamente. | O token enviado na requisição está expirado. O sistema define uma duração padrão de 8 horas para tokens ativos, mas a variação de fusos horários em diferentes regiões do Brasil pode influenciar a percepção exata do tempo de expiração. Para continuar, realize uma nova autenticação e obtenha um novo token. | 401 – Unauthorized | |
| Plano | O plano está expirado. Entre em contato com o administrador para renovação. | O plano contratado para o uso do sistema está expirado, o que impede o acesso aos recursos disponíveis. | 403 – Forbidden |
| Servidor | Erro interno. | Problemas internos no servidor, falhas de configuração ou erros imprevistos que impediram a execução da requisição. | 500 – Internal Server Error |
| Ocorreu um erro inesperado. Por favor, tente novamente mais tarde. | Problemas internos no servidor, falhas de configuração ou erros imprevistos que impediram a execução da requisição. | 500 – Internal Server Error |