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

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

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

The content of PHP version files should look like this.

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

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

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

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.

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

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

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

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.
Keep in mind that some keys require the IP binding option to be disabled to allow creating a license.
Afterwards press 'Save Changes' button.

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

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

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

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

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

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

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

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.

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

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.

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

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

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

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

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.

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.

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.

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

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.