O SOAP UI é uma ferramenta gratuita de testes de API que você pode utilizar para conhecer melhor o comportamento das APIs da Omie
Você pode fazer o download acessando:
Após a instalação, clique no botão “SOAP” do aplicativo para criarmos um novo projeto:
Informe a URL que deseja consumir, acrescentando “?WSDL” no final como segue:
Após adicionar o projeto da API no SOAP você conseguirá visualizar os métodos disponíveis:
Vamos acessar o método “ListarLancCC” que irá listar os lançamentos de contas correntes. Ao cliente em “Request 1”, os dados para consumo serão exibidos:
Antes de efetuar o consumo, precisamos informar a sua APP_KEY e APP_SECRET no Envelope SOAP. Esses dados devem ser informados na estrutura Header:
Na sequência, veja um exemplo de como essa estrutura deve ser preenchida:
Código:
<soapenv:Header/>
<app_key>2555995110669</app_key>
<app_secret>"74e2fdd59ac709c4201fe625d07e2f8b"</app_secret>
O passo seguinte é definir os parâmetros no corpo do Envelope SOAP:
Para facilitar a compreensão, removemos os comentários e definimos apenas 2 campos para pesquisa: o número da página que vamos recuperar (nPagina) e o número de registros por página (nRegPorPagina):
Código:
<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>
Pronto, podemos realizar o teste de consumo clicando no botão “Submit”, como indicado a seguir:
O XML de resposta será retornando na sequência com os dados solicitados!
📌 Separamos alguns artigos importantes que podem te ajudar bastante: