Personal tools
Namespaces

Variants
Actions

Plesk Key Administrator For WHMCS

From ModulesGarden Wiki
(Difference between revisions)
Jump to: navigation, search
(→‎About Plesk Key Administrator For WHMCS)
(→‎Installation and Configuration)
 
(40 intermediate revisions by 3 users not shown)
Line 28: Line 28:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Add Multiple Addon Features To Product
+
|style="padding: 0px 0px 0px 30px;"|✔ Add Multiple Addon Features To Products
 
|}
 
|}
 
{|
 
{|
 
|style="padding: 0px 0px 10px 30px;"|✔ Enable/Disable IP Binding To License
 
|style="padding: 0px 0px 10px 30px;"|✔ Enable/Disable IP Binding To License
 +
|}
 +
{|
 +
|style="padding: 0px 0px 10px 30px;"|✔ Enable/Disable IP Binding Restriction
 
|}
 
|}
 
*'''Client Area Features:'''
 
*'''Client Area Features:'''
Line 60: Line 63:
 
|}
 
|}
 
{|
 
{|
−
|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 [https://www.modulesgarden.com/products/whmcs/product-linker Product Linker For WHMCS] - Resell Licenses In Product Bundles
 
|}
 
|}
 
{|
 
{|
−
|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)]
+
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With [https://www.modulesgarden.com/products/whmcs/products-reseller Products Reseller For WHMCS] - End-To-End Solution For Products And Servers Reselling
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Integrated With [https://www.modulesgarden.com/products/whmcs/server-allocator Server Allocator For WHMCS] - Automatic Assignment Of Most Suitable Servers To Products
 
|}
 
|}
 
{|
 
{|
Line 69: Line 75:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 5.6 Up To PHP 7.3
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports PHP 8.12 Back To PHP 8.1
 +
|}
 +
{|
 +
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Themes "Six" And "Twenty-One"
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS Template Six
+
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V8.12 Back To WHMCS V8.9
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 0px 30px;"|✔ Supports WHMCS V7.7 And Later
+
|style="padding: 0px 0px 0px 30px;"|✔ Requires ionCube Loader V13 Or 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]
+
|style="padding: 0px 0px 30px 30px;"|✔ Easy [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module Module Upgrade] To [https://www.modulesgarden.com/products/whmcs/plesk-key-administrator#open-source-version Open Source Version]
 
|}
 
|}
  
Line 92: Line 101:
 
|style="padding: 0px 0px 20px 25px;"|[[File:OKA1.png]]
 
|style="padding: 0px 0px 20px 25px;"|[[File:OKA1.png]]
 
|}
 
|}
 +
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''2. In the downloaded file you might find one or two packages that support different PHP versions.'''<br/>
+
|style="padding: 0px 0px 15px 15px;"|'''2. Extract the package and upload its content into the main WHMCS directory.
−
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].
+
The content of the package to upload should look like this.
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 20px 25px;"|[[File:PHP71_73.png]]
+
−
|}
+
−
{|
+
−
|style="padding: 0px 0px 15px 15px;"|'''Previous updates of the module may contain two packages dedicated to various PHP versions.'''<br/>
+
−
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. Once you have chosen the package with the right PHP version, extract it and upload its content into the main WHMCS directory.'''<br />
+
−
The content of the chosen PHP version files to upload should look like this.  
+
 
|}
 
|}
 
{|
 
{|
Line 118: Line 110:
 
|}
 
|}
 
{|
 
{|
−
|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;"|'''3. 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 125: Line 117:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''5. In order to configure your license key, you have to edit a previously renamed '' 'license.php' '' file.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''4. In order to configure your license key, you have to edit a previously renamed '' 'license.php' '' file.'''<br />
 
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'. ''
 
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'. ''
 
|}
 
|}
Line 136: Line 128:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 20px 0px 20px 15px;"|'''6. Go to '' 'Setup' → 'Products/Services' → 'Servers' '' and press '' 'Add New Server'.'''''
+
|style="padding: 20px 0px 20px 15px;"|'''5. Go to '' 'Setup' → 'Products/Services' → 'Servers' '' and press '' 'Add New Server'.'''''
 
|}
 
|}
 
{|
 
{|
Line 142: Line 134:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''7. Next, enter your server name and a hostname.'''<br/>
+
|style="padding: 0px 0px 15px 15px;"|'''6. Next, enter your server name and a hostname.'''<br/>
  
−
If you have the module in version '''1.3.2 or later''', please use:<br/>
+
<!--If you have the module in version '''1.3.2 or later''', please use:<br/>
 
'''Hostname:''' ''api.central.plesk.com''<br/>
 
'''Hostname:''' ''api.central.plesk.com''<br/>
  
Line 150: Line 142:
 
'''Hostname:''' ''https://api.central.plesk.com/30/''<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/>
+
This is due to the changes that WHMCS made to store the hostname address since WHMCS V7.8. <br/>   '''https://ka.demo.plesk.com:7050/jsonrest/business-partner/30/''' depending on the module version you use.<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/>
+
In the '' 'Hostanme' '' field please enter '''api.central.plesk.com''' to successfully connect with the server.
  
−
'' '''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/>
+
'' '''Note:''' The module 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 />
Line 162: Line 154:
 
|}
 
|}
 
{|
 
{|
−
|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;"|'''7. 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 169: Line 161:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''9. Enter name, click on your previously created server, press '' 'Add' '' then press '' 'Save Changes'. '''''
+
|style="padding: 0px 0px 20px 15px;"|'''8. Enter name, click on your previously created server, press '' 'Add' '' then press '' 'Save Changes'. '''''
 
|}
 
|}
 
{|
 
{|
Line 175: Line 167:
 
|}
 
|}
 
{|
 
{|
−
|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;"|'''9. 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 12.
 
If you do not have a product group, press '' 'Create a New Group'. '' If you do, simply go to step 12.
 
|}
 
