Personal tools
Namespaces

Variants
Actions

Plesk Key Administrator For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
Line 2: Line 2:
 
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Plesk Key Administrator For WHMCS Module."></meta>
 
<meta name="description" content="ModulesGarden Wiki Contains All The Information You Need About The Plesk Key Administrator For WHMCS Module."></meta>
  
−
<h4 style="color: #ff0000; font-weight:bold; text-align:center;">Article update is ongoing on this page, watch out for broken links, unclear descriptions and images!<br/>
+
 
−
We are sorry for the inconvenience caused.</h4>
+
  
 
=About [https://www.modulesgarden.com/products/whmcs/plesk-key-administrator Plesk Key Administrator For WHMCS]=
 
=About [https://www.modulesgarden.com/products/whmcs/plesk-key-administrator Plesk Key Administrator For WHMCS]=
Line 25: Line 24:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Choose Key Type Per Product
+
|style="padding: 0px 0px 0px 30px;"|✔ Choose Key Type Per Product And Product Addon
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 30px;"|✔ Add Multiple Features Per Product
+
|style="padding: 0px 0px 0px 30px;"|✔ Add Multiple Addon Features To Product
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ Enable/Disable IP Binding To License
 
|}
 
|}
 
*'''Client Area Features:'''
 
*'''Client Area Features:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Order License
+
|style="padding: 10px 0px 0px 30px;"|✔ Order License As Standalone Product Or Product Addon
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Order Additional Feature To Owned Product License
 
|}
 
|}
 
{|
 
{|
Line 42: Line 47:
 
*'''General Info:'''
 
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Supports Identifiers And License Key Structure Included In Key Administrator Partner API
+
|style="padding: 10px 0px 0px 30px;"|✔ Supports Key Administrator Partner API 3.0
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 00px 0px 0px 30px;"|✔ Integrated With <u>Product Linker For WHMCS</u> - Resell Licenses In Product Bundles [http://www.modulesgarden.com/products/whmcs/product_linker/features (read more)]
+
|style="padding: 00px 0px 0px 30px;"|✔ Supports Identifiers And License Key Structure Included In Key Administrator Partner API
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With <u>Product Linker For WHMCS</u> - Resell Licenses In Product Bundles [https://www.modulesgarden.com/products/whmcs/product-linker (read more)]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With <u>Server Allocator For WHMCS</u> - Automatic Assignment Of Specified Servers To Products [https://www.modulesgarden.com/products/whmcs/server-allocator (read more)]
 
|}
 
|}
 
{|
 
{|
Line 54: Line 65:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Templates Five and Six
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Template Six
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V7
+
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V7.2 And Later
 
|}
 
|}
  
Line 73: Line 84:
 
{|
 
{|
 
|style="padding: 0px 0px 10px 15px;"|'''2. In the downloaded file you will find two packages that support different PHP versions.'''<br/>As presented on the screen below, the first one is dedicated to PHP 5.6 up to PHP 7.0, while the second one is aimed at PHP 7.1 up to PHP 7.2.<br/>It does not apply to open source versions.<br/>
 
|style="padding: 0px 0px 10px 15px;"|'''2. In the downloaded file you will find two packages that support different PHP versions.'''<br/>As presented on the screen below, the first one is dedicated to PHP 5.6 up to PHP 7.0, while the second one is aimed at PHP 7.1 up to PHP 7.2.<br/>It does not apply to open source versions.<br/>
−
'' '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' › 'System' › 'PHP Info'.'''
+
'' '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' → 'System' → 'PHP Info'.'''
 
|}
 
|}
 
{|
 
{|
Line 87: Line 98:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''4. When you install Plesk Key Administrator For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
 
|style="padding: 0px 0px 15px 15px;"|'''4. When you install Plesk Key Administrator For WHMCS for the first time you have to rename '' 'license_RENAME.php' '' file.'''<br />
−
File is located in '' 'modules/servers/pleskKeyAdministrator/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php' ''.
+
File is located in '' 'modules/servers/pleskKeyAdministrator/license_RENAME.php'. '' Rename it from '' 'license_RENAME.php' '' to '' 'license.php'. ''
 
|}
 
|}
 
{|
 
{|
Line 99: Line 110:
 
|style="padding: 0px 0px 20px 25px;"|[[File:OKA4.png]]
 
|style="padding: 0px 0px 20px 25px;"|[[File:OKA4.png]]
 
|}
 
|}
 +
==Product Configuration==
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''6. Now we will show you how to configure a new product.''' <br />
+
|style="padding: 10px 0px 20px 15px;"|'''Now we will show you how to configure a new product.''' <br />
−
Go to '' 'Setup' → 'Products/Services' → 'Servers' '' and press '' 'Add New Server' ''.
+
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|'''6.Go to '' 'Setup' → 'Products/Services' → 'Servers' '' and press '' 'Add New Server'.'''''
 
