WHMCS Module Integration
From VcPanel Enterprise : VPS Control Panel
vcPanel WHMCS module is a full featured module for integration of your vcPanel server with famous whmcs billing software. It support full automation from auto creation of vps to suspend, unsuspend and terminate a vps. To install vcpanel whmcs module in your whmcs billing system you may need to proceed the following steps.
Contents |
Enable API key inside vcPanel Admin panel
You may need generate a 2048 bit API key inside your vcPanel admin panel from vcPanel : VPS Control Panel >> vcPanel >> vcPanel API Key . This key is for configuring whmcs module.
Set default node
You may need to set default nodes from vcPanel admin panel. So the the whmcs module will automatically create containers in your default node. Also make sure you have enough ips in your default node.
Install whmcs module
Now download the latest vcPanel whmcs module from http://portal.vcpanel.net/downloads.php?action=displaycat&catid=3 and extract it . Then upload all content of vcpanelwhmcs/module/ to your module folder of whmcs installation. You may need to open the out going tcp ports 9966 and 9967 in your whmcs server
Configure whmcs module
Please see the procedure below to configure whmcs module
Configure API info
Go to WHMCS Admin -> UTILITIES -> Addon Modules -> vcPanel Admin and add the vcpanel Master server hostname , IP and API key . See screen shot below,
Create a product inside whmcs
Now create a product from whmcs ( type Dedicated/VPS Server ) and go to the module configuration session and select vcPanel modules. See the screenshot below,
Please note the plan name must be same as in vcPanel admin panel. It is case sensitive.
Configure OS selection options
Now go to whmcs -> Configuration -> configurable Options and create a group called vcpanel whmcs module. You can chose any group name as you wish. After that edit that group and select your products in which you configured vcpanel modules.
Now create a new configurable option called Select Operating System make sure its order priority is 1 . Please see a screen shot below,
Now edit the configurable options and add your operating systems . Please make sure the OS name must be same as the vps template name in vcPanel admin panel. It is case sensitive. Please see a screen shot below,
You are now ready to go to test the installations.
Sample Welcome Email for whmcs
Now you need to create a good welcome email for your vps and attach to your product. A sample welcome emails is given below. Make sure you need to change xxx.xxx.xxx.xxx with the IP of master control panel server Dear {$client_name},
PLEASE PRINT THIS MESSAGE FOR YOUR RECORDS - PLEASE READ THIS EMAIL IN FULL.
We are pleased to tell you that the server you ordered has now been set up and is operational.
The following are your vcPanel logins. If you already have a vps with vcPanel control panel from us,
you can use the old logins to check your new vps from the vcPanel control panel. So you can disregard the following logins. If this is your first vps, please use the following logins to access your vcPanel control panel
Server Details
=============================
ServerName: {$service_domain}
vcPanel Control Panel url : http://xxx.xxx.xxx.xxx:9966/
Login ID : {$client_email}
Password : {$service_password}
Please login to your control panel and start your vps. Also don't forget to change root password too.
{$signature}
How this module works
This whmcs module will use client email address as the login id to vcPanel control panel and the password will be the root password given from the client during signup. So if your client already have a vps associated inside your vcPanel, then it will add the new vps inside his old logins. So he can use the old login for accessing all vps from the vcPanel.
If there is no vps associated with him in your vcPanel, then it will create new logins with login id as his email address and root password he given early. This root password is not the vps root password. vcPanel won't use root passwords over web due to security. So when your client receive your email, your client need to login to his vcPanel and start vps and reset the root password of his vps. This is how this module works.
If you need further information please contact our support. Also if you have any suggestions and feature requests please let us know. So we can update this module with new features too.
