Plesk Key Administrator For WHMCS

From ModulesGarden Wiki
Jump to: navigation, search


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
✔ Add Multiple Features Per Product
  • Client Area Features:
✔ Order License
✔ View License Details
✔ Change IP Address Assigned To License
  • General Info:
✔ 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)
✔ Multi-Language Support
✔ Supports PHP 5.4 Up To PHP 7
✔ Supports WHMCS Templates Five and Six
✔ Supports WHMCS V6 and V7

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 your 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 7, while the second one is aimed at PHP 5.4 up to PHP 5.6.
It does not apply to open source versions.

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

OKA2.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 your client area → 'My Products'.

OKA4.png
6. Now we will show you how to configure a new product.

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 username and 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 product, click on 'Setup' 'Products/Services' 'Products/Services'.

If you do not have a product group, click on '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 click on 'Create a New Product'.

OKA11.png
13. Afterwards, choose your product type and product group from 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 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 the key type. 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/

Important! It is a one line command, do not split it into two lines.
Mark 'Show on Order Form' checkbox and press 'Save Changes' button.

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.

OKA17.png

Management

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

They can be licenses for all types of Plesk Panel, Cloud server, Kaspersky Antivirus for Plesk and many, many more.
Diversity of 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

Client Area

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

Additionally, your customers can change their license IP address.
To do it, client needs only to enter a new IP address and press 'Change IP' button.

OKA19.png


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.

Personal tools
Namespaces

Variants
Actions
Navigation
WHMCS Modules
cPanel Modules
Magento Extensions
Magento Themes
PrestaShop Modules
Blesta Extensions
General
Social