Descrição: Esta ferramenta fornece um registro detalhado de todas as comunicações (chamadas API) ocorridas entre o sistema Framework360 e serviços externos ou vice-versa.
Para que serve? (Exemplos práticos)
Use esta ferramenta para ter total visibilidade sobre as operações automáticas e integrações.
- Verificação das integrações: Verifique rapidamente o status (OK ou ERRO) de uma transação externa, por exemplo, o envio de dados para um CRM ou o processamento de um pagamento.
- Diagnóstico de erros: Se um processo automático não funcionar, você pode analisar o registro para ver exatamente quais dados foram enviados e quais mensagens de erro foram recebidas do serviço externo.
- Rastreamento da origem: Identifique o endereço IP e a origem de uma solicitação externa que interagiu com seu sistema.
Funcionalidades principais
1. Visualização do Registro Histórico
A tela principal mostra uma tabela resumida de todas as chamadas registradas.
- Status: Indica se a comunicação foi concluída com sucesso (
OK) ou se encontrou um problema (ERRO). - Descrição (Endpoint): Mostra o endereço ou serviço específico que foi chamado ou que chamou o sistema.
- IP: O endereço IP associado à solicitação.
- Data: Data e hora exatas em que ocorreu a interação.
2. Análise Detalhada da Chamada
Selecionando uma linha da tabela, é possível acessar a visualização detalhada que fornece todos os dados relativos àquela interação específica.
- Detalhes Gerais: São exibidos o Endpoint, o horário exato, o endereço IP e a origem da solicitação (por exemplo, se foi uma chamada direta ou proveniente de outra parte do sistema).
- User Agent: Informações sobre o software ou dispositivo que realizou a solicitação.
- Corpo da requisição: Exibe os dados exatos que o sistema enviou ao serviço externo (ou recebeu, dependendo do tipo de chamada).
- Corpo da resposta: Exibe os dados exatos que foram recebidos em resposta pelo serviço externo. Esses dados são cruciais para entender se a operação foi bem-sucedida e para analisar eventuais mensagens de erro.
3. Gerenciamento dos Logs
É possível gerenciar os dados registrados diretamente na tabela principal:
- Visualização: Abrir o detalhe da chamada (como descrito acima).
- Exclusão: Remover entradas individuais do registro histórico.
Integrações automáticas
Este módulo não requer configuração manual por parte do usuário. Funciona como um sistema de logging passivo:
- Registro automático: Sempre que o sistema interage com um serviço externo via API (por exemplo, para sincronizar dados ou enviar notificações), o evento é automaticamente registrado neste monitor, fornecendo um rastreamento completo da operação.
