As API's do Omie permitem realizar diversas operações no ERP. Com isso, você consegue integrar diferentes aplicativos, expandindo ainda mais as possibilidades.
Neste artigo, você vai entender como utilizar a API para Listar o Extrato e aproveitar ao máximo essa funcionalidade. 🚀
Tópicos do Artigo:
Informações Importantes
✅ 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.
🧪 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 API's 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 o Extrato via API
1) Para realizar um teste pelo Developer - Portal do Desenvolvedor, é preciso realizar o login no Omie:
2) Após realizar o login no Omie, clique na Engrenagem do App da empresa desejada (1), e selecione a opção "Resumo do App" (2):
3) No "Resumo do Aplicativo", role a tela até localizar a opção "Visitar o Portal do Desenvolvedor":
4) Acesse a opção "Lista das API's", para que seja apresentado a listagem de todos os métodos disponíveis no sistema:
5) Na seção de Finanças, clique na opção "Extrato de Conta Corrente":
6) Para realizar um teste rápido com os parâmetros básicos, basta clicar em "Teste agora mesmo":
💡 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 dados: 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.
7) Veja como cada campo funciona:
(1) Endpoint: O Omie preencherá automaticamente este campo com o Endpoint do método escolhido.
(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.
💡 Dica
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) Nome/Valor: O Omie definirá automaticamente o tipo de chamada como o método escolhido.
(4) Conteúdo: Este é o campo onde você configurará sua requisição, inserindo os dados necessários para listar o tipo de registro desejado.
8) Após enviar a requisição, o resultado será demonstrado em tela, no canto direito:
(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.
💡Dicas:
As previsões de lançamentos na Conta Corrente são consideradas na tag “nsaldoatual”. Por esse motivo, o valor pode ser diferente da tag “nsaldodisponivel”, que não considera as previsões.
O “nsaldoatual” também pode ficar diferente do “Saldo Previsto” do extrato no desktop, porque ele é calculado considerando o “Saldo Anterior” como inicial, desconsiderando os valores previstos anteriores.
📚 Artigos Relacionados: