Como configurar webhooks e notificações para o seu servidor Hytale

Por : nome Categoria: guides : minutos min ler

HytaleCharts oferece várias opções de integração para proprietários de servidores: Discord webhooks para notificações de voto, suporte Votifier (v1, v2 e HTTP) para recompensas no jogo, webhooks genéricos com cargas úteis personalizáveis, um plugin de batimento cardíaco para rastreamento de status online e uma API de servidor público. Este guia caminha através da configuração de cada um.

HytaleCharts fornece várias opções de integração que permitem conectar seu Hytale servidor listando Discord, seu servidor de jogo e ferramentas externas. Quando um jogador vota para o seu servidor, você pode receber uma notificação de Discórdia, acionar recompensas no jogo via Votifier, disparar um webhook personalizado para sua própria infra-estrutura, e manter seu status do servidor atualizado com o plugin batimento cardíaco. Este guia cobre como configurar cada integração do zero. Todos esses recursos estão acessíveis a partir da página de edição do seu servidor no HytaleCharts após iniciar sessão como proprietário do servidor ou membro da equipe. Discord Vote Webhooks Os webhooks de discórdia permitem que você receba uma notificação em um canal de discórdia cada vez que alguém vota para, favoritos, ou deixa uma revisão em sua lista de servidor. Setting Up Discord Webhooks Criar um webhook no seu servidor Discord. Vá para Configurações do servidor, em seguida, Integrações, em seguida, Webhooks. Clique em "New Webhook", dê-lhe um nome (por exemplo, "HytaleCharts Votes"), escolha o canal e copie o URL do webhook. Add the webhook URL on HytaleCharts. Vá para a página de edição do seu servidor, encontre a seção Discord Webhook e cole o URL. Salve suas configurações. Hitale Os gráficos agora enviarão uma incorporação formatada ao seu canal Discord sempre que ocorrer um evento de votação, favorito ou revisão. O que é enviado Cada notificação webhook é enviada como uma incorporação Discord contendo: O tipo de evento (votação, favorito, revisão) O nome de usuário do jogador que realizou a ação A timestamp Seu nome do servidor e um link de volta para sua lista de HytaleCharts A entrega do Webhook utiliza um sistema de repetição com 3 tentativas e um retrocesso de 5 segundos entre repetições. Se todas as tentativas falharem, a falha é registrada, e HytaleCharts rastreia falhas consecutivas por servidor. Se um URL do webhook falhar consistentemente (retorna erros HTTP ou times out), ele eventualmente será sinalizado para que você possa atualizá-lo ou corrigi-lo. Votista: Recompensas de Voto no Jogo Votifier é um protocolo que envia notificações de voto diretamente para seu servidor de jogo, permitindo que você recompense os jogadores no jogo quando votarem no HytaleCharts. Hitale Os gráficos suportam três variantes Votificantes. Votifier v1 (RSA Encriptado) O protocolo Votifier original usa criptografia RSA. Quando um voto é lançado, o HytaleCharts criptografa uma mensagem de voto com a chave pública do seu servidor e a envia via TCP. Para configurar o Votificante v1: Instale um plugin compatível com Votifier no seu Servidor Hytale Gerar um par de chaves RSA (o plugin geralmente faz isso automaticamente na primeira execução) Copia a tua chave pública. a partir da configuração do plugin Em Hytale Gráficos, vá para a página de edição do seu servidor e defina o tipo Votifier como "v1" Digite o servidor host (endereço IP ou domínio), port (a porta de escuta Votifier, não a porta de jogo), e cole a chave pública Salve e use o botão "Teste Conexão" para verificar se funciona A mensagem de voto segue o formato normal de Votificadores: VOTE\nHytaleCharts\n{username}\n{ip_address}\n{timestamp}\n, criptografado com PKCS#1 v1.5 padding. Votifador v2 (HMAC-SHA256) Votifier v2 é o protocolo mais moderno. Em vez de criptografia RSA, ele usa HMAC-SHA256 assinando com um token compartilhado. O aperto de mão inclui uma string de desafio do servidor para evitar ataques de repetição. Para configurar o Votificante v2: Instalar um v2 compatível Plug- in de Votificação Encontrar o token (segredo compartilhado) no arquivo de configuração do plugin Em Hytale Gráficos, defina o tipo Votificante como "v2" Entre no servidor host, port, e token Salve e teste a conexão O protocolo v2 conecta via TCP, lê uma saudação aperto de mão com um token de desafio, então envia um pacote binário contendo uma carga útil JSON assinada com HMAC-SHA256. A carga útil inclui o nome do serviço ("HytaleCharts"), nome de usuário, endereço IP, timestamp em milissegundos e a string de desafio. Votificador de HTTP Para plugins específicos para Hytale que usam HTTP em vez de TCP bruto, HytaleCharts suporta um modo de endpoint HTTP. Este é o protocolo mais simples a ser implementado para os desenvolvedores de plug-ins. Para configurar o Votificador HTTP: Instale um plug-in que expõe um endpoint HTTP para receber votos Em Hytale Gráficos, defina o tipo Votificante como "HTTP" Entrar na URL completa endpoint (por exemplo, https://your-server.com:8080/vote) Se o plugin necessitar de um token, digite-o no campo token. HytaleCharts assinará o pedido com uma assinatura HMAC-SHA256 no cabeçalho X-Votifier-Signnature. Salvar e testar A solicitação HTTP envia um corpo JSON com serviceName, usuário, endereço e timestamp campos. Notas importantes para todos os tipos de votificantes Usernames são truncados em 16 caracteres para corresponder ao limite de usuário de Hytale. HytaleCharts usa o nome de usuário Hytale do jogador, caso contrário, seu nome de usuário Discord. Tempo limite de conexão é de 5 segundos. Se seu servidor não responder dentro de 5 segundos, a tentativa é considerada falha. Tentativas falhadas tentam até 3 vezes com retrocesso exponencial (10s, 30s, 60s entre tentativas). Você pode usar o botão Test Connection no HytaleCharts para verificar sua configuração sem precisar de um voto real. Isso verifica que o servidor é acessível e responde com o aperto de mão Votifier esperado. Generic Webhooks Se você quer enviar notificações de voto para seu próprio serviço de infraestrutura, bot ou aplicativo, webhooks genéricos permitem definir um URL personalizado e modelo de carga útil. Como funcionam os Webhooks genéricos Na página de edição do seu servidor, navegue até a seção de configuração do webhook Digite o URL do seu endpoint Configure o modelo payload com os dados que deseja receber Salve suas configurações Quando um evento de votação ocorre, HytaleCharts envia uma solicitação HTTP POST para sua URL com a carga útil configurada. O sistema suporta variáveis de modelo que são substituídas por valores reais no momento do envio (nome de usuário do voto, nome do servidor, timestamp, etc.). Os webhooks genéricos usam a mesma lógica de repetição que os webhooks Discord: 3 tentativas com retrocesso progressivo (10s, depois 30s entre repetições). Se todas as tentativas falharem, a falha é rastreada contra o seu servidor, e falhas persistentes serão marcadas no seu painel. Plugin Heartbeat: Rastreamento de status online O plugin de batimento cardíaco HytaleCharts é executado em seu servidor de jogo e envia atualizações periódicas de status para que sua listagem sempre mostre status online/offline preciso e conta o jogador. Como Funciona O plugin envia um batimento cardíaco para https://hytalecharts.com/api/heartbeat a cada 5 minutos (ou a cada 20 segundos para servidores premium). Cada batimento cardíaco inclui: O seu servidor é segredo de batimento cardíaco (um token hexadecimal de 64 caracteres) Contagem atual jogador e jogadoresmáx A jogadores array com detalhes individuais do jogador (nome de usuário, UUID, mundo, ping) Os metadados do servidor como nome do servidor, MOTD, tempo de serviço e uso de memória Uma lista de plugins instalados e nomes do mundo Setup Steps Gerar um segredo de batimento cardíaco. Na página de edição do seu servidor, vá para a seção Heartbeat e clique em "Generate Secret." Isto cria um único token de 64 caracteres. Instale o plugin. Coloque o plugin HytaleCharts no mods/ do seu servidor diretório. Configure o plugin. Edite o arquivo config.json do plugin e defina o segredo: { "segredo": "Your_64_CAR_HEARTBEAT_SECRET", "debug": false } Reinicie seu servidor. O plugin começará a enviar batimentos cardíacos imediatamente. Verify on HytaleCharts. Verifique a página de edição do seu servidor; ele deve mostrar a última hora do batimento cardíaco e indicar que a conexão está ativa. Agregação Multi-Server Se você executar várias instâncias do servidor (lobby, survival, creative) compartilhando o mesmo segredo do batimento cardíaco, o HytaleCharts automaticamente as agrega. Ele identifica instâncias distintas pelo seu endereço IP e nome do servidor, pega o último batimento cardíaco de cada um, e mescla os jogadores pelo UUID para evitar a contagem dupla. A contagem total de jogadores e max jogadores mostrados na sua lista refletem os valores combinados em todas as instâncias. Prioridade de Estado Online Hytale Os gráficos determinam o status online do seu servidor usando um sistema de prioridade: Endpoint de consulta externa (se configurado, por exemplo, API de consulta Nitrado) Plugin de batimento cardíaco (o servidor mostra como online se um batimento cardíaco foi recebido nos últimos 5 minutos) UDP ping (fallback server query) Se o plug-in de batimento cardíaco ficar silencioso por mais de 5 minutos e nenhuma consulta externa estiver configurada, o servidor cai para o estado de ping UDP. Tokens de API de servidor público HytaleCharts fornece uma API pública que permite consultar dados de eleitores, estatísticas de servidores e outras informações programáticamente. Para usá-lo, você precisa de um token de API. Obtendo sua API Token Vá para a página de edição do seu servidor no HytaleCharts Navegar para a seção API Gerar um token de API Copia e armazena com segurança. O token autentica todas as solicitações aos endpoints públicos da API do servidor. Usando a API Inclua o token no cabeçalho Autorização de suas solicitações de API: GET /api/public/servidores/{server_id}/voters Autorização: Carregador YOU_API_TOKEN A API pública permite obter eleitores recentes, estatísticas de servidores e outros dados que você pode usar para construir integrações personalizadas, leaderboards ou sistemas de recompensa no seu servidor. Para documentação completa da API e detalhes do endpoint, verifique o Server API page no HytaleCharts. Troubleshooting Issue Possível causaSolução Discord webhook não enviandoInvalid webhook URLExcluir e recriar o webhook em Discord, em seguida, atualizar o URL em HytaleCharts Teste de Votifier falha com "No response"Firewall bloqueando a porta Votifier Certifique-se de que a porta Votifier (não a porta do jogo) está aberta em seu firewall O teste de votifier diz "Aperto de mão V2 inválido"Server só suporta v1 mas você selecionou v2Mudar o tipo de Votifier para v1 e fornecer a chave pública RSA em vez de um token Heartbeat não registrandoSegredo errado na configuração do pluginDouble-check que o segredo na configuração. json corresponde ao mostrado no HytaleCharts exatamente A contagem de jogadores mostra 0Versão de plugin com mais de 1,5.0Atualizar o Hytale Plug-in de gráficos para a versão mais recente, que envia dados individuais do jogador Webhook marcado como falhando100+ falhas consecutivasFix the endpoint URL, em seguida, testá-lo. A entrega bem-sucedida reinicia o contador de falhas. Se você se deparar com problemas não cobertos aqui, contate através do formulário de contato no HytaleCharts. Podemos verificar os registros de webhook do seu servidor e histórico de batimentos cardíacos para ajudar a diagnosticar problemas. A definição dessas integrações leva alguns minutos, mas melhora significativamente como seu servidor interage com HytaleCharts e sua comunidade. Servidores com notificações de votação ativa e recompensas no jogo veem consistentemente maior engajamento e retorno de visitas de eleitores. Procure outras listas de servidores para ver como os servidores de topo descrevem seus recursos de integração e certifique-se de que sua própria listagem menciona o que você configurou.