Dicas de Uso

DICAS DE USO – COMO USAR A TELA LOG DA API LOCAL

image-20261020-202018.png

A tela Log de API local serve para consultar em detalhe um registro de log gerado pela API local do Vixen POS. Ela ajuda a entender o que aconteceu, onde aconteceu e qual requisição estava sendo processada quando o evento foi registrado.



Ao abrir, o período já vem preenchido com o dia atual. Depois de ajustar os filtros desejados, use Consultar para atualizar a lista.

image-20261020-203215.png

A grade apresenta uma visão geral com data/hora, URL, método, mensagem, terminal, sistema e tipo e sinaliza quando há uma exceção interna associada ao registro.

Para entender um item com mais profundidade, selecione-o e use o Zoom. Isso abre uma segunda tela em modo de leitura, com os detalhes do erro e da requisição correspondente.

image-20261020-202458.png

Dados de identificação do log

Campo

Para que serve

URL

Mostra o endereço ou rota da API que estava sendo acessada. Ajuda a identificar qual funcionalidade foi acionada.

Método

Indica a ação feita na rota, como GET (consulta), POST (inclusão/envio), PUT (alteração) ou DELETE (exclusão).

Sistema

Identifica o sistema, módulo ou integração que originou o registro.

Terminal

Exibe o terminal massociado ao log. É útil para saber em qual ponto de operação ocorreu o evento.

Dh. Log

Data e horário em que o evento foi registrado. Deve ser usado para relacionar o problema com a operação feita naquele momento.

Aba “Detalhes do erro”

Esta aba apresenta a falha principal registrada pela API.

Campo

Para que serve

Mensagem

Explicação principal do que deu errado. Normalmente é o melhor ponto de partida para entender o problema.

Fonte do erro

Componente, serviço ou parte da aplicação que originou a falha. Ajuda a direcionar a análise para o responsável correto.

HResult

Código técnico retornado pelo sistema ou biblioteca que gerou a falha. É mais útil para a equipe técnica, especialmente ao comparar ocorrências semelhantes.

Stack Trace

Histórico do caminho percorrido pela aplicação até o erro. Mostra a sequência de rotinas envolvidas e é destinado principalmente à investigação técnica.

Aba “Exceção interna (I.E.)”

Alguns erros são apenas a consequência visível de outra falha mais específica. Essa aba exibe essa causa interna, quando ela existir.

Campo

Para que serve

Mensagem

Descrição da causa interna do problema. Muitas vezes é mais detalhada que a mensagem apresentada na aba anterior.

Stack Trace

Caminho técnico associado à causa interna. Serve para aprofundar a análise quando a mensagem não for suficiente.

Se esta aba estiver vazia, o log não registrou uma exceção interna adicional.

Aba “Cabeçalho da requisição”

Esta aba mostra o contexto da chamada recebida pela API. Ela é útil para reproduzir ou conferir a requisição que levou ao evento.

Campo

Significado

Parâmetros da URL

Informações enviadas junto da URL, normalmente usadas para filtrar, identificar ou direcionar a operação. O texto Copiar parâmetros da URL copia esse conteúdo para a área de transferência.

Body da requisição

Conteúdo enviado no corpo da chamada, geralmente os dados que deveriam ser incluídos ou alterados. O rótulo Body da requisição permite copiar o conteúdo.

Token JWT

Credencial de autenticação enviada com a chamada. O rótulo Token JWT copia o valor para a área de transferência. Esse dado deve ser tratado como sensível.

Essa tela só está disponível para o uso da API local do Vixen POS