BuycPanel.com Server Provisioning Module v5.

3
Prerequisites
Before you start you will require:
Your BuycPanel.com login email address, (i.e. xxx@xxx.com)
Your BuycPanel.com API Key, this is available by logging into your
billing.buycpanel.com client account, or by emailing support@buycpanel.com

Uploading BuycPanel
1. Upload the /modules/servers/buycpanel folder and files to your WHMCS directory
2. IMPORTANT: Edit conf.php and enter your BuycPanel.com email address, API Key, and
a WHMCS admin user with API access. Without these, the module will not function.
3. Optional: Set the testmode value to 1 if you wish to test the module functions without
activating or cancelling any licenses within your BuycPanel.com billing account.
4. To prevent your clients from changing license IPs, set the
ALLOWCUSTOMERCHANGEIP option to 0

Creating Products (Admin)

The module allows for the configuration of BuycPanel licenses as WHMCS products. Any
management actions for the product (Create/Terminate/Suspend/Unsuspend) will automatically
contact the BuycPanel API and perform the action within your BuycPanel account.
1. Navigate through Setup > Products/Services > Products/Services and choose "Create a
New Product" under "Products/Services" to create a new product
2. Under Module Settings for the product, select BuycPanel
3. In the BuycPanel Product dropdown menu, select the BuycPanel license product that
you would like to associate with your new product.
4. Assign all other product options such as pricing as you normally would.
5. Warning: Do not modify the names of any custom fields generated by the module such
as License Key and License IP as these fields are required for the module to function
properly!

Ordering Client Licenses (Admin)

Once you have set up a product to use the module, you can activate products for your clients by
adding a new order through the WHMCS admin. Please note that the License IP field is required
for the order as shown in the screenshot below.

After you have added the order, you can run the create module from the order accept screen by
selecting Run Module Create which will contact the BuycPanel.com API and attempt to create
the license. You will receive a successful response or a detailed failure message indicating why
the API was unable to process your request. GoVPS products will allow for two additional
options, Backup Addon and Addon IPs.
Note: The username, password, and server fields are WHMCS defaults and are not necessary
for the module to function.

Please note that at this time GoVPS products must be synchronized manually. Synchronization
cannot occur until the VPS instance has been created and assigned an IP address!

Modifying Client Licenses (Admin)

Client products in the admin area will have five available module commands:
1. Create This will send the command to create the license through the API if it has not
been created already.
2. Suspend This will terminate the license through the API and set the products status to
Suspended within WHMCS
3. Unsuspend This will send the command to create the license through the API and will
set the products status back to Active within WHMCS
4. Terminate This will terminate the license through the API and set the products status
to Terminated within WHMCS
5. Refresh License Key This will attempt to synchronize the license key field with the
current license field from the API. If no license key exists there will be no error message
displayed, however, an inability to find a matching record in our system will generate an
error.

Synchronizing Existing Client Licenses (Admin)

Towards the top of the products/services page (below the products selection box) is a button
labeled Find & Synchronize License which will allow you to synchronize the product being
edited with an active BuycPanel license attached to your account. Clicking this button will bring
up a menu detailing all of your Active/Pending BuycPanel licenses of the same type (eg: cPanel,
Blesta, etc.) and allow you to choose which one to synchronize with your product.

This tool is useful if you have already purchased licenses with your BuycPanel account and you
want to synchronize that license with a product in your WHMCS. If you have a license on your
BuycPanel account and would like to synchronize it with a new product in your WHMCS, simply
place an order for the same type of product (as detailed under Ordering Client Licenses
above) but do NOT run the Create module after the order is submitted. Instead, accept the
order and then click on the product. On the resulting page, click on the Find & Synchronize
License button and then choose the appropriate matching license from the list.

Please note that any IP address changes that you make to a synchronized license through your
BuycPanel account will result in your WHMCS product becoming out-of-sync. You will need to
re-synchronize after making such a change.

Ordering Client Licenses (Client Area)

Your clients will be able to order BuycPanel license products in the same way that they
purchase other products from your WHMCS system, making it easy for you to sell our products
to your clients without them having to leave your website.
In addition to the standard WHMCS purchase criteria, clients must also specify the IP address
that will be attached to the license during the order process as shown below. Failure to specify a
proper IP address in the License IP field will result in an error returned to the client noting that
they must fill in all required fields before proceeding.

All error messages delivered through this module are customizable using the language options
(see final section below).

Modifying Client Licenses (Client Area)

Clients are shown the current License Key and License IP Address in their client area when
viewing their products. Clients have two custom actions specific to this module:
1. Synchronize License Key This will contact the API to determine the current License
Key and will synchronize this information with the clients product record in WHMCS.
2. Change License IP Address This feature allows your clients to modify their License IP
for that particular license. They will be notified if the API returns a failure response.

Please note that much of the client area text can be customized to your needs using the
language file options for WHMCS (see next section).
Optional: You can prevent your customers from changing their license IP addresses through a
variable in config.php. Edit this file and change the value of this variable as follows:
define("BUYCPANEL_ALLOWCUSTOMERCHANGEIP", 0);
Setting BUYCPANEL_ALLOWCUSTOMERCHANGEIP to 0 will prevent the Change Licence IP
Address form from appearing in the client area.

Custom Language Settings (Optional)

The module allows for the use of custom language sets for your admin and client area. The
admin area will pull the default WHMCS language (found in Setup > General Settings >
Localization) and the client area will pull the clients preferred language or the default if no
preference is set.
1. Begin by opening the english.php language file
2. Copy this file with a new name. This must be a language that is currently available in
your WHMCS. See the following URL for setting up your own custom language within
WHMCS:
http://docs.whmcs.com/Language_Files
3. Edit the newly copied file and translate all lines within. Leave any variable names as they
are, only editing the value as shown in bold below:
$lang['clientarea']['changeip']

= 'Change IP';

To:
$lang['clientarea']['changeip']

= 'Cambio IP';

Ensure that you do not remove any of the quotation marks around the text strings or semicolons
at the ends of each line. Should you need to include a single quote within your translated text, it
must be escaped with a backslash: \'