配置

安装和激活 WHMCS Integration 模块后，您需要配置与 WHMCS 实例的连接并定义数据如何流入 Perfex CRM。本页面涵盖 API 设置、同步偏好、字段映射和自动计划任务。

连接到 WHMCS

模块通过 WHMCS 官方 API 进行通信。在继续之前，您需要有效的 API 凭据。

生成 WHMCS API 凭据

1. 登录您的 WHMCS Admin Area。
2. 导航到 Setup > Staff Management > Manage API Credentials。
3. 点击 Generate New API Credential。
4. 输入描述（例如 "Perfex CRM Integration"）。
5. 复制 API Identifier 和 API Secret — 您在下一步将需要它们。

注意

请安全存储您的 API 凭据。API Secret 仅在创建时显示一次。如果丢失，您需要生成新的凭据。

在 Perfex CRM 中输入凭据

1. 在 Perfex CRM 中，导航到 WHMCS Integration 模块设置。
2. 输入以下详情：
   • WHMCS URL — 您 WHMCS 安装的完整 URL（例如 https://billing.example.com）
   • API Identifier — 上一步中生成的标识符
   • API Secret — 上一步中生成的密钥
3. 点击 Test Connection 验证 Perfex CRM 能否成功与您的 WHMCS 实例通信。
4. 连接测试通过后点击 Save Settings。

提示

如果连接测试失败，请确保您的 Perfex CRM 服务器 IP 地址已在 WHMCS 的 Setup > General Settings > Security > API IP Access Restriction 中列入白名单。同时验证 HTTPS 已配置且 WHMCS URL 正确。

同步设置

同步设置面板让您控制导入哪些数据以及如何在 Perfex CRM 中处理。

数据类型

数据类型	描述
Clients	同步客户资料，包括姓名、邮箱、电话、地址和公司详情
Invoices	同步发票，包含行项目、总计、税金、支付状态和截止日期
Contacts	同步与每个 WHMCS 客户账户关联的额外联系人

根据您的需求开启或关闭每种数据类型。至少应启用 Clients，因为发票和联系人都与客户记录关联。

重复处理

当同步的记录与现有的 Perfex CRM 客户匹配（通过邮箱地址匹配）时，您可以选择如何处理冲突：

• Skip — 如果已存在匹配记录，不导入
• Update — 用 WHMCS 数据覆盖现有的 Perfex CRM 记录
• Create New — 无论是否重复都创建单独的记录

信息

推荐设置为 Update，它可以保持您的 Perfex CRM 数据与 WHMCS 同步，同时避免重复的客户条目。

字段映射

字段映射部分让您定义 WHMCS 字段如何对应 Perfex CRM 字段。模块附带合理的默认值，但您可以自定义映射：

• 标准字段 — 姓名、邮箱、电话、地址、公司、城市、州/省、邮编、国家
• 自定义字段 — 将 WHMCS 自定义字段映射到 Perfex CRM 自定义字段

编辑字段映射：

1. 前往 WHMCS Integration > Settings > Field Mapping。
2. 对于每个 WHMCS 字段，从下拉列表中选择对应的 Perfex CRM 字段。
3. 点击 Save Mapping。

自动同步计划

除了手动运行同步，您还可以使用服务器端 cron 任务配置自动计划。

设置 Cron 任务

将以下条目添加到服务器的 crontab 中，按您期望的间隔运行同步：

# Run WHMCS sync every 6 hours
0 */6 * * * php /path/to/perfex/index.php whmcs_integration sync >/dev/null 2>&1

根据 WHMCS 数据变化的频率调整 cron 时间。常见间隔包括：

间隔	Cron 表达式	使用场景
每小时	0 * * * *	高流量计费环境
每 6 小时	0 */6 * * *	标准使用（推荐）
每天一次	0 2 * * *	低流量环境

注意

在大型数据集上频繁运行同步可能会增加服务器负载。启用自动同步后监控您的服务器资源，并相应调整间隔。

下一步

• 使用指南 — 了解如何运行手动同步、管理导入的客户和发票，以及使用机器人、模板和批量联系人