|}
Line 182: Line 174:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''11. Enter product group name and press '' 'Save Changes'. '''''
+
|style="padding: 0px 0px 20px 15px;"|'''10. Enter the product group name and press '' 'Save Changes'. '''''
 
|}
 
|}
 
{|
 
{|
Line 188: Line 180:
 
|}
 
|}
 
{|
 
{|
−
|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 />
+
|style="padding: 0px 0px 15px 15px;"|'''11. 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 195: Line 187:
 
|}
 
|}
 
{|
 
{|
−
|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'. '''''
+
|style="padding: 0px 0px 20px 15px;"|'''12. Afterward, choose your product type and a product group from the dropdown menus, enter your product name and press '' 'Continue'. '''''
 
|}
 
|}
 
{|
 
{|
Line 201: Line 193:
 
|}
 
|}
 
{|
 
{|
−
|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.'''
+
|style="padding: 0px 0px 20px 15px;"|'''13. Now, go to '' 'Module Settings' '' section, and choose both '' 'PleskKeyAdministrator' '' and your previously created server group from the dropdown menu.'''
 
|}
 
|}
 
{|
 
{|
Line 207: Line 199:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 20px 15px;"|'''15. Next, fill '' 'Client ID' '' textbox with your client ID on Plesk Key Administrator server.'''
+
|style="padding: 0px 0px 20px 15px;"|'''14. Next, fill '' 'Client ID' '' textbox with your client ID on Plesk Key Administrator server.'''
 
|}
 
|}
 
