As APIs do Omie permitem realizar diversas operações no ERP. Com isso, você consegue integrar diferentes aplicativos, expandindo ainda mais as possibilidades.
Ao realizar as integrações com as APIs do Omie é comum acontecer alguns erros! Por isso, separamos os erros mais comuns para te ajudar nesse processo e deixar o código rodando de forma prática! 🚀
Tópicos do Artigo:
Informações importantes
✅ Acessando a documentação: Consulte nossa documentação oficial para entender os endpoints disponíveis e seus respectivos parâmetros.
🔑 Chaves de Integração da API: Saiba como obter e utilizar suas credenciais de acesso para autenticar as requisições.
⚙️ Características e Recomendações: Fique por dentro das melhores práticas para otimizar sua experiência com a API da Omie.
🔐 Login no Portal: Para testar suas requisições no Portal do Desenvolvedor é necessário fazer login na plataforma com o mesmo e-mail e senha que você já usa no ERP. Fácil, né? 😉
🧪 Aplicativo Teste: Aprenda a criar um Aplicativo Teste gratuito e descubra, na prática, como utilizar nossas APIs e aproveitar ao máximo os nossos recursos.
💡 Dica Omie: Você pode testar nossas APIs diretamente no nosso Portal do Desenvolvedor. Além disso, ferramentas como Postman, Insomnia e ThunderClient (extensão do VS Code) também são ótimas opções para realizar testes.
Erros e correções
ℹ Para expandir a informação, basta clicar na seta em cima da descrição do campo de interesse.
StatusCode 500: Internal Server Error
StatusCode 500: Internal Server Error
Esse erro pode acontecer por dois motivos:
Algum parâmetro foi preenchido de forma incorreta, por isso não acontece a comunicação com a API. Verifique se todos os caracteres estão preenchidos corretamente: aspas, chaves, links, etc.
Há alguma instabilidade na API, e por conta disso, não acontece há comunicação com o servidor. Nesses casos, o correto é aguardar e tentar reenviar a requisição de tempos em tempos
Too Many Requests
Too Many Requests
Esse erro acontece quando o rate limit é ultrapassado. A nossa API, por motivos de boas práticas algumas recomendações:
Limite de até 240 requisições por minuto
Limite de até 4 requisições simultâneas por segundo para consultas
Sem suporte de requisições simultâneas para inclusão/alteração de dados
Requisições redundantes liberadas a cada 60 segundos
Para mais detalhes, confira o artigo abaixo:
"Invalid JSON Object" ou "JSON request with SyntaxError"
"Invalid JSON Object" ou "JSON request with SyntaxError"
Um erro muito comum é quando esquecemos algum parâmetro no envio do arquivo JSON. Verifique se não há nenhum campo em branco, aspas que não foram fechadas, chaves/colchetes faltantes ou a mais. Qualquer um desses erros deixa o JSON inválido para a requisição
Caso esteja realizando a integração pelo Postman, confira o artigo abaixo, ele pode ajudar bastante!
O número máximo de caracteres permitido para o elemento [xxxx] é de X
O número máximo de caracteres permitido para o elemento [xxxx] é de X
Esse erro ocorre quando um dos parâmetros enviados excedeu o número de caracteres permitido. Verifique o nome da tag que vem entre os colchetes e a indição do limite para ajustar a quantidade e reenviar a requisição
(...) já cadastrado para o código de integração [xxxx]
(...) já cadastrado para o código de integração [xxxx]
Esse erro pode acontecer de diversas formas quando tentamos incluir algo no sistema, exemplo:
Pedido de venda já cadastrado...
Contrato de serviço já cadastrado...
Família de produto já cadastrada...
Para corrigir, altere o código de integração enviado na requisição e tente novamente
(...) não cadastrado para o número [xxxx]
(...) não cadastrado para o número [xxxx]
Esse erro ocorre quando tentamos consultar uma informação específica, porém o código de consulta informado está incorreto
Verifique o preenchimento do código e reenvie a requisição! Em alguns métodos, é possível listar as informações, isso pode te ajudar e verificar o código!
O preenchimento da tag [xxxx] é obrigatório e deve ter até, no máximo, X caracteres
O preenchimento da tag [xxxx] é obrigatório e deve ter até, no máximo, X caracteres
Esse erro acontece quando uma requisição é enviada com algum parâmetro obrigatório faltando. No próprio erro informamos qual a tag necessária entre colchetes. Preencha a tag obrigatória e reenvie a requisição
Verifique também o número máximo de caracteres para não exceder!
É obrigatório o preenchimento da tag [xxxx] ou da tag [xxxx]
É obrigatório o preenchimento da tag [xxxx] ou da tag [xxxx]
Esse erro é parecido com o erro acima! Uma requisição é enviada, porém com uma das informações obrigatórias faltando. No próprio erro informamos qual a tag necessária entre colchetes. Preencha a tag obrigatória e reenvie a requisição
(...) não cadastrada para o código [xxxx]! tag: [xxxx]
(...) não cadastrada para o código [xxxx]! tag: [xxxx]
Esse erro ocorre quando tentamos consultar ou filtrar alguma informação, porém o código enviado não existe dentro do sistema
O próprio erro informa qual o código enviado de forma incorreta e em qual tag. Valide a informação de retorno e reenvie a requisição
📚 Artigos Relacionados:
