Personal tools
Namespaces

Variants
Actions

Plesk Key Administrator For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎Addon Configuration)
(→‎Product Configuration)
(35 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
<meta name="keywords" content="plesk key administrator for whmcs, plesk key administrator guide, modulesgarden plesk key administrator, plesk key administrator wiki, plesk key administrator tutorial, plesk key administrator tips, plesk module wiki, plesk key administrator common problems, about plesk key administrator, plesk key administrator documentation, plesk key administrator faq, plesk key administrator help, plesk key administrator configuration, plesk key administrator management, plesk key administrator installation"></meta>
 
<meta name="keywords" content="plesk key administrator for whmcs, plesk key administrator guide, modulesgarden plesk key administrator, plesk key administrator wiki, plesk key administrator tutorial, plesk key administrator tips, plesk module wiki, plesk key administrator common problems, about plesk key administrator, plesk key administrator documentation, plesk key administrator faq, plesk key administrator help, plesk key administrator configuration, plesk key administrator management, plesk key administrator installation"></meta>
 
<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>
−
 
−
 
  
 
=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 13: Line 11:
 
{|
 
{|
 
|style="padding: 10px 0px 0px 30px;"|✔ Create/Suspend/Unsuspend/Terminate License
 
|style="padding: 10px 0px 0px 30px;"|✔ Create/Suspend/Unsuspend/Terminate License
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Upgrade/Downgrade License
 
|}
 
|}
 
{|
 
{|
Line 37: Line 38:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Order Additional Feature To Owned Product License
+
|style="padding: 0px 0px 0px 30px;"|✔ Order Additional Extension To Owned Product License
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Upgrade/Downgrade License
 
|}
 
|}
 
{|
 
{|
Line 47: Line 51:
 
*'''General Info:'''
 
*'''General Info:'''
 
{|
 
{|
−
|style="padding: 10px 0px 0px 30px;"|✔ Supports Key Administrator Partner API 3.0
+
|style="padding: 10px 0px 0px 30px;"|✔ Supports Redirection From Plesk Extension Catalog To WHMCS Store
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Supports Key Administrator Partner API 3.0
 
|}
 
|}
 
{|
 
{|
Line 56: Line 63:
 
|}
 
|}
 
{|
 
{|
−
|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)]
+
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With <u>Server Allocator For WHMCS</u> - Automatic Assignment Of Most Suitable Servers To Products [https://www.modulesgarden.com/products/whmcs/server-allocator (read more)]
 
|}
 
|}
 
{|
 
{|
Line 62: Line 69:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7.2
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 7.1 Up To PHP 7.4
 
|}
 
|}
 
{|
 
{|
Line 68: Line 75:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 30px;"|✔ Supports WHMCS V7.2 And Later
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V7.8 And Later
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 30px;"|✔ Easy Module Upgrade To [https://www.modulesgarden.com/products/whmcs/plesk-key-administrator#open-source-version Open Source Version]
 
|}
 
|}
  
 
=Installation and Configuration=
 
=Installation and Configuration=
 
{|
 
{|
−
|style="padding: 10px 0px 0px 0px;"|'''In this tutorial we will show you how to quickly install and configure Plesk Key Administrator For WHMCS.'''<br />
+
|style="padding: 10px 0px 0px 0px;"|'''In this tutorial we will show you how to quickly install and configure [https://www.modulesgarden.com/products/whmcs/plesk-key-administrator Plesk Key Administrator For WHMCS.]'''<br />
 
We will guide you step by step through the whole installation process.
 
We will guide you step by step through the whole installation process.
 
|}
 
|}
Line 83: Line 93:
 
|}
 
|}
 
