Pular para o conteúdo principal

Configuração

Após instalar e ativar o módulo de Integração WHMCS, você precisa configurar a conexão com sua instância WHMCS e definir como os dados fluem para o Perfex CRM. Esta página aborda a configuração da API, preferências de sincronização, mapeamento de campos e agendamento automatizado.

Conectando ao WHMCS​

O módulo se comunica com o WHMCS através da API oficial. Você precisará de credenciais de API válidas antes de prosseguir.

Gerando Credenciais da API WHMCS​

  1. Faça login na sua Área Admin do WHMCS.
  2. Navegue até Setup > Staff Management > Manage API Credentials.
  3. Clique em Generate New API Credential.
  4. Insira uma descrição (ex.: "Integração Perfex CRM").
  5. Copie o API Identifier e o API Secret — você precisará de ambos na próxima etapa.
aviso

Armazene suas credenciais de API com segurança. O API Secret é exibido apenas uma vez durante a criação. Se perdido, você precisará gerar novas credenciais.

Inserindo Credenciais no Perfex CRM​

  1. No Perfex CRM, navegue até as configurações do módulo WHMCS Integration.
  2. Insira os seguintes detalhes:
    • WHMCS URL — a URL completa da sua instalação WHMCS (ex.: https://billing.example.com)
    • API Identifier — o identificador gerado na etapa anterior
    • API Secret — a chave secreta gerada na etapa anterior
  3. Clique em Test Connection para verificar se o Perfex CRM consegue se comunicar com sucesso com sua instância WHMCS.
  4. Clique em Save Settings após o teste de conexão ser aprovado.
dica

Se o teste de conexão falhar, certifique-se de que o endereço IP do servidor do Perfex CRM esteja na lista de permissões do WHMCS em Setup > General Settings > Security > API IP Access Restriction. Verifique também se o HTTPS está configurado e se a URL do WHMCS está correta.

Configurações de Sincronização​

O painel de configurações de sincronização permite controlar quais dados são importados e como são tratados dentro do Perfex CRM.

Tipos de Dados​

Tipo de DadoDescrição
ClientsSincronizar perfis de clientes incluindo nome, e-mail, telefone, endereço e detalhes da empresa
InvoicesSincronizar faturas com itens de linha, totais, impostos, status de pagamento e datas de vencimento
ContactsSincronizar contatos adicionais associados a cada conta de cliente WHMCS

Ative ou desative cada tipo de dado de acordo com suas necessidades. No mínimo, Clients deve estar habilitado, pois faturas e contatos estão vinculados a registros de clientes.

Tratamento de Duplicatas​

Quando um registro sincronizado corresponde a um cliente existente no Perfex CRM (correspondência por endereço de e-mail), você pode escolher como lidar com o conflito:

  • Skip — não importar o registro se já existir uma correspondência
  • Update — sobrescrever o registro existente no Perfex CRM com dados do WHMCS
  • Create New — criar um registro separado independentemente de duplicatas
informação

A configuração recomendada é Update, que mantém seus dados do Perfex CRM sincronizados com o WHMCS evitando entradas duplicadas de clientes.

Mapeamento de Campos​

A seção de mapeamento de campos permite definir como os campos do WHMCS correspondem aos campos do Perfex CRM. O módulo vem com padrões sensatos, mas você pode personalizar mapeamentos para:

  • Campos padrão — nome, e-mail, telefone, endereço, empresa, cidade, estado, CEP, país
  • Campos personalizados — mapear campos personalizados do WHMCS para campos personalizados do Perfex CRM

Para editar mapeamentos de campos:

  1. Vá até WHMCS Integration > Settings > Field Mapping.
  2. Para cada campo do WHMCS, selecione o campo correspondente do Perfex CRM no menu suspenso.
  3. Clique em Save Mapping.

Agendamento de Sincronização Automática​

Em vez de executar sincronizações manualmente, você pode configurar um agendamento automatizado usando um cron job do servidor.

Configurando o Cron Job​

Adicione a seguinte entrada ao crontab do seu servidor para executar a sincronização no intervalo desejado:

# Executar sincronização WHMCS a cada 6 horas
0 */6 * * * php /path/to/perfex/index.php whmcs_integration sync >/dev/null 2>&1

Ajuste o tempo do cron com base na frequência com que seus dados do WHMCS mudam. Intervalos comuns incluem:

IntervaloExpressão CronCaso de Uso
A cada hora0 * * * *Ambientes de faturamento de alto volume
A cada 6 horas0 */6 * * *Uso padrão (recomendado)
Uma vez ao dia0 2 * * *Ambientes de baixo volume
aviso

Executar a sincronização com muita frequência em grandes conjuntos de dados pode aumentar a carga do servidor. Monitore os recursos do servidor após habilitar a sincronização automatizada e ajuste o intervalo conforme necessário.

Próximos Passos​

  • Guia de Uso — aprenda como executar sincronizações manuais, gerenciar clientes e faturas importados, e usar bots, templates e contatos em massa