O que é
A área de API e webhooks permite integrar o painel com sistemas externos: clientes de API (com tokens) para automação a partir de outros sistemas, e webhooks para notificar ou disparar ações (como deploy) a partir de eventos externos.
Esta página trata dos clientes de API do módulo de usuários (gestão de clientes). Para chamar as ações do painel (sites, cache, backup, instalações) a partir do n8n ou do Make, ou ligar um agente de IA, use a Automação/MCP: ver API para automações.
Clientes de API
Você cria um cliente de API, que recebe um token. Esse token autentica chamadas externas ao painel dentro do escopo permitido — é a base para automatizar a gestão de clientes a partir de um gateway de pagamento (Asaas, Stripe, Hotmart, ou qualquer outro que dispare webhook) usando uma ferramenta como o n8n.
- Em Configurações → API e webhooks, crie um cliente de API.
- Guarde o token gerado (ele autentica as chamadas, sem sessão de login).
- Para revogar, rotacione o token: o antigo deixa de valer.
Trate o token como uma senha. Se ele vazar, rotacione imediatamente. Cada cliente de API tem escopo próprio, então conceda só o necessário.
Endpoints da gestão de clientes
Com o token, a API de clientes cobre o mesmo que o formulário manual do painel (ver Criando um usuário cliente):
| Ação | Para quê |
|---|---|
| Listar clientes | Traz todos os clientes cadastrados |
| Consultar um cliente | Dados de um cliente específico, pelo login |
| Criar cliente | Login, senha, nome, e-mail, sites atribuídos, cota de disco, permissão de |
| excluir e tipos de instalação — os mesmos campos do cadastro manual | |
| Atualizar cliente | Altera qualquer um desses campos de um cliente existente |
| Excluir cliente | Remove a conta |
| Resetar o 2FA do cliente | Destrava um cliente que perdeu o acesso ao autenticador |
Sem experiência com API? A própria documentação do GW Server serve de referência para uma ferramenta de IA (Claude, por exemplo) montar a integração com o gateway de pagamento da sua escolha — o suporte não cobre integrações de terceiros, mas a API é aberta o suficiente para isso.
Webhooks
Webhook é um aviso automático entre sistemas: em vez de alguém ficar consultando se algo mudou, o sistema avisa sozinho assim que acontece. O painel usa isso nos dois sentidos:
- De saída: o painel avisa um endereço seu quando algo acontece no servidor (por exemplo, um cliente atingindo o limite de disco).
- De entrada (deploy): um endereço do painel que, ao ser chamado, dispara a publicação de uma aplicação. É assim que um Node App se atualiza sozinho quando você envia código para o Git.
A configuração inclui um segredo, que comprova que o chamado veio de quem devia, e um botão de testar (envia um evento de exemplo, para você conferir o formato JSON que chega no seu endpoint).
Eventos disponíveis (webhooks de saída)
| Evento | Quando dispara |
|---|---|
user.created |
Cliente criado |
user.updated |
Cliente atualizado |
user.deleted |
Cliente excluído |
user.plan.updated |
Plano, cotas ou acessos do cliente alterados |
user.storage.exceeded |
Cliente acima do limite de armazenamento |
user.sites.limit_reached |
Cliente tentou instalar acima da própria cota |
user.login_blocked |
Login de um cliente foi bloqueado |
user.module_disabled |
O módulo de usuários ficou indisponível/desativado |
site.installed |
Um site foi instalado |
app.installed |
Uma aplicação foi instalada |
O painel confere a assinatura de cada chamada e recusa endereços de destino que apontem para dentro do próprio servidor: assim um webhook não vira caminho para alcançar serviços internos.
