Módulo Conta Azul para WHMCS
&
O Módulo de Integração Gofas Conta Azul para WHMCS sincroniza os clientes e vendas do seu WHMCS com sua Conta Azul.
Principais funcionalidades
✓ Criação de clientes automática. Cria uma conta de cliente no Conta Azul, sempre que um cliente é cadastrado no WHMCS.
✓ Importação de clientes em massa. Importe todos os clientes do WHMCS para a Conta Azul com apenas um clique.
✓ Criação automática de vendas. Cria uma venda no Conta Azul quando uma fatura do WHMCS é gerada ou paga, você escolhe.
✓ Datas alternativas. Você pode optar por criar a venda no Conta Azul com a data de pagamento ou de criação da fatura no WHMCS.
✓ Sincroniza serviços. Vincula serviços criados no painel Conta Azul aos respectivos serviços no WHMCS quando uma venda é criada.
✓ Gere campos personalizados. Cria o campo personalizado necessário para a sincronização dos IDs de clientes Conta Azul.
✓ Custom field "Complemento". havendo um campo personalizado de cliente com o nome "Complemento" no seu WHMCS, ele será enviado com o endereço dos clientes à API CA.
Instalação
- Copie a pasta
/modules/addons/gofascontaazul/para dentro do diretório padrão de módulos addons do WHMCS:/whmcs/modules/addons/. - Ative o Addon em
Opções > Módulos Addons; - Após a ativação, defina os grupos de administradores que terão acesso à tela de configuração. Apenas usuários autorizados a acessar o painel Conta Azul devem ter acesso à essa área.
Configuração
Configuração da API Conta Azul
- Faça login em portaldevs.contaazul.com e clique em "Criar Aplicação";
- Preencha o nome e descrição;
- Preencha o campo URI de redirecionamento com o URL de callback exibido nas configurações do módulo, o formato esperado é
https://exemplo.com.br/modules/addons/gofascontaazul/callback.php. Clique em "Avançar"; - Escolha a opção "Online/Nuvem" no campo "Tipo de software" e no campo "Segmento do Software" escolha a opção "Pagamentos" e clique em "Salvar e finalizar".
- Copie em um lugar seguro as credenciais client_id e client_secret, serão necessárias a seguir para configurar o módulo no WHMCS.
Configurações do Módulo
- Chave de licença: Obtida ao adquirir o módulo;
- Client ID: Insira a chave Client ID da aplicação;
- Client Secret: Insira a chave Client Secret da aplicação;
- Quando criar a venda: Escolha se as vendas devem ser criadas quando a fatura é gerada ou paga;
- Data da venda: Escolha se a venda no Conta Azul será criada com a data de criação ou de pagamento da fatura;
- Nota administrativa: Defina um texto padrão que será adicionado ao campo "Notas" das vendas criadas via módulo;
- Debug: Marque essa opção para salvar informações de diagnóstico no Log de Módulo do WHMCS;
- ID do serviço padrão Conta Azul: ID do serviço padrão para faturas não associadas à serviços do WHMCS;
- Vincular serviços Conta Azul > WHMCS:
Serão exibidos cada um dos serviços cadastrados no WHMCS ao lado de um campo de texto para inserir o ID do respectivo serviço existente na sua Conta Azul.
O ID do serviço pode ser obtido no URL ao editá-lo no seu painel CA. O ID é encontrado após a última / do link, como no trecho em negrito deste exemplo:https://app.contaazul.com/#/servicos/editar/56187060-0cf3-4eb7-8605-51cc5b0cbdb1.
Veja essa imagem para mais detalhes.
Campo personalizado ID do cliente Conta Azul
Acesse no painel administrativo do WHMCS, o menu Configurações > Campos Personaliz. Clientes e crie um custom field que contenha as palavras "Conta Azul", exemplo: "ID do cliente no Conta Azul".
Esse campo será preenchido automaticamente sempre que um cliente se cadastrar, ele é necessário para que as vendas sejam associadas aos respectivos clientes, quando uma venda é criada via integração.
Você pode utilizar esse campo para sincronizar clientes já cadastrados no WHMCS e Conta Azul antes da instalação do módulo, adicionando os IDs Conta Azul aos campos das mesmas contas de cliente no WHMCS.
(27/01/2021): A partir da versão 1.2.0 o módulo cria automaticamente o campo personalizado de cliente com o nome "ID Conta Azul" na ativação, caso ainda não exista.
Ativação do Módulo
- Acesse o menu
Opções > Módulos Addons > Gofas Conta Azule clique em "Obter Autorização". Você será redirecionado para o portal Conta Azul; - Na página de autorização da API Conta Azul, clique em "Autorizar". Você será redirecionado de volta para o painel do WHMCS e a mensagem de confirmação será exibida no topo da tela;
A API Conta Azul requer que a primeira autorização seja realizada manualmente, após esse passo você não precisará mais acessar essa página a menos que reconfigure o módulo. A renovação de autorização da API acontece automaticamente a cada 5 minutos via cron job do WHMCS. No caso de acontecer algum erro que interrompa a renovação de autorização, o módulo notifica os administradores do WHMCS por email para que verifiquem a integração.
Importação de clientes
- Acesse o menu
Addons > Gofas Conta Azule clique em "Sincronizar clientes".
O módulo irá criar uma conta para cada cliente do WHMCS no seu painel de controle Conta Azul, caso o mesmo cadastro ainda não exista em ambos os sistemas.
Ao final da importação será exibido na tela a lista de todas as contas de cliente importadas e verificadas.
Informações importantes
- Campo personalizado CPF/CNPJ: É necessário criar um campo personalizado de cliente nas configurações do WHMCS para CPF ou CNPJ. Você pode criar apenas um campo onde o cliente pode preencher com CPF ou CNPJ, ou então criar dois campos distintos, um para cada documento. O módulo identifica automaticamente os campos personalizados pelos seus respectivos nomes;
- Endereço: Endereços devem ser preenchidos no formato padrão do WHMCS, com logradouro e nº na mesma linha (campo "endereço 1"[address 1]), exemplo:
"Avenida Brasil, 1234";