|}
 
|}
 
{|
 
{|
Line 113: Line 127:
 
|style="padding: 0px 0px 15px 15px;"|''Please note that when you move from the older version of the module, it is advisable to refer to the [https://www.docs.modulesgarden.com/Plesk_Key_Administrator_For_WHMCS#API_Upgrade API Upgrade] section first.''
 
|style="padding: 0px 0px 15px 15px;"|''Please note that when you move from the older version of the module, it is advisable to refer to the [https://www.docs.modulesgarden.com/Plesk_Key_Administrator_For_WHMCS#API_Upgrade API Upgrade] section first.''
 
<br/>
 
<br/>
−
Afterwards, fill in username and password fields with API access details to your Plesk Key Administrator server.<br />
+
Afterwards, fill in the username and the password fields with API access details to your Plesk Key Administrator server.<br />
 
Choose '' 'PleskKeyAdministrator' '' from a dropdown menu and confirm through pressing '' 'Save Changes' '' button.<br />
 
Choose '' 'PleskKeyAdministrator' '' from a dropdown menu and confirm through pressing '' 'Save Changes' '' button.<br />
 
|}
 
|}
Line 121: Line 135:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''8. After you configure your server correctly, you will see a following screen.'''<br />
 
|style="padding: 0px 0px 15px 15px;"|'''8. After you configure your server correctly, you will see a following screen.'''<br />
−
Now, you need to create a new group for your server. For that purpose press '' 'Create New Group' ''.
+
Now, you need to create a new group for your server. For that purpose press '' 'Create New Group'. ''
 
|}
 
|}
 
{|
 
{|
Line 133: Line 147:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''10. In order to create and configure product, click on '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services'. '''''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''10. In order to create and configure the product, move to '' 'Setup' '' → '' 'Products/Services' '' → '' 'Products/Services'. '''''<br />
−
If you do not have a product group, click on '' 'Create a New Group' ''. If you do, simply go to step 11.
+
If you do not have a product group, press '' 'Create a New Group' ''. If you do, simply go to step 11.
 
|}
 
|}
 
{|
 
{|
Line 147: Line 161:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''12. When you have a product group, you can create your product and assign it to Plesk Key Administrator. If you already have a product, go to step 13.'''<br />
 
|style="padding: 0px 0px 15px 15px;"|'''12. When you have a product group, you can create your product and assign it to Plesk Key Administrator. If you already have a product, go to step 13.'''<br />
−
To create a product click on '' 'Create a New Product'. ''
+
To create a product press '' 'Create a New Product'. ''
 
|}
 
|}
 
{|
 
{|
Line 153: Line 167:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''13. Afterwards, choose your product type and product group from dropdown menus, enter your product name and press '' 'Continue'. '''''
+
|style="padding: 0px 0px 20px 15px;"|'''13. Afterwards, choose your product type and a product group from the dropdown menus, enter your product name and press '' 'Continue'. '''''
 
|}
 
|}
 
{|
 
{|
Line 159: Line 173:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''14. Now, go to '' 'Module Settings' '' section, choose both '' 'PleskKeyAdministrator' '' and your previously created server group from dropdown menu.'''
+
|style="padding: 0px 0px 20px 15px;"|'''14. Now, go to '' 'Module Settings' '' section, choose both '' 'PleskKeyAdministrator' '' and your previously created server group from the dropdown menu.'''
 
|}
 
|}
 
{|
 
{|
Line 172: Line 186:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''16. As soon as you fill out '' 'Client ID' '' field, new '' 'Key Type' '' dropdown menu appear.'''<br />
 
|style="padding: 0px 0px 15px 15px;"|'''16. As soon as you fill out '' 'Client ID' '' field, new '' 'Key Type' '' dropdown menu appear.'''<br />
−
Choose the key type. Afterwards press '' 'Save Changes' '' button.
+
Choose a key type from teh drop down menu. Define whether you wish to disable IP binding. If you select this option, client will not be allowed to change the bound IP address. <br/> Keep in mind that some keys require the IP binding option to be disabled to allow creating a license.<br/>
 +
Afterwards press '' 'Save Changes' '' button.
 
|}
 
|}
 
{|
 
{|
Line 181: Line 196:
 
In the '' 'Field Name' '' enter '' 'IP' '', choose '' 'Text Box' '' from a field type dropdown menu, enter description and set up validation as:<br />
 
In the '' 'Field Name' '' enter '' 'IP' '', choose '' 'Text Box' '' from a field type dropdown menu, enter description and set up validation as:<br />
 
  /\b(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\b/
 
  /\b(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\b/
−
Mark '' 'Show on Order Form' '' checkbox and press '' 'Save Changes' '' button.
+
The code is optional for IPv4 validation.<br/>
 +
Mark '' 'Show on Order Form' '' and '' 'Required Field' '' checkboxes and press '' 'Save Changes' '' button. <br/>
 +
'''''Note1:''' The IP field will be required if the IP Binding option is enabled only.''<br/>
 +
'''''Note2:''' There are two more custom fields generated automatically. Please refer to [[#Tips|Tips]] section to check their configuration.''
 
|}
 
|}
 
{|
 
{|
Line 188: Line 206:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''That's it. You have just successfully installed and configured Plesk Key Administrator For WHMCS!'''<br />  
 
|style="padding: 0px 0px 15px 15px;"|'''That's it. You have just successfully installed and configured Plesk Key Administrator For WHMCS!'''<br />  
−
On the following screen you can see how a properly configured product should look like.
+
On the following screen you can see how a properly configured product should look like on the product details page in teh admin area.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:OKA18.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|'''Client Area view:'''
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:OKA17.png]]
 
|style="padding: 0px 0px 30px 25px;"|[[File:OKA17.png]]
 +
|}
 +
 +