{|
 
{|
−
|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 15px 15px;"|'''2. In the downloaded file you might find one or two packages that support different PHP versions.'''<br/>
−
'' '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' → 'System' → 'PHP Info'.'''
+
In the most recent versions of the module, you will find only one package that supports PHP 7.1 and later.<br/> <!-- If you need a package for the previous versions of PHP, please [https://www.modulesgarden.com/support/ticket/general-support contact our support]. -->
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_72.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:PHP71_74.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''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.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''Previous updates of the module may contain two packages dedicated to various PHP versions.'''<br/>
−
The content of PHP version files should look like this.  
+
The first one that supports PHP 5.6 up to PHP 7.0, and the second one addressed to PHP 7.1 up to PHP 7.3.<br/>
 +
'''''Note:''' Keep in mind that PHP versions 5.6 up to 7.0 are no longer officially supported and their security issues are not fixed or released any more. Find more info [http://php.net/supported-versions.php here].''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:PHP56_73.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 15px;"| <!-- '' '''Important''': This situation does not affect [https://www.modulesgarden.com/products/whmcs/plesk-key-administrator#open-source-version '''the open source version'''] of this module which can be applied to any PHP from version 5.6 and later.''<br/>'' --> '''Note''': You can check the current PHP version in your WHMCS. To do so, proceed to ''' 'Utilities' → 'System' → 'PHP Info'.'''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''3.  Extract the package and upload its content into the main WHMCS directory.
 +
The content of the package to upload should look like this.
 
|}
 
|}
 
{|
 
{|
Line 108: Line 129:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OKA4.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:OKA4.png]]
 
|}
 
|}
 
==Product Configuration==
 
==Product Configuration==
 
{|
 
{|
−
|style="padding: 10px 0px 20px 15px;"|'''Now we will show you how to configure a new product.''' <br />
+
|style="padding: 10px 0px 0px 15px;"|'''Now we will show you how to configure a new product.'''  
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''6.Go to '' 'Setup' → 'Products/Services' → 'Servers' '' and press '' 'Add New Server'.'''''
+
|style="padding: 20px 0px 20px 15px;"|'''6. Go to '' 'Setup' → 'Products/Services' → 'Servers' '' and press '' 'Add New Server'.'''''
 
|}
 
|}
 
{|
 
{|
Line 121: Line 142:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''7. Next, enter your server name and a hostname.'''<br/><br/>''Note: it is recommended to use the officially supported hostanme when connecting to API 3.0.''<br/>
+
|style="padding: 0px 0px 15px 15px;"|'''7. Next, enter your server name and a hostname.'''<br/>
−
Hostname: https://api.central.plesk.com/30/
+
 
−
|}
+
If you have the module in version '''1.3.2 or later''', please use:<br/>
−
{|
+
'''Hostname:''' ''api.central.plesk.com''<br/>
−
|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.''
+
 
 +
If you have the module in version '''1.3.1 or previous''', please use:<br/>
 +
'''Hostname:''' ''https://api.central.plesk.com/30/''<br/>
 
<br/>
 
<br/>
 +
This is due to the changes that WHMCS made to store the hostname address since WHMCS V7.8. <br/>
 +
If you want to use the test environment, you can use your Plesk demo addresses such as '''ka.demo.plesk.com''' or '''https://ka.demo.plesk.com:7050/jsonrest/business-partner/30/''' depending on the module version you use.<br/>
 +
 +
'' '''Note:''' The module now uses connection to the API in version 3.0 so 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/>
 +
 
Afterwards, fill in the username and the 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 148: Line 176:
 
{|
 
{|
 
|style="padding: 0px 0px 15px 15px;"|'''10. In order to create and configure the product, move to '' '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, press '' '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 12.
 
|}
 
|}
 
{|
 
{|
Line 160: Line 188:
 
|}
 
|}
 
{|
 
{|
−
|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 14.'''<br />
 
To create a product press '' 'Create a New Product'. ''
 
To create a product press '' 'Create a New Product'. ''
 
|}
 
|}
Line 185: Line 213:
 
|}
 
|}
 
{|
 
{|
−
|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, a new '' 'Key Type' '' dropdown menu appears.'''<br />
−
Choose a key type from the 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/>
+
Choose a key type according to your needs:
 +
*[license] - a standalone license
 +
*[extension] - additional extension that is usually offered to an already existing license as a product addon. <br/> Still, some of the extenstions might be also offered as standalone products. Be sure to select the right extension or configure it as a [[#Addon_Configuration|product addon]]. <br/>
 +
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.
 
Afterwards press '' 'Save Changes' '' button.
 
|}
 
|}
Line 196: Line 227:
 
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/
 +
 +
The validation is necessary to prevent users from providing IP addresses in the wrong format.<br/>
 
The code is optional for IPv4 validation.<br/>
 
The code is optional for IPv4 validation.<br/>
 
Mark '' 'Show on Order Form' '' and '' 'Required Field' '' checkboxes and press '' 'Save Changes' '' button. <br/>
 
Mark '' 'Show on Order Form' '' and '' 'Required Field' '' checkboxes and press '' 'Save Changes' '' button. <br/>
Line 203: Line 236:
 
{|
 
{|
 
|style="padding: 0px 0px 20px 25px;"|[[File:OKA16.png]]
 
|style="padding: 0px 0px 20px 25px;"|[[File:OKA16.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''18. Optionally, you may assign other packages that will be available for your clients to upgrade their license without the need to purchase a separate product.'''<br/>
 +
Move to '' 'Upgrades' '' tab, and select the packages.<br/>
 +
'''''Note:''' Keep in mind that upgrading some of the licenses may cause some conflicts.<br/> For more information regarding a license key modification, please refer to the Plesk official documentation [https://docs.plesk.com/en-US/onyx/partner-api-3.0/licenserelated-commands/modifying-a-license-key.77846/ article].''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:OKA16_1.png]]
 
|}
 
|}
 
{|
 
{|
Line 225: Line 266:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|'''1. Proceed to '' 'Setup' → 'Products/Services' → 'Product Addons' →  'Add New'.'' '''<br />
+
|style="padding: 20px 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.
 
Enter a name and desired description. Then move to the '' 'Module Settings' '' tab.
 
|}
 
|}
Line 239: Line 280:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''3. Provide your client ID and save the changes.'''<br />
+
|style="padding: 0px 0px 20px 15px;"|'''3. Provide your client ID and save the changes.'''
 
|}
 
|}
 
{|
 
{|
Line 245: Line 286:
 
|}
 
|}
 
{|
 
{|
−
|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/>
+
|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:
 +
*[license]  - a standalone license
 +
*[extension] - additional extension 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.
 
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.
 
|}
 
|}
Line 252: Line 296:
 
|}
 
|}
 
{|
 
{|
−
|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/>
+
|style="padding: 0px 0px 15px 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.
 
It will be available to purchase along with the selected products or services.
 
|}
 
|}
Line 285: Line 329:
  
 
==Client Area==
 
==Client Area==
 +
===Product License Details===
 
{|
 
{|
−
|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 including its '' 'Key Number', 'Key Type' Creation' '' and '' 'Expiration Dates'. ''<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/>
+
Additionally, your clients can change their license IP address. To do so, simply type in the IP address manually when using the '' 'Custom IP' '' option.<br/>
−
Keep in mind that this option is available only if IP Binding is enabled.
+
Press the '' 'Change IP' '' button when ready.
 
|}
 
|}
 
{|
 
{|
Line 294: Line 339:
 
|}
 
|}
 
{|
 
{|
−
|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/>
+
|style="padding: 0px 0px 15px 15px;"|Otherwise, you may select the IP address from the dropdown list - use '' 'Select  IP' '' button first. When ready, again press ' ''Change IP' '' button.<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/>
+
'''''Note:''' The list of IP addresses is fetched from the 'Dedicated IP' field and 'Assigned IPs' in case of Dedicated/VPS Server.''<br/>
−
Type in a new IP address and press ''Change IP'' button.
+
Keep in mind that the option to change the IP address available only if IP Binding is enabled.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:OKA19_1.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:OKA19_0.png]]
 
|}
 
|}
−
<!--
+
 
−
==Upgrade/Downgrade==
+
===Addon License Details===
 
{|
 
{|
−
|style="padding: 10px 0px 15px 15px;"|Clients can easily change their current product settings with upgrade/downgrade option.<br />
+
|style="padding: 10px 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/>
−
In order to allow such functionality, you need to create a new configurable option group.<br />
+
The below screen shows an example of two addons active. The first license with IP binding disabled and the second addon has the option to change a bound IP address enabled.<br/>  
−
Proceed to '' 'Setup' '' → '' 'Product/Services' '' → '' 'Configurable Options' '' and press '' 'Create a New Group'. ''
+
Type in a new IP address or select one from the drop down list ('' 'Select IP' '' button 'ON') and press ''Change IP'' button then.
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OKA21.png]]
+
|style="padding: 0px 0px 30px 25px;"|[[File:OKA19_1.png]]
 
|}
 
|}
 +
 +
===Upgrade/Downgrade License===
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Enter your group name and select Plesk Key Administrator product you want to assign configurable option group to.<br />
+
|style="padding: 10px 0px 20px 15px;"|Clients can easily upgrade their existing licenses to more suitable ones. Simply move to '' 'Upgrade/Downgrade' '' section and select a package from the available ones.
−
Afterwards, press '' 'Save Changes' '' button.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OKA22.png]]
+
|style="padding: 0px 0px 20px 25px;"|[[File:OKA21.png]]
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|Now, press '' 'Add New Configurable Option'. ''<br />
+
|style="padding: 0px 0px 30px 25px;"|[[File:OKA22.png]]
−
A new window will be opened, so make sure your browser does not block it.
+
 
|}
 
|}
 +
 +
=Tips=
 
{|
 
{|
−
|style="padding: 0px 0px 20px 25px;"|[[File:OKA23.png]]
+
|style="padding: 10px 0px 10px 15px;"|1. Apart from the '' 'IP' '' custom field that must be added manually to the product, there 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 15px 15px;"|Enter name of the option in format '' 'KA_Plans | your_name' '' and fill out the option with Upgrade Plans name.<br />
+
|style="padding: 0px 0px 20px 25px;"|[[File:OKA19_2.png]]
−
Type option name into '' 'Add Option' '' textbox, for example '' '10_DOMIANS_TO_100_DOMAINS| From 10 to 100' ''.<br />
+
−
'' '10_DOMIANS_TO_100_DOMAINS' '' is a system name of Upgrade Plan, you can find it in your Plesk Key Administrator server.<br />
+
−
Afterwards, press '' 'Save Changes', '' as soon as the window is refreshed, you can add next upgrade/downgrade option.<br />
+
−
Repeat this step as many times as you need.
+
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 25px;"|[[File:OKA24.png]]
+
|style="padding: 0px 0px 30px 15px;"|2. The module supports redirection from the '' 'Buy Now' '' button in the Extensions Catalog in Plesk directly into the WHMCS cart.<br/>
−
|}
+
In order to allow such redirection you need to log into Plesk and then modify the ''panel.ini'' file. You will find this file at (depending on your OS):<br/>
−
-->
+
  
−
=Tips=
+
*Linux:    ''/usr/local/psa/admin/conf/panel.ini''<br/>
−
{|
+
 
−
|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/>
+
*Windows:  ''%plesk_dir%\admin\conf\panel.ini''<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.
+
 
−
|}
+
At the very bottom of that file, add the below snippet with a proper link to your WHMCS site:
−
{|
+
−
|style="padding: 0px 0px 30px 25px;"|[[File:OKA19_2.png]]
+
[extension]
 +
buyUrl = "your_WHMCS"
 +
 
 +
for example:
 +
 
 +
  [extension]
 +
  buyUrl = "https//shop.com"
 +
 
 +
'''Limitations:'''<br/>
 +
Forwarding from Plesk is based on two keys: '' 'extensionId' '' and '' 'extensionProductId','' whereas the second one is not always delivered.<br> In case only '' 'extensionId' '' is set, then more than one extension for that parameter may be found. In the situation when '' 'extentionID' '' is available only,<br/> the module will look through the list of addons and pick the first addon which suits the product.<br/>
 +
 
 +
Please refer to the Plesk official documentation to learn more about [https://docs.plesk.com/en-US/onyx/administrator-guide/plesk-extensions/reselling-extensions.78409/ 'Forwarding customers to your online store'] option.<br>
 +
Here is the list of addons: [https://central.plesk.com/docs/partner-api/partner-api-3.0-plesk-constants.json link].
 
|}
 
|}
  
 
=Update Instructions=
 
=Update Instructions=
 
{|
 
{|
−
|style="padding: 10px 0px 30px 15px;"|Essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/><br/>
+
|style="padding: 10px 0px 30px 15px;"|Essential guidance through the process of updating the module is offered '''[https://www.docs.modulesgarden.com/How_To_Update_WHMCS_Module here]'''.<br/>
 +
 
 +
When you upgrade the module from version '''1.3.1 or previous''' to '''1.3.2 or later''' please also update your server's connection as described in the [[#Product_Configuration|Product Configuration]] section.
 +
<br/><br/>
 
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!<br/>
 
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!<br/>
 
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.<br/>
 
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.<br/>
Line 361: Line 419:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 45px;"|2) Make sure that PleskKeyAdministrator server URL is: https://api.central.plesk.com/30/
+
|style="padding: 0px 0px 0px 45px;"|2) Make sure that PleskKeyAdministrator server URL is: '''https://api.central.plesk.com/30/''' (up to the 1.3.1 module version) or '''api.central.plesk.com''' (since the 1.3.2 module version)
 
|}
 
|}
 
{|
 
{|
Line 380: Line 438:
 
|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.<br/>
 
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 the connection between your and Plesk API servers.<br/>When the process is completed, a proper message will be displayed.
 
|}
 
|}
  
Line 388: Line 446:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 10px 15px;"|2. Make sure that your custom field name is '' 'IP'. '' In other case, module will not work properly.
+
|style="padding: 0px 0px 10px 15px;"|2. Make sure that your custom field name is '' 'IP'. '' In other case, the module will not work properly.
 
|}
 
|}
 
{|
 
{|
Line 402: Line 460:
 
  $parallels_key_administrator_licensekey=
 
  $parallels_key_administrator_licensekey=
  
−
In case you still have problems with license, please refer to the following [http://www.docs.modulesgarden.com/General#How_To_Solve_Problems_With_Module_License article].
+
In case you still have problems with the license, please refer to the following [https://www.docs.modulesgarden.com/General#How_To_Solve_Problems_With_Module_License article].
 
|}
 
|}

Revision as of 10:28, 27 August 2020

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
✔ Upgrade/Downgrade 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 Extension To Owned Product License
✔ Upgrade/Downgrade License
✔ View License Details
✔ Change IP Address Assigned To License
  • General Info:
✔ Supports Redirection From Plesk Extension Catalog To WHMCS Store
✔ 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 Most Suitable Servers To Products (read more)
✔ Multi-Language Support
✔ Supports PHP 7.1 Up To PHP 7.4
✔ Supports WHMCS Template Six
✔ Supports WHMCS V7.8 And Later
✔ Easy Module Upgrade To Open Source Version

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 might find one or two packages that support different PHP versions.

In the most recent versions of the module, you will find only one package that supports PHP 7.1 and later.

PHP71 74.png
Previous updates of the module may contain two packages dedicated to various PHP versions.

The first one that supports PHP 5.6 up to PHP 7.0, and the second one addressed to PHP 7.1 up to PHP 7.3.
Note: Keep in mind that PHP versions 5.6 up to 7.0 are no longer officially supported and their security issues are not fixed or released any more. Find more info here.

PHP56 73.png
Note: You can check the current PHP version in your WHMCS. To do so, proceed to 'Utilities' → 'System' → 'PHP Info'.
3. Extract the package and upload its content into the main WHMCS directory.

The content of the package to upload 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.

If you have the module in version 1.3.2 or later, please use:
Hostname: api.central.plesk.com

If you have the module in version 1.3.1 or previous, please use:
Hostname: https://api.central.plesk.com/30/

This is due to the changes that WHMCS made to store the hostname address since WHMCS V7.8.
If you want to use the test environment, you can use your Plesk demo addresses such as ka.demo.plesk.com or https://ka.demo.plesk.com:7050/jsonrest/business-partner/30/ depending on the module version you use.

Note: The module now uses connection to the API in version 3.0 so 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 12.

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 14.

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, a new 'Key Type' dropdown menu appears.

Choose a key type according to your needs:

  • [license] - a standalone license
  • [extension] - additional extension that is usually offered to an already existing license as a product addon.
    Still, some of the extenstions might be also offered as standalone products. Be sure to select the right extension or configure it as a product addon.

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 validation is necessary to prevent users from providing IP addresses in the wrong format.
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
18. Optionally, you may assign other packages that will be available for your clients to upgrade their license without the need to purchase a separate product.

Move to 'Upgrades' tab, and select the packages.
Note: Keep in mind that upgrading some of the licenses may cause some conflicts.
For more information regarding a license key modification, please refer to the Plesk official documentation article.

OKA16 1.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 the 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:

  • [license] - a standalone license
  • [extension] - additional extension to an already existing license

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

Product License Details

Our module allows your clients to view information about their licenses in WHMCS client area including its 'Key Number', 'Key Type' Creation' and 'Expiration Dates'.

Additionally, your clients can change their license IP address. To do so, simply type in the IP address manually when using the 'Custom IP' option.
Press the 'Change IP' button when ready.

OKA19.png
Otherwise, you may select the IP address from the dropdown list - use 'Select IP' button first. When ready, again press ' Change IP' button.

Note: The list of IP addresses is fetched from the 'Dedicated IP' field and 'Assigned IPs' in case of Dedicated/VPS Server.
Keep in mind that the option to change the IP address available only if IP Binding is enabled.

OKA19 0.png

Addon License Details

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 and the second addon has the option to change a bound IP address enabled.
Type in a new IP address or select one from the drop down list ( 'Select IP' button 'ON') and press Change IP button then.

OKA19 1.png

Upgrade/Downgrade License

Clients can easily upgrade their existing licenses to more suitable ones. Simply move to 'Upgrade/Downgrade' section and select a package from the available ones.
OKA21.png
OKA22.png

Tips

1. Apart from the 'IP' custom field that must be added manually to the product, there 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
2. The module supports redirection from the 'Buy Now' button in the Extensions Catalog in Plesk directly into the WHMCS cart.

In order to allow such redirection you need to log into Plesk and then modify the panel.ini file. You will find this file at (depending on your OS):

  • Linux: /usr/local/psa/admin/conf/panel.ini
  • Windows: %plesk_dir%\admin\conf\panel.ini

At the very bottom of that file, add the below snippet with a proper link to your WHMCS site: 

[extension]
buyUrl = "your_WHMCS"

for example: 

 [extension]
 buyUrl = "https//shop.com"

Limitations:
Forwarding from Plesk is based on two keys: 'extensionId' and 'extensionProductId', whereas the second one is not always delivered.
In case only 'extensionId' is set, then more than one extension for that parameter may be found. In the situation when 'extentionID' is available only,
the module will look through the list of addons and pick the first addon which suits the product.

Please refer to the Plesk official documentation to learn more about 'Forwarding customers to your online store' option.
Here is the list of addons: link.

Update Instructions

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

When you upgrade the module from version 1.3.1 or previous to 1.3.2 or later please also update your server's connection as described in the Product Configuration section.

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/ (up to the 1.3.1 module version) or api.central.plesk.com (since the 1.3.2 module version)
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 the 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, the 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 the license, please refer to the following article.

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