🚧Configuration Steps

Configuration Steps

Setting up the WHMCS to Perfex CRM Integration Module is straightforward. This page will guide you through configuring your WHMCS API settings so that the module can securely connect to your WHMCS installation and synchronize client and invoice data.

---

Step 1: Access the Settings Page

Once the module is installed in Perfex CRM, navigate to the module’s Settings Page. Here, you will find the Synchronize WHMCS API Settings section, which contains the fields necessary to establish the connection between Perfex CRM and WHMCS:

• API URL

• API Key

• API Secret

These three fields are mandatory. Without them, the module will not be able to retrieve data from WHMCS.

---

Step 2: Create API Credentials in WHMCS

Before entering data in Perfex, you need to create API credentials in WHMCS. WHMCS uses a secure API system to allow third-party integrations like this module to read client and invoice information safely. Follow these steps:

1. Log in to your WHMCS Admin Area.

2. Navigate to Setup > Staff Management > API Credentials.

3. Click Create New API Credential (and a role, if needed)

   
4. Enter a name for the credential, such as Perfex Integration.

5. Select the permissions required for the module. Typically, you should allow at least:

   • View Clients

   • View Invoices

   • Add Clients (if you want new clients created in Perfex automatically)

   

6. Click Save.

For detailed instructions from WHMCS, see the official documentation here: WHMCS API Credentials.

---

Step 3: Obtain API URL

The API URL points to the WHMCS API endpoint that the module will use for communication. By default, this URL follows the structure:

https://YOURWHMCSINSTALLATION.COM/includes/api.php

Replace YOURWHMCSINSTALLATION.COM with your actual WHMCS installation domain. Make sure the URL is accessible from your Perfex CRM server, otherwise the module will not be able to connect.

---

Step 4: Enter API Key and Secret

Once you have generated the API credentials in WHMCS, copy the API Key and API Secret into the corresponding fields on the Perfex module's settings page:

• API Key – this is the unique identifier for the API credential you created.

• API Secret – this is the secret token associated with the key, used for secure authentication.

Double-check for extra spaces or incorrect characters when pasting these values. Incorrect entries will prevent synchronization.

---

Step 5: Save Settings

After entering the API URL, API Key, and API Secret, click Save Settings. You are all set!

---

Important Notes

• For more information on WHMCS API usage, see: WHMCS API Documentation