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 Postman!
O Postman é uma ferramenta colaborativa para desenvolvimento, envio e documentação de APIs. Ele permite enviar requisições, analisar respostas, automatizar testes e criar ambientes para simular diferentes cenários.
Descubra como utilizar o Postman 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 Postman
1) Acesse o link de Download do Postman para dar início a instalação:
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 Postman. Instale o aplicativo e siga os próximos tópicos.
Enviando a requisição como JSON
1) Após instalar o Postman, crie uma Request clicando no botão "New", localizado no canto esquerdo da tela:
2) Selecione o protocolo HTTP:
3) Defina o tipo de requisição como "POST" (1), e informe a URL para consumo (2):
💡 Dica
Você pode consultar pelo nosso site Developer todas URLs/Endpoints e todas as informações para suas requisições.
Neste exemplo, vamos utilizar o método voltado a listagem de Clientes e Fornecedores:
4) Para enviar a requisição como JSON, basta clicar na aba “Headers” (1) e adicionar os seguintes itens:
(2) Key: Content-Type
(3) Value: application/json
5) Na aba “Body” (1), selecione a opção "raw" (2) preencha as informações da requisição, sendo as credenciais (APP_KEY e APP_SECRET) e os dados da requisição (3):
6) Por fim, para testar a requisição, basta clicar no botão "Send":
7) Ao fazer isso, será a feita a comunicação da API, e retornado o resultado:
Enviando a requisição como XML/SOAP
1) Após instalar o Postman, crie uma Request clicando no botão "New", localizado no canto esquerdo da tela:
2) Selecione o protocolo HTTP:
3) Defina o tipo de requisição como "POST" (1), e informe a URL para consumo (2):
💡 Dica
Você pode consultar pelo nosso site Developer todas URLs/Endpoints e todas as informações para suas requisições.
Neste exemplo, vamos utilizar o método voltado a listagem de Clientes e Fornecedores:
4) Para enviar a requisição como XML, basta clicar na aba “Headers” (1) e adicionar os seguintes itens:
(2) Key: Content-Type | Value: application/json
(3) Key: SOAPAction | Value: Preencha a mesma URL para consumo indicada no passo 3
5) Na aba “Body” (1), selecione a opção "raw" (2) preencha as informações da requisição, sendo as credenciais (APP_KEY e APP_SECRET) e os dados da requisição (3):
6) Por fim, para testar a requisição, basta clicar no botão "Send":
7) Ao fazer isso, será a feita a comunicação da API, e retornado o resultado:
📚 Artigos Relacionados
