Tráfego
Visão Geral
A tela Tráfego (antes chamada de Log de Entrada ou Audit) permite que desenvolvedores e administradores acompanhem chamadas feitas às APIs da plataforma.
Você pode acessá-la em: Partner's Portal > Monitoramento > Tráfego.
A funcionalidade fornece visibilidade sobre solicitações, respostas, headers, corpos (body), tempos de resposta e status codes.
⚠️ Atenção:
Este recurso tem caráter de auditoria e monitoramento. Não deve ser utilizado como mecanismo transacional ou fonte de dados persistente.
Retenção e Limitações
- Retenção dos logs: 90 dias.
- Persistência: não é garantida em 100% das chamadas (falhas de rede e indisponibilidades podem impactar).
- Finalidade: uso para auditoria, depuração e suporte. Não indicado para integrações críticas.
Recomenda-se que aplicações que necessitem de persistência total implementem mecanismos próprios de logging.
Estrutura do Painel
1. Lista de Requisições
Na tela principal de Tráfego, cada linha corresponde a uma requisição. Campos disponíveis:
| Campo | Descrição |
|---|---|
| Data da Requisição | Data e hora da chamada, exibidas no fuso horário do seu navegador |
| Caminho | Endpoint chamado (ex: /v1/requests/{id}/items/approvers) |
| Método | Tipo da operação (GET, POST, PUT, DELETE, PATCH) |
| ID de Correlação | Identificador único para rastrear a requisição ponta a ponta |
| Status da Resposta | Código HTTP retornado (200, 404, 500, etc.) |
A lista é paginada (25, 50 ou 100 itens por página) e pode ser ordenada pelas colunas Data da Requisição, Caminho, Método e Status da Resposta.
Filtros
Acima da lista estão disponíveis os filtros:
- Data: períodos pré-definidos (de Últimas 24 horas até Últimos 12 meses), Todo período ou Período específico (intervalo de até 1 ano).
- Status: Todos, Sucesso (status abaixo de 300), Aviso (300 a 499) ou Erro (500 ou superior).
- Método: Todos,
GET,POST,PUT,DELETEouPATCH. - Busca: pesquisa por texto e por critérios nos campos Data da Requisição, Status da Resposta, Caminho, ID de Correlação e Método. Os critérios podem ser salvos como filtros (os filtros salvos ficam armazenados no seu navegador).
2. Detalhes da Requisição
Ao clicar em uma linha, ela é expandida e são exibidas as abas Solicitação e Resposta.
Aba Solicitação
Mostra os dados enviados ao servidor:
| Campo | Descrição |
|---|---|
| Headers | Todos os headers recebidos na requisição. O valor do header authorization é sempre mascarado (********) |
| Endpoint | Caminho + parâmetros de query (ex.: ?pageNumber=1&pageSize=10) |
| Request Size | Tamanho da requisição (em bytes, KB ou MB), quando disponível |
| Request Body | Corpo enviado na requisição (JSON formatado), quando houver |
Exemplos de headers que costumam aparecer:
| Header | Descrição |
|---|---|
x-me-tenant-id | Identificador do tenant |
authorization | Token de autenticação (mascarado) |
x-me-correlation-id | ID de correlação |
host | Host da API |
user-agent | Agente de requisição (ex.: PostmanRuntime, libs, apps) |
cache-control | Política de cache |
accept | Tipos aceitos |
accept-encoding | Compressão aceita |
Aba Resposta
Mostra os dados devolvidos pelo servidor:
| Campo | Descrição |
|---|---|
| Headers | Todos os headers retornados na resposta |
| Response Time | Tempo total da resposta, em segundos (ex.: 33.7s) |
| Response Size | Tamanho da resposta (em bytes, KB ou MB), quando disponível |
| Response Body | Corpo retornado pela API (JSON formatado: mensagens de erro, payloads, dados), quando houver |
Exemplos de headers de resposta que costumam aparecer:
| Header | Descrição |
|---|---|
content-type | Formato da resposta (ex.: application/problem+json) |
server | Identificador do servidor |
transfer-encoding | Se chunked ou não |
date | Data/hora da resposta |
connection | Estado da conexão |
ratelimit-limit | Limite máximo de chamadas permitidas |
ratelimit-remaining | Chamadas restantes no período |
ratelimit-reset | Tempo em segundos para reset da janela de limite |
Exemplos de Resposta
Erro 500 (Internal Server Error)
{
"type": "https://datatracker.ietf.org/doc/html/rfc7231#section-6.6.1",
"title": "An error occurred while processing your request.",
"status": 500,
"detail": "An unexpected error has occurred. Please try again later or contact support if the issue persists."
}Erro 404 (Not Found)
- Indica que o recurso solicitado não existe (ex.: usuário ou item inexistente).
Sucesso 200 (OK)
- Indica que a requisição foi processada corretamente, com payload retornado no Response Body.
Boas Práticas de Uso
- Utilize o ID de Correlação ao abrir chamados de suporte.
- Monitore picos de erro 500 e excedentes de rate limit como indicadores de saúde da integração.
- Caso precise auditar além dos 90 dias, configure um pipeline de exportação de logs para armazenagem própria.
- Use os status codes e mensagens de erro como primeira camada de troubleshooting.