Sistema de Notificação
Testar Notificação - /api/notifications/test
-
Endpoint:
/api/notifications/test -
Método: POST
-
Descrição: Envia notificações de teste (simples, baseadas em modelo ou por e-mail) para verificar a configuração de notificações.
-
Autenticação: Requer sessão válida e token CSRF
-
Corpo da Requisição: Para teste simples:
{"type": "simple","ntfyConfig": {"url": "https://ntfy.sh","topic": "test-topic","accessToken": "optional-access-token"}}
Para teste de modelo:
{
"type": "template",
"ntfyConfig": {
"url": "https://ntfy.sh",
"topic": "test-topic",
"accessToken": "optional-access-token"
},
"template": {
"title": "Test Title",
"message": "Test message with {variable}",
"priority": "default",
"tags": "test"
}
}
Para teste de e-mail:
{
"type": "email"
}
-
Resposta: Para teste simples:
{"message": "Test notification sent successfully"}
Para teste de modelo:
{
"success": true,
"message": "Test notifications sent successfully via NTFY and Email",
"channels": ["NTFY", "Email"]
}
Para teste de e-mail:
{
"message": "Test email sent successfully"
}
O conteúdo do e-mail de teste exibe:
- Nome do host e porta do servidor SMTP
- Tipo de Conexão (SMTP Puro, STARTTLS ou SSL/TLS Direto)
- Status de exigência de autenticação SMTP
- Nome de usuário SMTP (exibido apenas quando a autenticação é necessária)
- Endereço de e-mail do destinatário
- Endereço de origem e nome do remetente usados no e-mail
- Data e hora do teste
- Respostas de Erro:
401: Não autorizado - Sessão inválida ou token CSRF inválido400: Configuração do NTFY é obrigatória, configuração inválida ou e-mail não configurado500: Falha ao enviar notificação de teste com detalhes do erro
- Notas:
- Suporta mensagens de teste simples, notificações baseadas em modelo e testes de e-mail
- O teste de modelo usa dados de exemplo para substituir as variáveis do modelo
- Inclui data e hora na mensagem de teste
- Valida URL e tópico do NTFY antes do envio
- Usa o campo
accessTokenpara autenticação - Para testes de modelo, envia notificações para NTFY e e-mail (se configurado)
- Testes de e-mail exigem que a configuração SMTP esteja configurada
- O endpoint de e-mail de teste limpa o cache de requisição antes de ler a configuração SMTP, garantindo que scripts externos possam atualizar a configuração e que ela seja imediatamente refletida nos e-mails de teste
Verificar Backups Atrasados - /api/notifications/check-overdue
-
Endpoint:
/api/notifications/check-overdue -
Método: POST
-
Descrição: Aciona manualmente a verificação de backups atrasados e envia notificações.
-
Autenticação: Requer sessão válida e token CSRF
-
Resposta:
{"message": "Overdue backup check completed","statistics": {"totalBackupConfigs": 5,"checkedBackups": 5,"overdueBackupsFound": 2,"notificationsSent": 2}} -
Respostas de Erro:
500: Falha ao verificar backups atrasados
-
Notas:
- Aciona manualmente a verificação de backups atrasados
- Retorna estatísticas sobre o processo de verificação
- Envia notificações para os backups atrasados encontrados
Limpar Carimbos de Tempo Atrasados - /api/notifications/clear-overdue-timestamps
-
Endpoint:
/api/notifications/clear-overdue-timestamps -
Método: POST
-
Descrição: Limpa todos os carimbos de tempo de notificação de backup atrasado, permitindo que as notificações sejam enviadas novamente.
-
Autenticação: Requer sessão válida e token CSRF
-
Resposta:
{"message": "Overdue backup notification timestamps cleared successfully"} -
Respostas de Erro:
500: Falha ao limpar os carimbos de tempo de backup atrasado
-
Notas:
- Limpa todos os carimbos de tempo de notificação de backup atrasado
- Permite que as notificações sejam enviadas novamente
- Útil para testar o sistema de notificações