As APIs do Omie permitem realizar diversas operações no ERP. Com isso, você consegue integrar diferentes aplicativos, expandindo ainda mais as possibilidades. Você pode testar nossas APIs diretamente no nosso Portal do Desenvolvedor, mas também há ótimas opções para realizar testes, como o Insomnia!
O Insomnia é uma ferramenta para envio de requisições HTTP, como as APIs do Omie. Ele permite enviar requisições, analisar respostas e criar ambientes para simular diferentes cenários.
Descubra como utilizar o Insomnia para enviar requisições para o Omie! 🚀
Tópicos do Artigo:
Informações Importantes
Antes de iniciar seus testes com a nossa API, é fundamental conhecer alguns processos básicos:
✅ 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.
Instalando o Insomnia
1) Para iniciar, faça o download do Insomnia através deste link:
2) Ao ser redirecionado ao site, clique na opção de Download para o seu sistema operacional:
3) O Download será iniciado automaticamente, após baixar o arquivo do Insomnia. Instale o aplicativo e siga os próximos tópicos.
Enviando uma requisição JSON
1) Após instalar o Insomina, ao abri-lo pela primeira vez, você pode realizar o login caso possua uma conta. Do contrário, clique em "Use the local Scratch Pad":
2) Agora, clique em "New HTTP Request":
3) Para enviar a requisição, o primeiro passo é alterar o método para POST:
4) Em seguida, preencha a URL do endpoint que irá enviar a requisição:
💡 Dica
Para obter a lista de métodos de API disponíveis, acesse o portal Developer.
5) Agora, acesse a aba Body (1) e na lista "No Body" (2) selecione a opção "JSON" (3):
6) Agora preencha a requisição de interesse. Neste exemplo, vamos listar as Categorias cadastradas, utilizando a seguinte requisição:
⚠️ Importante
Nos parâmetros "app_key" e "app_secret" é preciso preencher as credenciais do seu aplicativo Omie.
Para obter as credenciais de autenticação do seu aplicativo, consulte este artigo:
7) Com a requisição preenchida, clique em "Send":
8) Em alguns instantes, a resposta da API será exibida na lateral direita da tela:
10) Pronto! Agora, você já pode enviar requisições API para o Omie utilizando o Insomnia! 🚀
Enviando uma requisição XML com o Insomnia
1) Após instalar o Insomina, ao abri-lo pela primeira vez, você pode realizar o login caso possua uma conta. Do contrário, clique em "Use the local Scratch Pad":
2) Agora, clique em "New HTTP Request":
3) Para enviar a requisição, o primeiro passo é alterar o método para POST:
4) Em seguida, preencha a URL do endpoint que irá enviar a requisição:
💡 Dica
Para obter a lista de métodos de API disponíveis, acesse o portal Developer.
5) Agora, acesse a aba Body (1) e na lista "No Body" (2) selecione a opção "XML" (3):
6) Agora preencha a requisição de interesse. Neste exemplo, vamos listar os Lançamentos em Contas Correntes:
⚠️ Importante
Nos parâmetros <app_key> e <app_secret> é preciso preencher as credenciais do seu aplicativo Omie.
Para obter as credenciais de autenticação do seu aplicativo, consulte este artigo:
7) Com a requisição preenchida, clique em "Send":
8) Em alguns instantes, a resposta da API será exibida na lateral direita da tela:
10) Pronto! Agora, você já pode enviar requisições API para o Omie utilizando o Insomnia! 🚀
📚 Artigos Relacionados