{|
 
{|
Line 213: Line 205:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''16. As soon as you fill out '' 'Client ID' '' field, a new '' 'Key Type' '' dropdown menu appears.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''15. As soon as you fill out '' 'Client ID' '' field, a new '' 'Key Type' '' dropdown menu appears.'''<br />
 
Choose a key type according to your needs:
 
Choose a key type according to your needs:
 
*[license] - a standalone license
 
*[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/>
+
*[extension] - additional extension that is usually offered to an already existing license as a product addon. <br/> Still, some of the extensions 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/>
+
*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/>
 +
*If you enable the '''Restrict IP Biding''' option,  it will not be possible to use a license key on IP addresses other than the bounded IP address.<br/> If disabled, a license key can be used on IP addresses other than the bounded IP address.<br/>
 
Afterwards press '' 'Save Changes' '' button.
 
Afterwards press '' 'Save Changes' '' button.
 
|}
 
|}
Line 224: Line 217:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 15px 15px;"|'''17. After modifying the module settings press '' 'Custom Fields' '' located on the right side of the '' 'Module Settings' '' button.'''<br />
+
|style="padding: 0px 0px 15px 15px;"|'''16. After modifying the module settings press '' 'Custom Fields' '' located on the right side of the '' 'Module Settings' '' button.'''<br />
−
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 the 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 236: Line 231:
 
|}
 
|}
 
{|
 
{|
−
|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/>  
+
|style="padding: 0px 0px 15px 15px;"|'''17. 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/>  
 
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].''
 
'''''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].''
Line 259: Line 254:
 
==Addon Configuration==
 
==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/>
+
|style="padding: 10px 0px 0px 0px;"|'''This module can be also alternatively configured to become a 'Product Addon' that can be ordered additionally next to a given product.'''<br />
 
More information concerning "Product Addons" in WHMCS can be found [https://docs.whmcs.com/Product_Addons here].
 
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.
 
In order to configure your addon follow the steps explained below.
Line 265: Line 260:
 
{|
 
{|
 
|style="padding: 20px 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.
+
Select '' 'Independent Product','' enter a name for the product and include '' 'PleskKeyAdministrator' '' in the '' 'Module' '' field.<br/>
 +
Click on '' 'Continue' '' and move to the '' 'Module Settings' '' tab.
 
|}
 
|}
 
{|
 
{|
Line 288: Line 284:
 
*[license]  - a standalone license
 
*[license]  - a standalone license
 
*[extension] - additional extension to an already existing license<br/>
 
*[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 selected - the IP address is not inserted in the license. The license will be created even though there is no IP address in the '' 'Dedicated IP' '' field, the licence will not be bound to any IP address.
 +
*if not selected - an IP address in the '' 'Dedicated IP' '' field in the product's details is required.<br/> If a VPS module connected with this product inserts an IP address in that field via cron, then the product addon must be activated after this action.<br/> Addon activation with an empty '' 'Dedicated IP' '' field in the product's details will result in an error: '' 'The IP you provided is empty, or has incorrect format' '' being displayed.<br/>
 +
Keep in mind that some addon features may require this option to be disabled.<br/>
 +
'''Restrict IP Biding'''
 +
*if selected - it will not be possible to use a license key on IP addresses other than the bounded IP address.
 +
*if not selected - a license key can be used on IP addresses other than the bounded IP address.
 
|}
 
|}
 
{|
 
{|
Line 364: Line 366:
 
{|
 
{|
 
|style="padding: 0px 0px 30px 25px;"|[[File:OKA22.png]]
 
|style="padding: 0px 0px 30px 25px;"|[[File:OKA22.png]]
 +
|}
 +
 +
==Importing Existing Instance==
 +
{|
 +
|style="padding: 10px 0px 15px 15px;"|In this section, you can find short instructions on how to connect one of your clients to your already existing instance. <br/> Take the following steps to make sure that the process will be carried out properly. <br/>
 +
1. Firstly, manually create an order for your customer in WHMCS. Choose a client and in the summary, view click on the '' ' Add New Order' '' button. Next, select a '' 'Product/Service' '' and press '' 'Submit Order' ''. <br/> '''What is important, do not perform the '' 'Create' '' action.''' The status has to remain as '' 'Pending' ''. <br/> More info about placing orders can be found [https://docs.whmcs.com/Order_Management#Placing_an_Order here]<br/>
 +
2. Proceed to the newly created product page in your admin area. Find the following empty field:
 +
*'''Key ID'''
 +
The above-mentioned information has to be consistent with the data from your Plesk panel. Now, complete this field as presented below. <br/> '''Important!''' Remember to make sure that the format of the provided data is compatible with the format supported by the module. You can preview it for another product of the module you have already created and enter it in a similar way. <br/> If you completed the required data, now change the status from '' 'Pending' '' to '' 'Active' '' and '' 'Save Changes'.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 20px 25px;"|[[File:Plesk_Key_import.png]]
 +
|}
 +
{|
 +
|style="padding: 0px 0px 15px 15px;"|'''''Note:''' Keep in mind that only the '' "Key ID" '' field is obligatory, other custom fields "Key Number" and "Product Key" are not required to successfully import the license.''
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|3. If the completed data is correct, after refreshing the page, you will see the attached instance from Plesk. <br/> '''Important!'''  Remember to manually add other missing parameters of the instance such as domains, credentials, IP Addresses, configurable options, etc. so they match the parameters of the attached instance from the Pelsk panel.
 
|}
 
|}
  
Line 375: Line 395:
 
|}
 
|}
 
{|
 
{|
−
|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/>
+
|style="padding: 0px 0px 15px 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/>
 
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/>
  
Line 397: Line 417:
 
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>
 
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].
 
Here is the list of addons: [https://central.plesk.com/docs/partner-api/partner-api-3.0-plesk-constants.json link].
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|3. Custom Key Types can be added by editing the following file:
 +
/your_whmcs/modules/servers/pleskKeyAdinistrator/config/custom-sku.json
 +
Here is an example code for an entry:
 +
<pre>
 +
{
 +
"PLSK-SOL-WP-AGE-M": "WordPress Agency",
 +
"IFY-1-1M": "Imunify360 Standalone Single User"
 +
}
 +
</pre>
 
|}
 
|}
  
Line 404: Line 435:
  
 
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.
 
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/>
 
−
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 437: Line 465:
 
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 the 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.
 +
|}
 +
=Upgrade Guide=
 +
{|
 +
|style="padding: 10px 0px 30px 15px;"|Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability?<br/> There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment.<br/>
 +
 +
Opt for the [https://www.modulesgarden.com/products/whmcs/plesk-key-administrator#open-source-version Open Source version] of your Plesk Key Administrator For WHMCS module to unlock these benefits.<br/> Simply click on either the '''Get Source Code''' or '''Upgrade To Lifetime''' button found on the product's page in our client area to complete the one-step upgrade process, with a '''dedicated discount''' already applied.<br/>
 +
 +
Follow a [https://www.docs.modulesgarden.com/How_To_Upgrade_WHMCS_Module comprehensive guide] covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized.
 
|}
 
|}
  
Line 451: Line 487:
 
|}
 
|}
 
{|
 
{|
−
|style="padding: 0px 0px 30px 15px;"|4. When you have a license error, please make sure you are using a correct license file. <br/>
+
|style="padding: 0px 0px 10px 15px;"|4. When you have a license error, please make sure you are using a correct license file. <br/>
 
For '''Plesk Key Administrator For WHMCS 1.0.3''' and later a new variable is used:
 
For '''Plesk Key Administrator For WHMCS 1.0.3''' and later a new variable is used:
 
  $plesk_key_administrator_licensekey=
 
  $plesk_key_administrator_licensekey=
Line 459: Line 495:
  
 
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].
 
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].
 +
|}
 +
{|
 +
|style="padding: 0px 0px 30px 15px;"|5. If you encounter an error: '' 'The IP you provided is empty, or has incorrect format' ''  when activating your product addon, please make sure you have provided the IP address in the '' 'Dedicated IP' '' field in the product's details.<br/> This field is required if the '' 'Disable IP Binding' '' option is not selected in the product addon settings. If the '' 'Dedicated IP' '' is filled out by cron, make sure you activate the addon after it is ready.<br/>
 +
If the '' 'Disable IP Binding' '' option is selected, the '' 'Dedicated IP' '' is not required to activate the product addon successfully.
 
|}
 
|}

Latest revision as of 11:44, 13 February 2025

Contents

[edit] 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 Products
✔ Enable/Disable IP Binding To License
✔ Enable/Disable IP Binding Restriction
  • 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
✔ Integrated With Products Reseller For WHMCS - End-To-End Solution For Products And Servers Reselling
✔ Integrated With Server Allocator For WHMCS - Automatic Assignment Of Most Suitable Servers To Products
✔ Multi-Language Support
✔ Supports PHP 8.12 Back To PHP 8.1
✔ Supports WHMCS Themes "Six" And "Twenty-One"
✔ Supports WHMCS V8.12 Back To WHMCS V8.9
✔ Requires ionCube Loader V13 Or Later
✔ Easy Module Upgrade To Open Source Version

[edit] 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. 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
3. 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
4. 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

[edit] Product Configuration

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

In the 'Hostanme' field please enter api.central.plesk.com to successfully connect with the server.

Note: The module 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
7. 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
8. Enter name, click on your previously created server, press 'Add' then press 'Save Changes'.
OKA8.png
9. 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
10. Enter the product group name and press 'Save Changes'.
OKA10.png
11. 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
12. Afterward, choose your product type and a product group from the dropdown menus, enter your product name and press 'Continue'.
OKA12.png
13. Now, go to 'Module Settings' section, and choose both 'PleskKeyAdministrator' and your previously created server group from the dropdown menu.
OKA13.png
14. Next, fill 'Client ID' textbox with your client ID on Plesk Key Administrator server.
OKA14.png
15. 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 extensions 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.
  • If you enable the Restrict IP Biding option, it will not be possible to use a license key on IP addresses other than the bounded IP address.
    If disabled, a license key can be used on IP addresses other than the bounded IP address.

Afterwards press 'Save Changes' button.

OKA15.png
16. 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 the 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
17. 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

[edit] Addon Configuration

This module can be also alternatively configured to become a 'Product Addon' that can be ordered additionally next to a given product.

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

Select 'Independent Product', enter a name for the product and include 'PleskKeyAdministrator' in the 'Module' field.
Click on 'Continue' and 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 selected - the IP address is not inserted in the license. The license will be created even though there is no IP address in the 'Dedicated IP' field, the licence will not be bound to any IP address.
  • if not selected - an IP address in the 'Dedicated IP' field in the product's details is required.
    If a VPS module connected with this product inserts an IP address in that field via cron, then the product addon must be activated after this action.
    Addon activation with an empty 'Dedicated IP' field in the product's details will result in an error: 'The IP you provided is empty, or has incorrect format' being displayed.

Keep in mind that some addon features may require this option to be disabled.
Restrict IP Biding

  • if selected - it will not be possible to use a license key on IP addresses other than the bounded IP address.
  • if not selected - a license key can be used on IP addresses other than the bounded IP address.
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.

[edit] 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.

[edit] 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

[edit] Client Area

[edit] 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

[edit] 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

[edit] 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

[edit] Importing Existing Instance

In this section, you can find short instructions on how to connect one of your clients to your already existing instance.
Take the following steps to make sure that the process will be carried out properly.

1. Firstly, manually create an order for your customer in WHMCS. Choose a client and in the summary, view click on the ' Add New Order' button. Next, select a 'Product/Service' and press 'Submit Order' .
What is important, do not perform the 'Create' action. The status has to remain as 'Pending' .
More info about placing orders can be found here
2. Proceed to the newly created product page in your admin area. Find the following empty field:

  • Key ID

The above-mentioned information has to be consistent with the data from your Plesk panel. Now, complete this field as presented below.
Important! Remember to make sure that the format of the provided data is compatible with the format supported by the module. You can preview it for another product of the module you have already created and enter it in a similar way.
If you completed the required data, now change the status from 'Pending' to 'Active' and 'Save Changes'.

Plesk Key import.png
Note: Keep in mind that only the "Key ID" field is obligatory, other custom fields "Key Number" and "Product Key" are not required to successfully import the license.
3. If the completed data is correct, after refreshing the page, you will see the attached instance from Plesk.
Important! Remember to manually add other missing parameters of the instance such as domains, credentials, IP Addresses, configurable options, etc. so they match the parameters of the attached instance from the Pelsk panel.

[edit] 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.

3. Custom Key Types can be added by editing the following file: 
/your_whmcs/modules/servers/pleskKeyAdinistrator/config/custom-sku.json

Here is an example code for an entry: 

{
 "PLSK-SOL-WP-AGE-M": "WordPress Agency", 
 "IFY-1-1M": "Imunify360 Standalone Single User"
}

[edit] 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.

[edit] 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.

[edit] Upgrade Guide

Seeking a solution that offers greater flexibility, customization tailored to your precise needs, and unrestricted availability?
There is an option that not only proves to be cost-effective in the long run but also includes prioritized support services, making it a truly valuable investment.

Opt for the Open Source version of your Plesk Key Administrator For WHMCS module to unlock these benefits.
Simply click on either the Get Source Code or Upgrade To Lifetime button found on the product's page in our client area to complete the one-step upgrade process, with a dedicated discount already applied.

Follow a comprehensive guide covering the transition process, the advantages it brings, and step-by-step instructions on what to do next after the order has been successfully finalized.

[edit] 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.

5. If you encounter an error: 'The IP you provided is empty, or has incorrect format' when activating your product addon, please make sure you have provided the IP address in the 'Dedicated IP' field in the product's details.
This field is required if the 'Disable IP Binding' option is not selected in the product addon settings. If the 'Dedicated IP' is filled out by cron, make sure you activate the addon after it is ready.

If the 'Disable IP Binding' option is selected, the 'Dedicated IP' is not required to activate the product addon successfully.

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