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 listar informações 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 informações via API
1) Após acessar a Listagem de APIs do Developer Omie, dê um duplo clique sobre o tipo de serviço desejado por você, para acessar a documentação e listagem de métodos disponíveis para ele:
Abaixo demonstraremos o acesso à listagem de métodos de Clientes, Fornecedores, Transportadoras, etc, mas o processo poderá ser seguido por qualquer um dos módulos/serviços listados.
2) Selecione 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.
3) Para realizar um teste pelo Developer - Portal do Desenvolvedor, é preciso realizar o login no Omie:
4) 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 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.
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 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.
5) 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.
💡 Para métodos voltados a listagem, a pesquisa realizada nos cadastros do Omie é paginada, ou seja: você resgata uma determinada quantidade de registros para cada solicitação.
A cada solicitação você deve informar o número da página que quer resgatar e a quantidade de registros por página. O resultado sempre indicará qual foi a página resgatada, o total de páginas disponíveis, o número de registros retornados e o total de registros encontrados na pesquisa:
5) Caso esteja listando os registros e recursos para realizar alterações nos mesmos, guarde as informações de códigos internos e códigos do Omie dos registros desejados, pois é a partir deles que você irá localizar os registros nos demais métodos da API.
Para o método ListarClientes, as informações de campos a serem guardados são referente as Tags:
"codigo_lancamento_integracao"
"codigo_lancamento_omie"
📚 Artigos Relacionados
