Generate License Keys

A License Key Generator allows you to create customized licensing information for customers at the time of purchaseClosed An order made by a customer and the records associated with it.. Unlike license key lists, these licenses are not pre-generated. Rather, when the customerClosed An individual or business purchasing your product or service by placing an order through Cleverbridge. The customer is the end user of this product, as they are not allowed to resell the purchased products or services. ​ A customer is unique per client. If a customer purchases products or services from two different clients, there are 2 separate records of said customer.​ clicks 'Buy', the Cleverbridge platform calls your license key generator, submits the purchase details, and requests the license information back as a response.

This offers you the following advantages:

  • Manual effort is not required any longer to regularly upload additional license key lists.
  • The license can include information about the customer. This helps reduce software piracy because customers are less likely to pass this information on to someone else.

To manage license keys, go to our web admin tool and select Tools > Key Generator.


To offer license key upgrades using our APIs, see License Key Upgrades.

To add a key generator using the Commerce Assistant, see Key Generators ✱.


On the Key Generator dashboard, you can find the following:

Add a Key Generator

You can use the Key Generator section to add, view, and edit a web key generator. To add a web key generator, do the following:

  1. In the main menu of the web admin tool, select Tools > Key Generator, and click Add Key Generator.
  2. Enter information in the following fields:
  3. Field Description
    Name Enter a unique name for the key generator.

    Enter the full URL of the key generator.


    The URL of your key generator must have an HTTPS scheme.


    SSL certificates for HTTPS are only supported if they are signed by a trusted authority.

    Authenticate Select to authenticate username and password access to the key generator.
    Username and Password Enter a username and password to access the key generator.
    Interface Select Type 1, unless Client Experience has instructed you otherwise.
    Character Encoding Select the type of JSON or XML character encoding to use for the key generation. Most clients typically choose Unicode (UTF-8).
    Use Romanized Contact Values Select to render western characters for the Company, First name, and Last name contact values for languages such as Chinese, Japanese, and Russian.
    Call Once Per Purchase If selected, the key generator is called once for the entire purchase in the shopping cart. If left unchecked, the key generator is called once for every purchase item in the shopping cart.
    Notification Document Type

    Depending on if and which type is selected here, an XML or JSON notification with transactional data is pushed to the key generator during the API call. If not selected, the key generator will receive a limited amount of information.


    The notification document used in web key generator calls is identical to the PaidOrderNotification, with the exception of the Deliveries Array.

    XML Schema Select the XML schema version. XML notifications can be generated so that they are compatible with newer or older versions of XML.
    Client Handles Errors

    Select if you wish to manage key generation errors on your own. If you do not select this option, Cleverbridge manages key generation errors (recommended).


    If a key generation or key list error occurs, the following happens:

    • If you have set up this notification type, you receive an ErrorNotification.
    • An error log entry is created.
    • The Cleverbridge platform makes up to five attempts to generate or obtain the key (after 1-2-4-8-16 hours). After each unsuccessful attempt, an ErrorNotification is sent and an error log entry created.
    • If the fifth attempt to generate or obtain the key fails, our Customer Support will investigate the error (unless Client handles errors is activated).
  4. Click Save and Complete.

For more Information, see Implement License Key Generator.

Define a License Key Template

Cleverbridge offers you the option to define a template for your license key. To set up a template in the web admin tool, do the following:

  1. In the Product portal, select the product for which you would like to create a license key template.
  2. Under Delivery, select the Key Template and Email Key Template tabs.
  3. 3. Create a template. You can use the following placeholders:

    Placeholder Description
    <Key> License key
    <RegName> Customer name
    <ProductId> Product ID


    Internal product ID
    <[NAME_OF_X_PARAM]> Corresponding x-parameterClosed The x-parameter is a variable appended to a URL that allows grouping and tracking orders for later reporting purposes. It also enables you to pass through data that you want to capture in the order process. X-parameters can also be used to control design elements based on the value of the x-parameter.
    <ProductName> Name of the ordered product
    <Quantity> Quantity of the ordered product
    <ProductTrialUrl> URL to download a trial version of the product

4. Click Save and Complete

For more information about templates, including information about email key templates, see Products ✱.