For the complete documentation index, see llms.txt. This page is also available as Markdown.

Integração API — Envio de Mensagens e Alertas (Formato JSON)

O sistema permite integrar o envio automático de mensagens via API utilizando o formato JSON.

Esse recurso é ideal para integração com:

  • APIs de botões interativos

  • API Oficial do WhatsApp (Templates Meta)


Onde configurar

Acesse:

Painel SaaS → Comunicação → Notificações WhatsApp

Nessa tela:

  • URL DA API — informe a URL da API que receberá os envios

  • Token — informe o token da API


Configurações Disponíveis

Habilitar envio no formato JSON

Com essa opção ativada, os dados enviados pela API serão no formato JSON, útil para integração com APIs de botões ou com a API oficial do WhatsApp (templates).


Habilitar envio WhatsApp enviar solicitar teste

Quando ativado, o sistema envia automaticamente uma mensagem de boas-vindas após o cadastro do teste.

Exemplos de uso:

  • Enviar acesso do sistema

  • Enviar botão de acesso

  • Enviar template oficial

  • Enviar link do painel

  • Enviar dados de login


Habilitar envio WhatsApp aviso fatura em aberto

Quando ativado, o sistema envia alertas automáticos de cobrança:

  • 7 dias antes do vencimento

  • 3 dias antes

  • 1 dia antes

  • No dia do vencimento

Pode ser utilizado com:

  • Link botões


Habilitar envio WhatsApp confirmando pagamento

Envia uma mensagem no WhatsApp após a confirmação do pagamento da fatura.

Exemplos de uso:

  • Confirmação do pagamento

  • Liberação do sistema

  • Agradecimento

  • Renovação automática


Enviar mensagem WhatsApp ao cadastrar afiliado

Mensagem enviada quando um novo afiliado se cadastra pela página pública.

Usa as mesmas configurações de URL/token acima.


URL da API

Informe a URL correta do endpoint da integração no campo URL DA API.

Exemplos

API Plus

API Oficial


Token da API

Informe o token da API no campo Token. O token é utilizado para autenticar as requisições de envio.


Uso de Variáveis

O sistema suporta variáveis dinâmicas utilizando o formato:

As variáveis serão substituídas automaticamente pelas informações reais no momento do envio da mensagem.


Variáveis disponíveis — Solicitação de Teste / Boas-vindas

Variável
Descrição

{{number}}

Número do WhatsApp

{{senha}}

Senha de acesso

{{email}}

E-mail cadastrado

{{nomeresponsavel}}

Nome do responsável

{{nomeempresa}}

Nome da empresa


Variáveis disponíveis — Cobrança e Pagamento

Variável
Descrição

{{nomeempresa}}

Nome da empresa

{{value}}

Valor da cobrança

{{dueDate}}

Data de vencimento

{{plan}}

Nome do plano

{{number}}

Número do WhatsApp


Exemplo JSON — Mensagem de Boas-vindas com Botão


Exemplo JSON — Aviso de Fatura em Aberto


Exemplo JSON — Template Oficial WhatsApp (Meta)

Também é possível utilizar templates oficiais aprovados pela Meta.

Exemplo — Template Confirmação de Pagamento


Exemplo JSON — Template de Cobrança


Informações Importantes

  • O JSON deve ser válido.

  • As variáveis devem ser escritas exatamente no formato {{variavel}}.

  • Compatível com APIs próprias e integrações externas.

  • Pode ser utilizado para mensagens simples, botões ou templates oficiais do WhatsApp.

  • Os templates utilizados na API Oficial precisam estar previamente aprovados na Meta.

  • É possível personalizar totalmente o JSON conforme a estrutura aceita pela API.

Atualizado