Erro 400 - BAD REQUEST
Esse erro ocorre quando o servidor não consegue processar a solicitação devido a um erro cometido pelo cliente. Exemplos incluem má formatação da solicitação, envio de uma mensagem inválida ou uma tentativa de burlar o sistema de roteamento.
ERRO 401 - UNAUTHORIZED
Esse erro indica que o cliente precisa se autenticar corretamente para obter a resposta do servidor. Em outras palavras, o cliente deve provar sua identidade antes de continuar.
Neste caso acesse a sua base do Sienge com um usuário administrador, vá até a tela de integrações e acesse APIs > Usuários de APIs
.
Identifique o usuário utilizado e clique no ícone de lápis para editar.
Na tela "Dados de Acesso", verifique se a opção "Nunca expira" está marcada ou se as opções de expiração da senha não ultrapassaram o período configurado. Certifique-se de que o usuário não está desativado.
Se o problema persistir, confira se o nome de acesso está correto. Copie-o diretamente para evitar erros de digitação.
Por fim, clique em "Gerar nova senha" para validação.
ERRO 403 - FORBIDDEN
Esse erro ocorre quando o cliente tenta acessar um recurso para o qual não possui permissão. O servidor recusa o acesso porque o cliente não tem autorização para visualizar ou obter o recurso solicitado.
Verifique se o usuário de API tem as permissões necessárias para a API em questão. No menu de edição do usuário de API, vá até Autorizações do Usuário
de
API
e marque as flags conforme a API utilizada.
Siga as orientações da documentação da API para configurar corretamente as permissões.
ERRO 404 - NOT FOUND
Esse erro ocorre quando o servidor não consegue encontrar o recurso solicitado. Isso pode significar que o cliente fez uma solicitação para um endpoint válido, mas o recurso em si não existe no servidor.
Este erro é bem comum, pois qualquer sintaxe errada a API não funciona, uma DICA! Importante é usar o autopreenchimento da documentação.
Erros de sintaxe na URL são comuns. Utilize o preenchimento automático da documentação da API para evitar erros.
Encontre a API que deseja consultar e clique em "Try it out". Preencha os campos obrigatórios (marcados como *required) e clique em "Execute".
Após executar, a página vai lhe mostrar a URL completa em Request URL, basta apenas substituir o campo {subdomain-do-cliente} pelo da sua base e copiar a URL para consulta.
A página exibirá a URL completa no campo Request URL
. Substitua o campo {subdomain-do-cliente}
pelo subdomínio da sua base e copie a URL para consulta.
Exemplo: Em https://suporte.sienge.com.br, o subdomínio é "suporte".
ERRO 405 - METHOD NOT ALLOWED
Esse erro ocorre quando o método de solicitação (GET, POST, DELETE, PUT, PATCH) enviado pelo cliente não é compatível com o recurso solicitado. Por exemplo, uma API pode não permitir o método DELETE para remover um recurso.
Verifique se o método de solicitação que está utilizando é suportado pela API.
Se, por exemplo, tentar usar DELETE em uma API que não suporta esse método, o erro 405 será retornado.
ERRO 422 - UNPROCESSABLE CONTENT
Esse erro ocorre quando a solicitação está formatada corretamente, mas não pode ser atendida devido a erros semânticos ou de significado. Isso significa que a solicitação contém informações inválidas ou inconsistentes, impedindo o processamento correto pela API.
Revise os dados enviados na solicitação para garantir que estejam corretos e em conformidade com as regras da API.
ERRO 429 - TO MANY REQUESTS
Esse tipo de erro pode ocorrer quando o usuário atinge o limite do pacote contratado ou envia inúmeras requisições para a API em um curto espaço de tempo, o que é conhecido como "limitação de frequência" ou "rate limit". Isso significa que a API possui restrições quanto ao número de requisições que um usuário pode fazer em um determinado período de tempo. Quando essas restrições são excedidas, o servidor responde com esse erro, indicando que o usuário atingiu o limite permitido de requisições dentro desse período. É importante respeitar os limites de frequência estabelecidos pela API para evitar esse tipo de erro.
Consulte a documentação da API em Introdução > Geral
, onde as limitações de segurança e pacotes de API estão detalhadas. .
Rate Limit: A REST permite até 200 requisições por minuto, enquanto a BULK permite 20 requisições por minuto.
Neste caso, um usuário pode requisitar quantos endpoints achar necessário respeitando este limite.
Pacote de API: A quantidade de requisições varia conforme o pacote contratado.
Quantidade de requisições no pacote também se diferem em REST e BULK conforme a screenchot a cima.
Mas como saber se o meu problema é limitação de segurança ou pacote?
Neste caso basta acessar o Sienge e acessar a plataforma de integrações.
Em APIs->Consumo de APIs você consegue acompanhar o gráfico mensal com cada dia do mês.
Se seu gráfico ultrapassou o tracejado vermelho isso informa que você atingiu o limite do seu pacote contratado, do contrário seu problema é relacionado ao Rate Limit.
ERRO 503 - SERVICE UNAVAILABLE
Esse erro ocorre quando o servidor está temporariamente indisponível. Isso pode acontecer devido a manutenção ou sobrecarga do servidor.
Existem algumas causas comuns para isso, como o servidor estar em manutenção ou sobrecarregado. No caso específico da manutenção, nossos servidores passam por atualizações ou ajustes entre 00:00 e 06:30. Durante esse período, o servidor não estará pronto para manipular a requisição e retornará esse erro. É importante aguardar até que o horário de manutenção seja encerrado para tentar novamente a requisição.
Do contrário basta acionar o suporte para validação.