API Reference

GetActivationKey

Description

Creates an activation key on the License Server.

To call this function, you must set the enableGetActivationKey server property to true.

You should never call this function from within the application. GetActivationKey should be called from systems that cannot be intercepted by your client such as your web site, your own server, your ecommerce provider. It is also highly recommended to enforce the user/pwd authentication when calling this function as described here.

To invoke this method via a URL, append this function's name to the URL of the QLM License Server and add the required arguments.

http://yourserver/yourvirtualdirectory/qlmservice.asmx/GetActivationKey?is_productid=[productID]&is_majorversion=[majorVersion]&is_minorversion=[minorVersion]&is_vendor=[vendor]

Arguments

ParameterDescription
is_majorversionyour product's major version as defined in QLM
is_minorversionyour product's minor version as defined in QLM
is_productidyour product id as defined in QLM
is_qlmversionQLM engine version
is_quantitythe number of licenses to create. Works in conjunction with is_usemultipleactivationskey. Note that when calling this API from one of the supported eCommerce Providers, you do not need to set is_quantity as it is automatically passed from the eCommerce provider to QLM.
is_vendorone of the supported vendors

Optional Arguments

ParameterDescription
is_additionalactivationsby default, the number of activations enabled for each generated license key is based on the quantity of licenses purchased. For example, if a customer purchases 3 licenses, they will receive an activation key with 3 activations (is_usemultipleactivationskey must be true). To provide additional activations, set this argument to the number of additional activations required. Example: &is_additionalactivations=2
is_affiliateidthe id of the affiliate/reseller associated with the license key
is_computertypespecifies the type of the client computer. Possible values are: 0 | 1 | 2 . 0 sets the computer type to 'none'. 1 sets the computer type to 'PC'. 2 sets the computer type to 'VM'.
is_featuressemi comma separated list of feature sets and their corresponding values. Example: is_features=0:1;1:2;2:3;3:6.
is_floatingset this value to true to create floating licenses. The number of floating seats will be set to the quantity ordered.
is_licensemodelthe license model can be one of: permanent | trial | subscription. Example: &is_licensemodel=subscription
is_maintdurationset this value to the duration of the maintenance plan. By default, a maintenance plan is 365 days. The default value can be changed in the web.config file of the License Server. Example: &is_maintduration=180
is_maintenance_planset this value to 1 to enable the maintenance plan for this license. Example: &is_maintenance_plan=1
is_numberofactivationsperkeyfor each generated key, set the number of activations allowed. Example: is_numberofactivationsperkey=3. This argument is only effective when is_usemultipleactivationskey is false.
is_pwdpassword defined in Manage Keys / 3rd Party Extensions.
is_usemultipleactivationskeywhen set to true or not set, if multiple licenses are ordered in the same request, the system returns one activation key for all licenses. When set to false, the system returns one activation key for each ordered license. The default is true.
is_userusername defined in Manage Keys / 3rd Party Extensions.