Nova Integration for WebPros Cloud

Overview #

This document explains how to connect your Nova WebPros Cloud server to your customer portal.

Integration steps for Plesk partners #

Step 1: Create a Nova Prompt page and embed the Nova script #

You must create a Nova Prompt page and embed the Nova script. You can customize the script to:

• Adjust the styles of the prompt field.
• Pass the user-entered prompt as a parameter.

For more information, read our Nova Prompt Integration Widget Guide documentation and our example of an embedded prompt.

Step 2: User sign-up, sign-in, and prompt handling #

When a user enters a prompt and selects Start Building, your integration should initiate the Nova sign-up and sign-in process.

Account creation and license provisioning #

Use Key Administrator’s createKey function to create a new user account and provision a Nova license for that user.

After provisioning the license, use Key Administrator’s getKey function to retrieve the user’s current license details.

User authentication #

To sign the user in to Nova, use Key Administrator’s getSsoLink function. This function returns a Single Sign-On (SSO) link that authenticates the user and redirects them to the Nova application.

Passing the prompt into Nova (optional) #

If you want Nova to prefill or use the prompt the user entered in Step 1, pass it as a Base64-encoded string:

• Encode the user’s prompt into Base64.
• Include the encoded value in the promptToken parameter when using the getSsoLink function.

Step 3: Upgrade a user’s plan #

If a user purchases a higher-tier plan, you can upgrade their Nova license by using Key Administrator’s modifyKey function.

• Provide the new license identifier that should replace the user’s current license.

Terminate a user’s Nova account #

If you need to permanently deactivate a user’s Nova account, use Key Administrator’s terminateKey function.

Executing this function will:

• Permanently delete the user’s Nova account.
• Remove access to all Nova projects that account owns.
• Revoke the license you provisioned for the user.

Integration steps for cPanel partners #

Step 1: Create a Nova Prompt page and embed the Nova script #

You must create a Nova Prompt page and embed the Nova script. You can customize the script to:

• Adjust the styles of the prompt field.
• Pass the user-entered prompt as a parameter.

For more information, read our Nova Prompt Integration Widget Guide documentation and our example of an embedded prompt.

Step 2: User sign-up, license provisioning, and prompt handling #

When a user enters a prompt and selects Start Building, your integration should initiate the Nova sign-up flow and provision the user’s Nova Cloud license through Manage2.

Account creation and license provisioning #

Use Manage2’s XMLlicenseAdd.cgi function to create a new user account and provision a Nova Cloud license for that user. For Nova Cloud, this function supports the domain, language, and zone parameters.

License and package lookup #

After provisioning the license, use Manage2’s XMLlicenseInfo.cgi function to retrieve the user’s current license details and Manage2’s XMLpackageInfo.cgi function to retrieve the package details associated with that license. If your integration needs the raw lookup response for license resolution or validation, use Manage2’s XMLRawlookup.cgi function.

Passing the prompt into Nova (optional) #

If you want Nova to prefill or use the prompt the user entered in Step 1, pass it as a Base64-encoded string:

• Encode the user’s prompt into Base64.
• Include the encoded value in the promptToken parameter when handing the user off to Nova.

Step 3: Upgrade a user’s plan #

If a user purchases a higher-tier plan, use Manage2’s XMLpackageUpdate.cgi function to update the user’s Nova Cloud package.

Step 4: Review a user’s Nova Cloud license and package details #

If you need to confirm a user’s current Nova Cloud entitlement, use Manage2’s XMLlicenseInfo.cgi and XMLpackageInfo.cgi functions to inspect the active license and package data. If you need the raw lookup response for troubleshooting or reconciliation, use Manage2’s XMLRawlookup.cgi function.

Terminate a user’s Nova account #

If you need to permanently deactivate a user’s Nova account, use Manage2’s XMLlicenseExpire.cgi function.

Executing this function will:

• Permanently delete the user’s Nova account.
• Remove access to all Nova projects that account owns.
• Revoke the license you provisioned for the user.