Antes que possa começar de fato os testes com a nossa API, é importante que conheça alguns processos básicos:
💡 #DicaDoBem: Atualmente, conseguimos testar as nossas API’s diretamente pelo site do Developer, porém, existem alguns programas que também podem realizar esse processo, como é o caso do Postman, Insomnia e o ThunderClient (uma extensão do VS Code) |
Para o nosso teste, vamos utilizar diretamente o Developer. Assim como, vamos utilizar o APP KEY e o APP SECRET padrões, mas se preferir, pode alterar para o seu 😉
Nesse artigo, temos:
Listando as contas a receber
Para esta consulta, utilizaremos o método ListarContasReceber
1) Ao acessar a página do Developer, no método ListarContasReceber, clique em "Teste agora mesmo":
2) Preencha os campos conforme orientação abaixo:
OMIE_APP_KEY (1) e OMIE_APP_SECRET (2): Preencha esses campos com as chaves de integração do seu aplicativo Omie;
Conteúdo (3): Aqui, você terá acesso aos parâmetros padronizados, como "pagina", "registros_por_pagina" e "apenas_importado_api". No entanto, se preferir, você tem a flexibilidade para utilizar mais parâmetros de acordo com suas necessidades específicas, consulte aqui a listagem de parâmetros disponíveis
Executar (4): Em seguida, clique em "Executar":
3) Será apresentada uma listagem com os dados das suas Contas a Receber:
Nesse momento, são importantes duas tags que servirá de base para puxarmos o boleto:
"cGerado": "S"
"codigo_lancamento_omie" ou "codigo_lancamento_integracao"
Obtendo o boleto gerado
Para esta consulta, utilizaremos o método ObterBoleto
1) Ao acessar a página do Developer no método "ObterBoleto", clique em "Teste agora mesmo":
2) Nesta requisição você poderá utilizar dois parâmetros, sendo eles:
"nCodTitulo": equivalente ao valor da tag "codigo_lancamento_omie" do método "ListarContasReceber"
"cCodIntTitulo": equivalente ao valor da tag "codigo_lancamento_integracao" do método "ListarContasReceber"
3) Ao clicar em "Executar", os dados do boleto serão apresentados e você encontrará o link do boleto:
Com esse link, é possível visualizar o PDF do boleto 😉
📌 Separamos alguns artigos relacionados que podem te ajudar bastante:
