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! 🚀
⚠️ Atenção
Estamos realizando uma atualização no armazenamento dos logs de API e Webhooks para melhorar a capacidade e a confiabilidade das consultas.
Durante essa transição, os Logs gerados antes da atualização ficarão temporariamente indisponíveis para consulta na tela. Os novos logs continuarão sendo registrados e consultados normalmente.
Essa indisponibilidade é temporária. Após a conclusão da migração, todos os logs, inclusive os anteriores, voltarão a estar disponíveis.
Precisa consultar um log antigo durante esse período? Entre em contato com a nossa equipe de suporte.
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.
Consultando o histórico das APIs e Webhooks
⚠️ Para acessar o histórico é preciso ter um perfil com acesso de Administrador.
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) para o qual deseja consultar o histórico de APIs.
Ao fazer isso, serão expandidas as informações do aplicativo, como Webhooks configurados e credenciais. Em seguida, 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 selecionado será exibido em guias distintas:
ℹ Para expandir a informação, basta clicar na seta em cima da descrição do campo de interesse.
(1) Requisições de API
(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
(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.
ℹ Para expandir a informação, basta clicar na seta em cima da descrição do campo de interesse.
Detalhes da Requisição: Sucesso
Detalhes da Requisição: Sucesso
Detalhes da Requisição: Erro
Detalhes da Requisição: Erro
📚 Artigos Relacionados:
