Viagilize Vídeos

Logs da API e Webhooks

Viagilize

Tutoriais oficiais · Configurações

Artigo

Obrigado pelo aviso. O que faltou ou ficou confuso? (opcional)

Recebemos. Vamos rever este vídeo.

1 visualização · · 3:54

Neste vídeo você vai conhecer os Logs de Requisições, o histórico de tudo que os sistemas conectados pediram para a sua empresa. É por aqui que você descobre por que uma integração parou de funcionar.

Capítulos

Este vídeo responde

  • Como vejo o histórico de chamadas da API?
  • Onde verifico se o token está sendo usado corretamente?
  • Como descubro por que o parceiro está recebendo erro 401?
  • Onde filtro as requisições de um token específico?
  • Como saber quanto tempo cada chamada da API está levando?
  • Como identifico quais endpoints da API estão sendo mais usados?
  • Onde vejo se o ERP conectado está chamando a API corretamente?
  • Como audito o uso da chave de API nos últimos 30 dias?
  • Por que a tabela aparece vazia mesmo tendo integração ativa?
  • Como descubro se algum token está gerando muitos erros?

#logs #api #requisicoes #auditoria #integracao #debug #token #endpoint #historico #webhook #statushttp #configuracoes #chamadasapi #errosapi

Transcrição

  1. A tela

    É por aqui que você descobre por que uma integração parou de funcionar. No topo, o título Logs de Requisições e a linha Histórico de chamadas à API.

  2. Os filtros

    O botão Voltar, à direita, leva de volta à página de API e Webhooks, onde você cria, revoga e regenera as chaves. Logo abaixo fica a faixa de filtros, com quatro campos: Token, Status, Método e Período.

  3. Filtrar por chave

    Nada aqui é salvo, eles só recortam a lista que aparece embaixo. Em Token você escolhe uma das chaves que cadastrou e passa a ver só as chamadas feitas com ela.

  4. Filtrar por resultado

    A lista traz todas as chaves, inclusive as revogadas, então dá para auditar o uso de uma que você já desligou. Em Status, Sucesso mostra as chamadas que deram certo, Erro Cliente mostra as que o sistema conectado errou, normalmente chave inválida ou dados fora do formato, e Erro Servidor mostra as falhas do nosso lado.

  5. Filtrar por operação

    Em Método você separa por tipo de operação: GET para consultas, POST para criar, PUT para atualizar e DELETE para excluir.

  6. Período

    Em Período a tela já começa nas últimas 24 horas, e você pode abrir para 48 horas, 7 dias ou 30 dias. Se a lista vier vazia, abra o período antes de concluir que a integração está parada.

  7. Filtrar

    Escolhidos os filtros, clique em Filtrar e a lista se refaz na hora. Para voltar a ver tudo, deixe os campos em Todos e filtre de novo.

  8. A tabela

    A tabela lista as chamadas da mais recente para a mais antiga, de cinquenta em cinquenta, e guarda os últimos 30 dias. São seis colunas: Data e Hora, Token, Método, Endpoint, Status e Tempo.

  9. Data e Token

    Data e Hora mostra o dia, o mês e o horário exato da chamada, com os segundos. Ao lado, Token diz qual chave autenticou aquela chamada, e mostra N barra A quando a chave foi excluída depois do registro.

  10. Método

    Método vem como etiqueta colorida: verde para GET, azul para POST, âmbar para PUT e vermelho para DELETE.

  11. Endpoint

    Endpoint é o caminho que foi chamado, ou seja, o que o sistema conectado quis consultar ou alterar. Caminhos muito longos aparecem cortados, para não quebrar a tabela.

  12. Status

    Status é a resposta daquela chamada, também colorida: verde de 200 a 299, quando deu certo, âmbar de 400 a 499, quando a chave ou os dados estavam errados, e vermelho de 500 para cima, quando a falha foi nossa. Tempo mostra quantos milissegundos a resposta levou.

  13. Tempo

    Se o mesmo caminho aparece sempre com um número bem alto, anote a data e o endpoint e fale com o suporte. Na prática: o parceiro avisa que não consegue puxar as viagens, você escolhe a chave dele em Token, põe o Status em Erro Cliente e clica em Filtrar.

  14. Achando o problema

    Um 401 é chave inválida ou revogada, um 403 é chave sem permissão para aquele recurso. Pronto. A tela fica em Configurações, depois API e Webhooks, na aba Logs. Até o próximo vídeo. Os dados deste vídeo são fictícios, criados só para a demonstração.