Integrando a API da ZapMe com WHMCS

Data de Lançamento: 17/10/2021

Características:

  • Versão do Principal Módulo: 2.0.0

  • Atualizações: 1 ano de atualizações garantidas

  • Compatibilidade: WHMCS 7.9+

  • Versão do PHP: 7.3+

Instalando do Módulo

  1. Ative a API conforme descrito no inicio da documentação clique aqui e saiba mais

  2. Faça o download da última versão disponível do módulo clique aqui e saiba mais

  3. Extraia os arquivos do módulo dentro de uma pasta chamada: zapme

  4. Faça upload da pasta zapme para: raiz_do_whmcs/modules/addons/zapme

  5. Siga o próximo passo abaixo.

Configurando o Módulo

  1. Acesse a sessão administrativa do WHMCS

  2. Navegue por: Opções > Modulos Addons > Procure por “ZapMe”:

  3. Na parte direita da tela, clique em “Ativar” e aguarde…

  4. Na parte direita da tela, clique em “Configurar” e marque a opção “Full Administrator” e salve

  5. Navegue por: Addons > ZapMe

  6. Siga o próximo passo abaixo.

Configurando Dependências do Módulo

  1. Para uso do módulo você deverá criar um campo customizado para dar a opção do cliente cancelar o recebimento das notificações emitidas pelo módulo. Crie um campo customizado com qualquer nome, mas do tipo “Lista de Opções” com os valores Sim,Não. Ponha o campo como “Obrigatório” e marque também a opção “Mostrar no Formulário de Pedido”. Este campo será selecionado mais tarde, na hora de ativar o módulo.

  2. Você tem duas alternativas para seleção do telefone do cliente que receberá as notificações: I. Você pode utilizar o campo padrão de telefones do WHMCS. II. Você pode criar um campo customizado para que o cliente preencha o telefone que ele deseja receber as notificações emitidas pelo módulo. Este campo será selecionado mais tarde, na hora de ativar o módulo.

Ativando o Módulo

  1. Acesse o módulo e configure conforme solicitado.

A tela de configuração principal do módulo:

../_images/12.png

Aviso

Se você selecionar "Nenhum" na opção "Consentimento de Mensagens" o módulo sempre encaminhará as mensagens aos clientes, independente de haver um campo customizado para controlar o consentimento do cliente ou não, conforme explicado acima.

Detalhes do Módulo: Templates

O módulo oferece ao todo 18 templates de mensagens diferentes associado com ações do WHMCS:

  1. Fatura Criada

  2. Lembrete de Fatura

  3. Fatura Paga

  4. Fatura Cancelada

  5. Fatura em Atraso [1]

  6. Fatura em Atraso [2]

  7. Fatura em Atraso [3]

  8. Ticket Criado

  9. Ticket Respondido

  10. Serviço Criado

  11. Serviço Suspenso

  12. Serviço Reativado

  13. Serviço Cancelado

  14. Serviço Pronto (uso manual)

  15. Bem-vindo

  16. Login de Cliente

  17. Falha de Login

  18. Troca de Senha

../_images/21.png

Aviso

Na versão atual não há suporte a nenhuma ação envolvendo os usuários administradores do WHMCS.

Detalhes do Módulo: Suporte à Boletos Bancários do PagHiper

O módulo oferece suporte ao Boleto Bancário do PagHiper com a possibilidade de extrair o código de barras de um boleto e anexa-lo a mensagem ou até mesmo anexar o boleto em formato PDF ao envio da mensagem seguindo as seguintes regras:

  1. O módulo do PagHiper estiver configurado, ativado e marcado como visível.

  2. A fatura for superior à R$ 3,00.

  3. fatura estiver com o método de pagamento PagHiper.

Os templates que recebem suporte ao PagHiper são:

  1. Fatura Criada

  2. Lembrete de Fatura

  3. Fatura em Atraso [1]

  4. Fatura em Atraso [2]

  5. Fatura em Atraso [3]

Importante

Leia atentamente a como deve ser configurado as variáveis dos templates para que o tanto o código de barras quanto o boleto bancário em formato PDF sejam anexados corretamente aos envios de mensagens.

Detalhes do Módulo: Regras de Envio dos Templates

As regras de envio são regras que permitem abortar o envio de uma mensagem. Dessa forma é possível configurar o módulo para abortar o envio de uma certa mensagem se alguma regra for identificada no momento do envio, como por exemplo: não enviar mensagens a um cliente em específico através do seu ID.

Exemplo das regras de envio disponíveis no template (#10) Serviço Criado:

../_images/31.png

Aviso

Todos os templates possuem regras de envio, com excessão do template (#14) Serviço Pronto.

Detalhes do Módulo: Logs

Ao acessar a aba “Logs” você terá acesso ao registro de todas as mensagens enviadas pelo módulo.

Ao pressionar o botão com simbolo de uma lupa, a direita da tela, você poderá ter a extração do status da mensagem através do relatório real oferecido pela ZapMe. Você pode apagar os logs à qualquer momento pressionando o botão em vermelho: “Apagar Registros”.

Se você preferir você pode ativar a opção “Auto. Remoção dos Registros de Logs” na interface de configuração do módulo, para que todo primeiro dia de cada mês os logs do módulo sejam automaticamente removidos do banco de dados.