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 SoapUI!

O SoapUI é 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 SoapUI para enviar requisições para o Omie! 🚀

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 SoapUI

1) Acesse o link de Download do SoapUI para dar início a instalação:

Download SoapUI

2) Ao ser redirecionado ao site, clique na opção "Download SoapUI Open Source":

3) O Download será iniciado automaticamente, após baixar o arquivo do SoapUI. Instale o aplicativo e siga os próximos tópicos.

Enviando uma requisição

1) Após instalar o SoapUI, clique no botão “SOAP” do aplicativo para criarmos um novo projeto:

2) Defina um nome para o Projeto no campo "Project Name" (1), informe a URL do serviço que deseja consumir no campo "Initial WSDL:" acrescentando ?WSDL no final (2) e clique em "OK" (3):

💡 Dicas

Você pode consultar pelo nosso site Developer todas URLs/Endpoints e todas as informações para suas requisições.

Neste exemplo, vamos utilizar o serviço voltado a Lançamentos da Conta Corrente.
É possível obter a URL em WSDL diretamente pela página do método desejada:

3) Após adicionar o Projeto da API no SoapUI, você conseguirá visualizar os métodos disponíveis para o serviço no canto esquerdo:

4) Clique ícone de "+" ao lado do nome do método que deseja consumir:

Nesse exemplo, simularemos com o método ListarLancCC.

5) Dessa forma, será exibida a página de "Request 1" (1), onde os dados para consumo serão exibidos (2):

6) Antes de efetuar o consumo, é preciso informar a APP_KEY e APP_SECRET do Aplicativo Omie no Envelope SOAP. Esses dados devem ser informados na estrutura Header da tag <soapenv:Header/>:

7) Confira um exemplo de como essa estrutura deve ser preenchida:

<soapenv:Header/>

<app_key>XXXXXXXXX</app_key>

<app_secret>XXXXXXXXX</app_secret>

</soapenv:Header>

8) O passo seguinte é definir os parâmetros no corpo do Envelope SOAP.

Para facilitar a compreensão, removemos os comentários e definimos somente dois campos para pesquisa: o número da página que vamos recuperar (nPagina) e o número de registros por página (nRegPorPagina):

<soapenv:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:wsdl="http://app.omie.com.br/api/v1/financas/contacorrentelancamentos/?WSDL">

<soapenv:Header>

<app_key>XXXXXXXXX</app_key>

<app_secret>XXXXXXXXXX</app_secret>

</soapenv:Header>

<soapenv:Body>

<wsdl:ListarLancCC soapenv:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">

<lanccListarRequest xsi:type="wsdl:lanccListarRequest">

<nPagina xsi:type="xsd:integer">1</nPagina>

<nRegPorPagina xsi:type="xsd:integer">10</nRegPorPagina>

<cOrdenarPor xsi:type="xsd:string"></cOrdenarPor>

<cOrdemDecrescente xsi:type="xsd:string"></cOrdemDecrescente>

<dDtIncDe xsi:type="xsd:string"></dDtIncDe>

<dDtIncAte xsi:type="xsd:string"></dDtIncAte>

<dDtAltDe xsi:type="xsd:string"></dDtAltDe>

<dDtAltAte xsi:type="xsd:string"></dDtAltAte>

</lanccListarRequest>

</wsdl:ListarLancCC>

</soapenv:Body>

</soapenv:Envelope>

9) Por fim, para testar a requisição, basta clicar no ícone seta para direita ▶, correspondente a opção “Submit”, como indicado a seguir: