Integrando a API da ZapMe com WHMCS

Apresentação

Versão do Módulo: 1.4

Afim de disponibilizar a plataforma para o cenário de empresas de Hosting virtual preparamos um módulo adicional para sistemas baseados em WHMCS. O módulo consiste em interligar o envio de notificações à ações executadas pelo WHMCS, conhecidas como: hooks. Siga o guia abaixo que detalhada exatamente os passos necessários para uso do módulo da ZapMe no WHMCS.

Instalação do Módulo

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

  2. Extraia o arquivo baixado com o nome: zapme_whmcsXX.zip (onde XX é a versão do módulo)

  3. Após extrair irá criar uma pasta com o nome: zapme_whmcsXX

  4. Abra a pasta raiz do seu WHMCS

  5. Realize o upload da pasta “modules”, que está dentro da pasta zapme_whmcsXX

O local onde o modulo deve ficar é: raiz_do_whmcs/modules/addons/zapme

  1. O módulo foi definido para uso, agora é hora de configura-lo siga o próximo tutorial

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 tutorial

Ativando o Módulo

Insira as informações da API conforme solicitado e pressione “Autenticar e Salvar”. Caso você marque a opção “Status” como Ativado o módulo passará a funcionar desde já se a autenticação da API resultar corretamente.

Importante

Para uso do módulo você deverá criar um campo customizado para dar a opção do cliente cancelar o recebimento das notificações, note que o módulo solicita isso. Então crie um campo com qualquer nome, mas do tipo “Lista de Opções” com os valores Sim,Não em Opções > Campos Personalizados. Ponha o campo como “Obrigatório” e marque também a opção “Mostrar no Formulário de Pedido”. Feito isso volte ao módulo, selecione este campo e salve as configurações.

Detalhes do Módulo

  • Templates

O módulo acompanha templates de mensagens que são utilizado como base para as notificações enviadas quando determinadas ações ocorrem no sistema. Você pode editar os templates como quiser na aba “Templates” contida no módulo. Note que cada template é único para uma ação e nele há variáveis de acordo com a ação vinculada ao template. Lembre-se de tornar o template personalizado como quiser, o sistema permite o uso de todas as formatações padrões, e se por acaso você desativar o uso de um template em específico, você estará desabilitando a ação de envio de mensagens relativa com aquela ação do template

  • Logs

Na aba Log você poderá acompanhar o log de todas as transações de envios de mensagens efetuadas pelo módulo até a API da ZapMe, facilitando assim saber para quem a mensagem foi enviada e quando foi enviada

  • Adicionais

A partir da versão 1.3 adicionamos 3 (três) condicionais de ações em torno do WHMCS situado sobre botões em diferentes páginas que acionam envio manual de mensagem ou templates prontos para emissão de notificações imediatas. Os botões são exibidos em diversas áreas do WHMCS, como: detalhes do cliente, detalhes da fatura e detalhe do serviço, quando o status do módulo estiver como “Ativado”, veja algumas imagens sobre:

../../_images/1.png ../../_images/2.png ../../_images/3.png ../../_images/4.png