Erros

Erros que podem ser retornados nas requisições.

Ao fazer alguma requisição em nossa API, será emitida uma resposta com status no padrão códigos de status HTTP.

Uma requisição bem sucedida retorna o status 200 OK com uma resposta em formato JSON.

Já uma requisição que não teve sucesso vai retornar algum status com código iniciado em 4. Por exemplo, o status 401 Unauthorized. A resposta será em texto simples (plain text) ou JSON.

Para o método de Autenticação, temos os seguintes erros:

1. Mensagem: Credenciais inválidas. Solução: Informe corretamente o usuário ou verifique novamente com seu contato.

2. Mensagem: Senha incorreta. Solução: . Informe a senha correta ou altere para uma nova.

Para os demais métodos da API, destacamos abaixo os erros mais comuns, geralmente relacionados à autenticação. Mas também pode ocorrer erro relacionado ao informe incorreto dos parâmetros (param) ou corpo (payload) das requisições. Nesses casos, o sistema retornará com o descritivo do erro.

Erros comuns

1. Mensagem: Bearer Token ausente! Problema: O 'Bearer Token' não foi informado no cabeçalho (header) 'Authorization' da requisição. Solução: Gere o token no método 'Autenticação' e o informe no cabeçalho da requisição desejada.

2. Mensagem: Bearer Token inválido! Problema: O 'Bearer Token' informado no cabeçalho (header) 'Authorization' é inválido. Solução: Gere um novo token no método 'Autenticação' e o informe na requisição.

3. Mensagem: Sessão expirada! Problema: O token passou da validade máxima que é de 12 horas. Solução: Gere um novo token no método 'Autenticação' e o informe na requisição.

4. Mensagem: Usuário não autenticado. Problema: Ocorreu um problema na sessão do usuário usado na API. Solução: Entre em contato com o responsável pela criação do seu usuário e confiram o respectivo cadastro.

5. Mensagem: Usuário não autorizado. Problema: Ocorreu um problema na sessão do usuário usado na API. Solução: Entre em contato com o responsável pela criação do seu usuário e confiram o respectivo cadastro.

6. Mensagem: Permissão negada: CAMINHO_DA_PERMISSAO Problema: Seu usuário não tem a permissão no respectivo método da API. Solução: Entre em contato com o responsável pela criação do seu usuário e solicite liberar no respectivo perfil a permissão no método que está tentando usar.

Outras mensagens

Pode ocorrer outras mensagens, as quais geralmente serão relacionadas ao informe incorreto de dados na requisição. Nesse caso, a API retornará apontando qual o campo informado incorretamente.

Além, pode acontecer também algum erro no servidor, o qual retornará um status com código iniciado em 5. Nesse caso, entre em contato conosco.

No caso de retorno de uma mensagem não identificada, que não esteja devidamente documentada ou que não seja clara ao usuário, pedimos nos reportar no Contato para que possamos avaliar e lhe ajudar conforme o necessário.