Passar para o conteúdo principal
Todas as coleçõesAPIs e Webhooks
Consultando o histórico das APIs e Webhooks
Consultando o histórico das APIs e Webhooks

Nesse artigo, descubra como consultar os logs de API e Webhook.

Kessy Silva avatar
Escrito por Kessy Silva
Atualizado há mais de um mês

O Omie disponibiliza uma série de APIs para integração, bem como uma página de testes, para envio das requisições.

Descubra abaixo como consultar o histórico das APIs e Webhooks! 🚀

Para acessar o histórico é preciso ter um perfil com acesso de Administrador.

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.

  • ⚙️ 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.


Consultando o histórico das APIs e Webhooks

1) O histórico das APIs é centralizado no Portal do Desenvolvedor (Developer Omie). Sendo assim, é necessário acessá-lo.

Após realizar login no Omie, abra uma nova guia no seu navegador e clique no link abaixo para acessar a Área do Desenvolvedor:


2) Na tela inicial do Developer, clique na opção "Aplicativos":


3) Clique sobre o nome do Aplicativo (1) que deseja consultar o histórico de APIs, dessa forma as informações sobre ele — como Webhooks configurados e credenciais — serão expandidas. Com isso, clique em "Exibir logs de integração" (2):

4) Na tela apresentada, o histórico de Requisições de API (1) e de disparos de Webhooks (2) do Aplicativo desejado serão exibidos em guias distintas.

Nelas temos:

Para expandir a informação, basta clicar na seta em cima da descrição do campo de interesse.

(1) Requisições de API

A aba "Requisições de API" exibe os seguintes dados:

  • Data Requisição

  • ID da Requisição (único para cada movimento feito)

  • Método (ação realizada)

  • Duração (ms)

  • Resultado (Sucesso/Erro)

  • Detalhes

(2) Webhooks

A aba "Webhooks" exibe os seguintes dados:

  • Data Requisição

  • ID da Mensagem (única para cada disparo feito)

  • Tópico

  • Duração (ms)

  • Resultado (Sucesso/Erro)

  • Detalhes

5) Ao clicar em "+ detalhes", conseguimos visualizar o corpo da requisição e da resposta que foi enviada, sendo de sucesso ou erro.

Separamos abaixo, um exemplo de cada:

Detalhes da Requisição: Sucesso

Detalhes da Requisição: Erro


📚 Artigos Relacionados:

Respondeu à sua pergunta?