WHMCS Licensing Hook

Overview

Do you want to offer Softaculous as an addon to your VPS/Dedicated server clients ? We have a WHMCS hook for that. 
This guide will help you to setup WHMCS hook to license Softaculous with your existing VPS/Dedicated Server product. Setting this up is very easy.

Note : You will need Softaculous NOC account to use this hook, because the API can be used only by NOCs. You can register as a NOC partner here

Download and Upload

For WHMCS 7.5+ 
Download the Hook here File:SoftLicenseHook php56-71-81.zip

For WHMCS version less than 7.5 
Download the Hook here if your are using WHMCS on PHP 5.3.x to PHP 5.5.x File:SoftLicenseHook php53.zip.
Download the Hook here if your are using WHMCS on PHP 5.6.x to PHP 7.0.x File:SoftLicenseHook php56.zip.
Download the Hook here if your are using WHMCS on PHP 7.1.x to PHP 7.2.x File:SoftLicenseHook php71.zip.
Download the Hook here if your are using WHMCS on PHP 5.2.x File:SoftLicenseHook php52.zip.

Unzip it and upload the files softaculous_license.php, softaculous_license_conf.php and noc_api.inc to the following path

/path/to/whmcs/includes/hooks/

Adding Configurable Option

  • First go to WHMCS admin panel -> Setup -> Products/Services -> Configurable Options
  • Now create a Group or edit the existing group (Make sure that you have selected your product while adding the group).
  • Now click on the Add New Configurable Option button.
  • You will get a form similar to the below image.
  • Fill in the details :
    • Option Name => Auto Installer If you would like to use some other name please edit the value for $GLOBALS[‘softaculous_conf’][‘fields’][‘Auto Installer’] in softaculous_license_conf.php
    • Option 1 => Softaculous Auto Installer
    • Option 2 => None

NOTE : The above values should be the same. Set the pricing as you wish. 

Editing a Product/Service

This guide assumes you have already setup WHMCS and created your product. You can find detailed guides on the WHMCS Wiki. Once the Product is setup you can move ahead with testing the Module.

Editing the Settings

Edit the settings in softaculous_license_conf.php 

1. (Required) Edit the Softaculous NOC account login details

$conf_softaculous['noc_username'] = 'example'; //Softaculous NOC username
$conf_softaculous['noc_password'] = 'example'; //Softaculous NOC user password

Enter the Softaculous NOC account details i.e. Softaculous Username and Softaculous Password. These details are required as the licenses will be issued under this account. 

2. (Optional) Edit the WHMCS admin account username

$conf_softaculous['whmcs_admin'] = 'whmcs_admin'; //WHMCS admin username

Enter the WHMCS admin account username. This username is required to perform WHMCS API actions from within the module for WHMCS versions lower than WHMCS 7.2 

3. (Required) Edit the pid of the products which are Dedicated servers and the ones which are VPS.

$conf_softaculous['vps_pid'] = array();
$conf_softaculous['dedicated_pid'] = array();

This is to determine if you will need Softaculous VPS license or a Dedicated server license.

4. (Optional) Edit the gid of the product groups which are Dedicated servers and the ones which are VPS.

$conf_softaculous['vps_gid'] = array();
$conf_softaculous['dedicated_gid'] = array();

This is to determine if you will need Softaculous VPS license or a Dedicated server license.

4. (Optional) Edit the pid of the products you want this hook to be executed for. By default this hook will be executed for the products that have the Configurable option (you created above) assigned.

$conf_softaculous['product_id'] = array();

5. (Optional) If you would like to debug set the debug mode to 1 :

$conf_softaculous['debug'] = 1;

Testing the Setup

You can test the setup by making a DUMMY Order and accepting the order.

Support

If you need any assistance then please contact Softaculous Support.

Vote

If you find this addon useful please vote for us : 
http://www.whmcs.com/appstore/3542/Softaculous-Licensing-Hook.html

Was this helpful to you?
Yes 1 No