Como usar a API e os webhooks

Para integrar o panel4you a outros sistemas, você gera uma chave de API no menu Configurações e configura webhooks, que enviam um aviso ao seu sistema sempre que um evento acontece, como uma senha gerada ou chamada. A referência técnica completa está em https://app.panel4you.io/developers/docs.

Gerar uma chave de API

1. No menu lateral, em Gestão, clique em Configurações. O menu aparece para as funções Proprietário e Administrador.
2. Abra a aba API Keys.
3. Clique para criar uma nova chave e preencha:
   • Nome da Chave, por exemplo “Integração CRM”.
   • Descrição (opcional), para lembrar onde a chave é usada.
   • Permissões: escolha entre Leitura (Webhooks e Painéis), Webhooks (Leitura e Escrita), Painéis e Senhas (Leitura) ou Completo (Leitura e Escrita).
   • IPs Permitidos (opcional): lista de endereços IP autorizados a usar a chave. Em branco, qualquer IP é aceito.
4. Clique em Criar Chave.
5. Copie o token exibido e guarde em local seguro. Ele é mostrado uma única vez.

Na lista Suas Chaves de API você acompanha o status, as permissões e o último uso de cada chave, e pode desativar ou excluir uma chave que não é mais usada.

Como funcionam os webhooks

Webhooks são requisições HTTP POST que o panel4you envia para um endereço do seu sistema quando um evento ocorre. Os eventos documentados são:

• ticket.generated: uma nova senha foi gerada.
• ticket.called: uma senha foi chamada para atendimento.
• ticket.completed: uma senha foi concluída.
• queue.created: uma nova fila foi criada.

Cada entrega inclui o cabeçalho X-Webhook-Signature, com a assinatura HMAC-SHA256 do conteúdo, e o cabeçalho X-Webhook-Delivery, com um identificador único da entrega. Verifique sempre a assinatura antes de processar o evento, para garantir que a requisição veio do panel4you.

O cadastro dos webhooks é feito pela própria API. O formato da requisição, os exemplos de payload e os trechos de verificação de assinatura em Node.js, Java e Python estão na documentação, nas seções Webhooks, Autenticação, Eventos e Exemplos.

Boas práticas de segurança

• Use sempre HTTPS no endereço que recebe os webhooks.
• Nunca publique o token em código aberto ou em repositórios.
• Restrinja a chave por IP quando possível.
• Dê a cada chave apenas as permissões necessárias.
• Exclua as chaves que não são mais usadas.

Dúvidas comuns

Perdi o token da chave. Consigo ver de novo?

Não. O token completo aparece apenas no momento da criação. Crie uma nova chave e exclua a anterior.

A API está disponível em todos os planos?

O acesso à API é um recurso que depende do plano. Confira o que cada plano inclui em /planos/.

Meu endpoint não está recebendo os eventos. O que verificar?

Confirme que o endereço está acessível pela internet, responde com status 2xx e valida corretamente a assinatura HMAC. A seção Erros da documentação lista os códigos de resposta e os passos de diagnóstico.

Onde vejo exemplos de uso?

Na documentação em https://app.panel4you.io/developers/docs e no artigo /api-e-relatorios-avancados-panel4you/.