As APIs do Omie permitem realizar diversas operações no ERP. Com isso, você consegue integrar diferentes aplicativos, expandindo ainda mais as possibilidades.
Descubra como obter seu Boleto através da API! 🚀
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.
💡 Dica Omie: Você pode testar nossas APIs diretamente no nosso Portal do Desenvolvedor. Além disso, ferramentas como Postman, Insomnia e ThunderClient (extensão do VS Code) também são ótimas opções para realizar testes.
Listando as Contas a Receber
Para obter o Boleto via API, será necessário ter em mãos a informação de "codigo_lancamento_omie" ou "codigo_lancamento_integracao" da Conta a Receber vinculada ao Boleto desejado.
1) Para isso, realize a listagem de Contas a Receber a partir do método "ListarContasReceber":
Possui dúvida sobre como obter listagens via API?
Consulte este exemplo prático: Listando as informações via API
2) Localize a Conta a Receber desejada na listagem e realize as seguintes validações:
(1) "cGerado": "S": A partir da array
"boleto", confira se o conteúdo da Tag"cGerado"é igual a"S". Caso sim, isso significa que um Boleto foi gerado para a Conta a Receber.
(2) "codigo_lancamento_omie" e/ou "codigo_lancamento_integracao": Esses são os códigos identificadores do Lançamento, que servem como referência para consultas e para a realização de operações via API. Anote eles para prosseguir com o processo de obtenção do Boleto!
Obtendo o Boleto gerado
1) Após acessar a Listagem de APIs do Developer Omie e realizar a consulta da listagem de Contas a Receber para obter a informação de "codigo_lancamento_omie" ou "codigo_lancamento_integracao" do lançamento do Boleto que deseja obter, navegue pela página e dê um duplo clique sobre o serviço "Contas a Receber - Boleto", para acessar a documentação e listagem de métodos disponíveis para ele:
2) Para obter o Boleto, utilize o método "ObterBoleto":
3) Após selecionar o método desejado no índice do canto direito (1), assim você será levado a parte da página com informações sobre o mesmo, contendo dados de parâmetros e requisição exemplo (2).
Para realizar um teste rápido com os parâmetros básicos, basta clicar em "Teste agora mesmo" (3):
💡 Entendendo os parâmetros
💡 Entendendo os parâmetros
Por aqui, você encontrará uma lista dos parâmetros disponíveis para sua requisição, incluindo:
Nome – Identifica a variável dentro da API.
Tipo de dado – Indica o formato esperado (integer, string, decimal, etc.)
Descrição – Explica a finalidade do parâmetro e como utilizá-lo.
Para obter mais detalhes sobre um parâmetro específico, basta passar o mouse sobre o ícone ➕, e uma explicação detalhada será exibida.
4) Para realizar um teste pelo Developer - Portal do Desenvolvedor, é preciso realizar o login no Omie:
5) Após realizar o login, você será direcionado para a tela de testes do Developer, onde poderá configurar e enviar requisições para a API. Veja como cada campo funciona:
(1) Endpoint: O Omie preencherá automaticamente este campo com:
🔗
https://app.omie.com.br/api/v1/financas/contareceberboleto/#ObterBoleto(2) Aplicativo ou Chave de Acesso: Aqui, você verá uma lista dos aplicativos aos quais seu e-mail tem acesso. Basta selecionar o desejado, e os campos App Key e App Secret serão preenchidos automaticamente.
Caso precise testar um aplicativo que não aparece na lista, selecione "O aplicativo que eu quero não está na lista" e insira manualmente suas credenciais.
(3) Call: O Omie definirá automaticamente o tipo de chamada como ObterBoleto.
(4) Conteúdo: Este é o campo onde você configurará sua requisição, inserindo os dados necessários para obter o Boleto da Conta a Receber desejada.
6) A seguir, demonstramos um exemplo de requisição para obtenção do Boleto:
{
"nCodTitulo": 0,
"cCodIntTitulo": ""
}
📣 Importante
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".
7) Após enviar a requisição, o resultado será demonstrado em tela, no canto direito.
Caso todos os parâmetros tenham sido corretamente informados, você receberá uma resposta positiva contendo os dados do Boleto será apresentada:
(1) Requisição cURL: o sistema converte todo o conteúdo preenchido para o envio da requisição em cURL para que você possa utilizar de forma mais prática caso faça integrações por outros aplicativos.
(2) Cabeçalho: por aqui é possível acompanhar o status HTTP, e verificar se a requisição deu erro ou se foi concluída com sucesso.
(3) Corpo: é nessa parte que será exibido o retorno da requisição enviada.
💡 Caso disponível, você encontrará o link do boleto na Tag "cLinkBoleto". Com esse link, é possível visualizar o PDF do Boleto.
📚 Artigos Relacionados