==Addon Configuration==
 +
{|
 +
|style="padding: 10px 0px 0px 0px;"|'''This module can be also alternatively configured as to become a 'Product Addon' that can be ordered additionally next to a given product or as a feature to an already existing license.'''<br /> There can be two types of licenses configured. One as a standalone license or as a feature to an existing license.<br/>
 +
More information concerning "Product Addons" in WHMCS can be found [https://docs.whmcs.com/Product_Addons here].
 +
In order to configure your addon follow the steps explained below.
 +
|}
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|'''1. Proceed to '' 'Setup' → 'Products/Services' → 'Product Addons' →  'Add New'.'' '''<br />
 +
Enter a name and desired description. Then move to the '' 'Module Settings' '' tab.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:OKA17_1.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''2. Now, as your '' 'Module Name' ''choose '' 'PleskKeyAdministrator' '' and select your previously created server group from the '' 'Server Group' '' dropdown menu. '''<br />
 +
Save the changes, only then the module settings will appear.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:OKA17_2.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|'''3. Provide your client ID and save the changes.'''<br />
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:OKA17_3.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''4. Select the required key type from the list of available.'''<br /> The dropdown list includes all types of keys, select according to your needs, either for a standalone license or an additional feature to an already existing license.<br/.
 +
Disable IP Binding - if you select this option, IP address will not be bound to the license.<br/> Keep in mind that some addon features may require this option to be disabled.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:OKA17_4.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|'''5. Finally assign the addon to any product of your choice.<br/>If the addon is configured as an additional feature, then select here a product with a license. <br/>If the addon is configured as a standalone license, then select any of your products. <br/>
 +
It will be available to purchase along with the selected products or services.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:OKA17_5.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|'''You have just successfully configured a new Plesk Key Administrator For WHMCS addon. '''
 
|}
 
|}
  
Line 197: Line 265:
 
{|
 
{|
 
|style="padding: 10px 0px 30px 15px;"|Our module allows you to provide all kinds of Plesk licenses through WHMCS.<br />
 
|style="padding: 10px 0px 30px 15px;"|Our module allows you to provide all kinds of Plesk licenses through WHMCS.<br />
−
They can be licenses for all types of Plesk Panel, Cloud server, Kaspersky Antivirus for Plesk and many, many more.<br />
+
These can be licenses for all types of Plesk Panel, Cloud server, Kaspersky Antivirus for Plesk and many, many more.<br />
−
Diversity of licenses types entails all kinds of features. Therefore, not every feature can be applied to any license type.<br />
+
The diversity of the licenses types entails all kinds of features. Therefore, not every feature can be applied to any license type.<br />
 
Full list of products for which licenses can be purchased through our module can be found [https://central.plesk.com/docs/user-guide/index.htm?fileName=78189.htm here].<br />
 
Full list of products for which licenses can be purchased through our module can be found [https://central.plesk.com/docs/user-guide/index.htm?fileName=78189.htm here].<br />
 
|}
 
|}
Line 207: Line 275:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:OKA18.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OKA18.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 15px;"|View and manage the details of Plesk Key Administrator addon licenses ordered by your clients.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:OKA17_6.png]]
 
|}
 
|}
  
Line 213: Line 287:
 
{|
 
{|
 
|style="padding: 10px 0px 15px 15px;"|Our module allows your clients to view information about their licenses in WHMCS client area.<br />
 
|style="padding: 10px 0px 15px 15px;"|Our module allows your clients to view information about their licenses in WHMCS client area.<br />
−
Additionally, your customers can change their license IP address.<br />
+
Additionally, your clients can change their license IP address. To do so, just enter a new IP address and press '' 'Change IP' '' button.<br/>
−
To do it, client needs only to enter a new IP address and press '' 'Change IP' '' button.
+
Keep in mind that this option is available only if IP Binding is enabled.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:OKA19.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OKA19.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|View the license details in addons section if you have ordered any with the product. <br/> Change IP address if IP binding has been enabled for the addon.<br/>
 +
The below screen shows an example of two addons active. The first license with IP binding disabled, in this case a client is not allowed to change the IP address.<br> The second addon has the option to change a bound IP address enabled.<br/>
 +
Type in a new IP address and press ''Change IP'' button.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:OKA19_1.png]]
 
|}
 
|}
−
 
 
<!--
 
<!--
 
==Upgrade/Downgrade==
 
==Upgrade/Downgrade==
Line 255: Line 336:
 
|}
 
|}
 
-->
 
-->
 +
 +
=Tips=
 +
{|
 +
|style="padding: 10px 0px 10px 15px;"|1. Apart from the '' 'IP' '' custom field that must be added manually to the product, tere are two other custom fields that are generated automatically.<br/>
 +
These are '' 'Key ID' '' and '' 'Key Number' '' fields of the text type. Underneath you can find a preview of these custom fields' correct setup.
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 25px;"|[[File:OKA19_2.png]]
 +
|}
  
 
=Update Instructions=
 
=Update Instructions=
Line 282: Line 372:
 
|style="padding: 0px 10px 0px 60px;"|''Where to find Internal ID field on Plesk? According to documentation:
 
|style="padding: 0px 10px 0px 60px;"|''Where to find Internal ID field on Plesk? According to documentation:
 
'''''An ID of a license owner:'''''<br/>
 
'''''An ID of a license owner:'''''<br/>
−
''You can obtain the ID in Plesk Partner Central: go to the Accounts tab > click the customer's name > the Internal ID field.''
+
''You can obtain the ID in Plesk Partner Central: go to the Accounts tab → click the customer's name → the Internal ID field.''
 
|}
 
|}
 
{|
 
{|
Line 289: Line 379:
 
{|
 
{|
 
|style="padding: 10px 0px 10px 15px;"|If all the above actions are completed, please turn on Module Log in your WHMCS.
 
|style="padding: 10px 0px 10px 15px;"|If all the above actions are completed, please turn on Module Log in your WHMCS.
−
You need to run ''/yourwhmcs/modules/servers/pleskKeyAdministrator/apiUpdate.php'' script using the command line.
+
You need to run ''/yourwhmcs/modules/servers/pleskKeyAdministrator/apiUpdate.php'' script using the command line.<br/>
 
This can take a while depending on a number of licenses assigned to your account and the quality of connection between your and Plesk API servers.<br/>When the process is completed, a proper message will be displayed.
 
This can take a while depending on a number of licenses assigned to your account and the quality of connection between your and Plesk API servers.<br/>When the process is completed, a proper message will be displayed.
 
|}
 
|}

Revision as of 16:02, 5 September 2018


Contents

About Plesk Key Administrator For WHMCS

Plesk Key Administrator For WHMCS will allow you to provide your clients with various Plesk licenses through your WHMCS.

The module will automatically deliver and activate the licenses for your customers with the help of flexible, fully customizable products.

  • Admin Area Features:
✔ Create/Suspend/Unsuspend/Terminate License
✔ Change Package
✔ Change IP Address Assigned To License
✔ View License Details
✔ Choose Key Type Per Product And Product Addon
✔ Add Multiple Addon Features To Product
✔ Enable/Disable IP Binding To License
  • Client Area Features:
✔ Order License As Standalone Product Or Product Addon
✔ Order Additional Feature To Owned Product License
✔ View License Details
✔ Change IP Address Assigned To License
  • General Info:
✔ Supports Key Administrator Partner API 3.0
✔ Supports Identifiers And License Key Structure Included In Key Administrator Partner API
✔ Integrated With Product Linker For WHMCS - Resell Licenses In Product Bundles (read more)
✔ Integrated With Server Allocator For WHMCS - Automatic Assignment Of Specified Servers To Products (read more)
✔ Multi-Language Support
✔ Supports PHP 5.6 Up To PHP 7.2
✔ Supports WHMCS Template Six
✔ Supports WHMCS V7.2 And Later

Installation and Configuration

In this tutorial we will show you how to quickly install and configure Plesk Key Administrator For WHMCS.

We will guide you step by step through the whole installation process.

1. Log in to our client area and download the module.
OKA1.png
2. In the downloaded file you will find two packages that support different PHP versions.
As presented on the screen below, the first one is dedicated to PHP 5.6 up to PHP 7.0, while the second one is aimed at PHP 7.1 up to PHP 7.2.
It does not apply to open source versions.

Note: You can check the current PHP version in your WHMCS. To do so, proceed to 'Utilities' → 'System' → 'PHP Info'.

PHP56 72.png
3. Extract the downloaded file and choose the one with the right PHP version. Upload and extract the PHP file into the main WHMCS directory.

The content of PHP version files should look like this.

OKA2 2.png
4. When you install Plesk Key Administrator For WHMCS for the first time you have to rename 'license_RENAME.php' file.

File is located in 'modules/servers/pleskKeyAdministrator/license_RENAME.php'. Rename it from 'license_RENAME.php' to 'license.php'.

OKA3.png
5. In order to configure your license key, you have to edit a previously renamed 'license.php' file.

Enter your license key between quotation marks as presented on the following screen. You can find your license key in our client area → 'My Products'.

OKA4.png

Product Configuration

Now we will show you how to configure a new product.
6.Go to 'Setup' → 'Products/Services' → 'Servers' and press 'Add New Server'.
OKA5.png
7. Next, enter your server name and a hostname.

Note: it is recommended to use the officially supported hostanme when connecting to API 3.0.

Hostname: https://api.central.plesk.com/30/

Please note that when you move from the older version of the module, it is advisable to refer to the API Upgrade section first.


Afterwards, fill in the username and the password fields with API access details to your Plesk Key Administrator server.
Choose 'PleskKeyAdministrator' from a dropdown menu and confirm through pressing 'Save Changes' button.

OKA6.png
8. After you configure your server correctly, you will see a following screen.

Now, you need to create a new group for your server. For that purpose press 'Create New Group'.

OKA7.png
9. Enter name, click on your previously created server, press 'Add' then press 'Save Changes'.
OKA8.png
10. In order to create and configure the product, move to 'Setup' → 'Products/Services' → 'Products/Services'.

If you do not have a product group, press 'Create a New Group' . If you do, simply go to step 11.

OKA9.png
11. Enter product group name and press 'Save Changes'.
OKA10.png
12. When you have a product group, you can create your product and assign it to Plesk Key Administrator. If you already have a product, go to step 13.

To create a product press 'Create a New Product'.

OKA11.png
13. Afterwards, choose your product type and a product group from the dropdown menus, enter your product name and press 'Continue'.
OKA12.png
14. Now, go to 'Module Settings' section, choose both 'PleskKeyAdministrator' and your previously created server group from the dropdown menu.
OKA13.png
15. Next, fill 'Client ID' textbox with your client ID on Plesk Key Administrator server.
OKA14.png
16. As soon as you fill out 'Client ID' field, new 'Key Type' dropdown menu appear.

Choose a key type from teh drop down menu. Define whether you wish to disable IP binding. If you select this option, client will not be allowed to change the bound IP address.
Keep in mind that some keys require the IP binding option to be disabled to allow creating a license.
Afterwards press 'Save Changes' button.

OKA15.png
17. After modifying the module settings press 'Custom Fields' located on the right side of the 'Module Settings' button.

In the 'Field Name' enter 'IP' , choose 'Text Box' from a field type dropdown menu, enter description and set up validation as:

/\b(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\b/

The code is optional for IPv4 validation.
Mark 'Show on Order Form' and 'Required Field' checkboxes and press 'Save Changes' button.
Note1: The IP field will be required if the IP Binding option is enabled only.
Note2: There are two more custom fields generated automatically. Please refer to Tips section to check their configuration.

OKA16.png
That's it. You have just successfully installed and configured Plesk Key Administrator For WHMCS!

On the following screen you can see how a properly configured product should look like on the product details page in teh admin area.

OKA18.png
Client Area view:
OKA17.png

Addon Configuration

This module can be also alternatively configured as to become a 'Product Addon' that can be ordered additionally next to a given product or as a feature to an already existing license.
There can be two types of licenses configured. One as a standalone license or as a feature to an existing license.

More information concerning "Product Addons" in WHMCS can be found here. In order to configure your addon follow the steps explained below.

1. Proceed to 'Setup' → 'Products/Services' → 'Product Addons' → 'Add New'.

Enter a name and desired description. Then move to the 'Module Settings' tab.

OKA17 1.png
2. Now, as your 'Module Name' choose 'PleskKeyAdministrator' and select your previously created server group from the 'Server Group' dropdown menu.

Save the changes, only then the module settings will appear.

OKA17 2.png
3. Provide your client ID and save the changes.
OKA17 3.png
4. Select the required key type from the list of available.
The dropdown list includes all types of keys, select according to your needs, either for a standalone license or an additional feature to an already existing license.<br/.

Disable IP Binding - if you select this option, IP address will not be bound to the license.
Keep in mind that some addon features may require this option to be disabled.

OKA17 4.png
5. Finally assign the addon to any product of your choice.
If the addon is configured as an additional feature, then select here a product with a license.
If the addon is configured as a standalone license, then select any of your products.

It will be available to purchase along with the selected products or services.

OKA17 5.png
You have just successfully configured a new Plesk Key Administrator For WHMCS addon.

Management

Our module allows you to provide all kinds of Plesk licenses through WHMCS.

These can be licenses for all types of Plesk Panel, Cloud server, Kaspersky Antivirus for Plesk and many, many more.
The diversity of the licenses types entails all kinds of features. Therefore, not every feature can be applied to any license type.
Full list of products for which licenses can be purchased through our module can be found here.

Admin Area

You can view all important details of Plesk Key Administrator products ordered by your clients in the admin area.

Additionally, our module allows you to manage your clients' licenses.

OKA18.png
View and manage the details of Plesk Key Administrator addon licenses ordered by your clients.
OKA17 6.png

Client Area

Our module allows your clients to view information about their licenses in WHMCS client area.

Additionally, your clients can change their license IP address. To do so, just enter a new IP address and press 'Change IP' button.
Keep in mind that this option is available only if IP Binding is enabled.

OKA19.png
View the license details in addons section if you have ordered any with the product.
Change IP address if IP binding has been enabled for the addon.

The below screen shows an example of two addons active. The first license with IP binding disabled, in this case a client is not allowed to change the IP address.
The second addon has the option to change a bound IP address enabled.
Type in a new IP address and press Change IP button.

OKA19 1.png

Tips

1. Apart from the 'IP' custom field that must be added manually to the product, tere are two other custom fields that are generated automatically.

These are 'Key ID' and 'Key Number' fields of the text type. Underneath you can find a preview of these custom fields' correct setup.

OKA19 2.png

Update Instructions

Essential guidance through the process of updating the module is offered here.

Keep in mind there is a quick and easy option in our client area that will let you upgrade the license of your module to an open source version at any time - and at a lower price!
To take advantage of it, simply use the License Upgrade button located on the product's page and a discounted invoice will be generated automatically.

API Upgrade

1. Since the release of the 1.0.5 version the old API is not supported. The steps below show how to update it:
1) Replace the old files with the new ones
2) Make sure that PleskKeyAdministrator server URL is: https://api.central.plesk.com/30/
3) Make sure that PleskKeyAdministrator server credential you are using are enabled for API 3.0 on Plesk server side
4) Make sure that Client ID in product configuration is the same as Internal ID field on Plesk side
Where to find Internal ID field on Plesk? According to documentation:

An ID of a license owner:
You can obtain the ID in Plesk Partner Central: go to the Accounts tab → click the customer's name → the Internal ID field.

Warning: these steps are required if in your WHMCS you have licenses created using old API (before Key Administrator 1.0.5)
If all the above actions are completed, please turn on Module Log in your WHMCS.

You need to run /yourwhmcs/modules/servers/pleskKeyAdministrator/apiUpdate.php script using the command line.
This can take a while depending on a number of licenses assigned to your account and the quality of connection between your and Plesk API servers.
When the process is completed, a proper message will be displayed.

Common Problems

1. When you have problems with connection, check whether your SELinux or firewall does not block ports.
2. Make sure that your custom field name is 'IP'. In other case, module will not work properly.
3. If after installation, you get an ionCube encoder problem (wrong version), please open a support ticket.

We will provide you with a different version of the module encrypted with the older version of ionCube.

4. When you have a license error, please make sure you are using a correct license file.

For Plesk Key Administrator For WHMCS 1.0.3 and later a new variable is used: 

$plesk_key_administrator_licensekey=

Previous license content (1.0.2 and earlier): 

$parallels_key_administrator_licensekey=

In case you still have problems with license, please refer to the following article.

Retrieved from "https://www.docs.modulesgarden.com/index.php?title=Plesk_Key_Administrator_For_WHMCS&oldid=41011"
Navigation
WHMCS Modules
WHMCS Widgets
Translations
cPanel Modules
General
FAQ
Community
Plesk Key Administrator For WHMCS