Logs
O registro de cada requisição feita com uma chave de API e de cada envio por SMTP.
Para que serve
Os Logs registram cada requisição feita à API com uma chave e cada e-mail enviado por SMTP, com o corpo que você mandou e a resposta que a Postal devolveu. É o primeiro lugar para olhar quando uma integração "não funciona".
Quando usar: Para depurar um erro (400, 401, 422, 429), conferir o que o seu sistema realmente enviou e ver qual chave fez a chamada.
#Lista de logs
Onde fica: Desenvolvedores › Logs. Endereço: app.postal.so/logs.
Aparecem as chamadas feitas com chaves de API e os envios por SMTP; o que você faz dentro do painel não entra aqui. Os logs são guardados por 30 dias.
| Item | O que faz |
|---|---|
| Buscar por endpoint | Filtra pelo caminho da chamada (por exemplo, /emails). |
| Período | Atalhos (Hoje, Ontem, Últimas 24 horas, Últimos 3 dias, Últimos 7 dias, Últimos 15 dias e Últimos 30 dias), calendário e Todo o período. |
| Filtros › Status | Sucesso (2xx), Erro do cliente (4xx), Erro do servidor (5xx) ou Limite excedido (429). |
| Filtros › Origem | API ou SMTP (API e SMTP mostra os dois). |
| Filtros › User agent | O programa que fez a chamada: SDK Node.js, SDK PHP, SDK Python ou cURL (Todos os clientes limpa). |
| Filtros › Chave de API | Só as chamadas de uma chave. |
| Exportar | Gera um CSV dos logs com os filtros atuais. |
| Coluna | O que mostra |
|---|---|
| Endpoint | O método e o caminho, como POST /emails. Clicar abre o detalhe. |
| Status | O código HTTP da resposta, em verde (2xx), amarelo (4xx) ou vermelho (5xx). |
| Chave | O nome da chave de API usada, ou chave removida se ela foi revogada. |
| User agent | O programa cliente, ou Cliente SMTP nos envios por SMTP. |
| Data | Data e hora da requisição. |
Dica
Erros 4xx são quase sempre da chamada (campo faltando, chave sem permissão, domínio não verificado). Filtre por Erro do cliente (4xx) e abra um log: a resposta traz o name do erro, que está explicado em Erros. Muitos Limite excedido (429) indicam que vale usar o envio em lote ou conferir os limites.
#Detalhe de um log
Onde fica: Desenvolvedores › Logs, clicando numa linha. Endereço: app.postal.so/logs.
O cabeçalho mostra o método e o caminho, a data e o user agent, e o código de status. Abaixo, dois blocos lado a lado:
| Bloco | O que mostra |
|---|---|
| Requisição | O corpo JSON que o seu sistema enviou. Vazio, aparece Sem corpo. |
| Resposta | O JSON que a Postal devolveu: o id do e-mail criado, ou o erro com statusCode, name e message. |
O conteúdo dos anexos não é guardado no log: no lugar dele aparece o tamanho, como [1234 bytes em base64], e textos muito longos são cortados. Nas chamadas GET, a Requisição mostra os parâmetros da URL. Para ver o que aconteceu com o e-mail depois de criado, abra o e-mail em E-mails: o campo Requisição faz a ligação entre os dois.
Veja também: Logs (API) · Erros · Chaves de API.