SynergyCP WHMCS Integration

Setup

  1. Download and extract the WHMCS integration here
  2. Copy the entire directory via FTP, SCP, etc. to /<WHMCS_PATH>/modules/servers/synergycp/
  3. Go to SynergyCP Admin > System > Integrations.
  4. Add an Integration for WHMCS.
  5. Edit the Integration and make sure it has the following permissions:
    • Clients (View & Edit)
    • Installs (View & Edit)
    • Servers In Use (View & Edit)
    • Servers In Inventory (View & Edit)
    • IP Entities (View)
    • IP Groups (View)
  6. Create an API Key for the Integration, and copy the key.
  7. Go to WHMCS Admin > Setup (Top nav) > Products/Services > Servers
  8. Add New Server
    • Name: SynergyCP
    • Hostname: The hostname of the SynergyCP API - this should start with api.
  9. Scroll down to Server Details
    • Type: Synergy Control Panel
    • Access Hash: <API Key of SynergyCP Integration>

Adding a New Product

  1. Go to Setup (Top nav) > Products/Services > Products/Services > Create a New Product
  2. Product Type: Dedicated/VPS Server
  3. Product Name: The CPU name (e.g. E3-1270v6, Dual E5-2620v4)
  4. Module Settings:
    • Module Name: Synergy Control Panel
    • Fill in CPU Billing ID from SynergyCP
    • We recommend format-quick as the Pre-OS install. Formats are required before some OS reloads to get rid of the old disk partition table.

Configurable Options

Configurable Options use the billing ID on WHMCS to link up with the billing ID on SynergyCP.

The billing ID is specified before the value shown to the user separated by a Unix pipe character:

selection

Every SynergyCP product on WHMCS must include the following Configurable Options (names must match exactly):

WHMCS Configurable Field Name Example Field Value Special Notes
Memory 8GB|8GB RAM
Datacenter Location LOC-LA|Los Angeles This must correspond to an IP Group in SynergyCP.
Network Port Speed 1GBPS|Gigabit Uplink
IPv4 Addresses IP-29|/29 Block (5 Usable IP Addresses)
Add On 1, Add On 2, etc. (any number of entries) HW-RAID|Hardware RAID Controller Use ADD- RAID1 and ADD-RAID0 as billing IDs for automatic software RAID configuration.
Drive Bay 1, Drive Bay 2, etc. (any number of entries) 1TB-HDD|1 TB Hard Drive The billing ID value should be None for empty disk bays.
Bandwidth 20000GB|20 TB Bandwidth or |Unmetered Bandwidth Optional. The billing ID MUST use the same unit as your overage billing setting in WHMCS (default is GB)