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/GetActivationKeyWithExpiryDate?is_productid=[productID]&is_majorversion=[majorVersion]&is_minorversion=[minorVersion]&is_vendor=[vendor]&is_expduration=[duration]&is_expdate=[date]
Arguments
| Parameter | Description |
|---|---|
| is_expduration | duration of evaluation version in days. |
| is_expdate | date at which the license will expire. The date format in is_expdate is based on the dateFormat settings in the License Server config file (web.config). The default format is: YYYY-MM-dd |
| is_majorversion | your product's major version as defined in QLM |
| is_minorversion | your product's minor version as defined in QLM |
| is_productid | your product id as defined in QLM |
| is_qlmversion | QLM engine version |
| is_quantity | the 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_vendor | one of the supported vendors |
Optional Arguments
| Parameter | Description |
|---|---|
| is_additionalactivations | by 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_affiliateid | the id of the affiliate/reseller associated with the license key |
| is_computertype | specifies 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_features | semi comma separated list of feature sets and their corresponding values. Example: is_features=0:1;1:2;2:3;3:6. |
| is_floating | set this value to true to create floating licenses. The number of floating seats will be set to the quantity ordered. |
| is_licensemodel | the license model can be one of: permanent | trial | subscription. Example: &is_licensemodel=subscription |
| is_maintduration | set 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_plan | set this value to 1 to enable the maintenance plan for this license. Example: &is_maintenance_plan=1 |
| is_numberofactivationsperkey | for each generated key, set the number of activations allowed. Example: is_numberofactivationsperkey=3. This argument is only effective when is_usemultipleactivationskey is false. |
| is_pwd | password defined in Manage Keys / 3rd Party Extensions. |
| is_usemultipleactivationskey | when 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_user | username defined in Manage Keys / 3rd Party Extensions. |
Remarks
When calling GetActivationWithExpiryDate, an expiry date can be set by using the is_expduration or is_expdate argument. For example, to create a license key that expires 31 days after purchase, you have 2 options:
-
Use the is_expdate argument such as: &is_expdate=2015-03-01. The generated license will expire on the specified date.
-
Use the is_expduration argument such as: &is_expduration=31.
The useDurationToSetExpiryDate setting in the QLM License Server "Server Properties" determines the behavior of the is_expduration argument. When useDurationToSetExpiryDate is true, an expiry date is computed by the License Server based on the order date plus the is_expduration period. For example, if a user purchased a 30 days subscription of your product on January 1st and is_expduration is set to 30, the license will be set to expire on January 31st.
When useDurationToSetExpiryDate is set to false, the generated license key does not have a specific expiry date but rather a duration-based license key. This means that the license expiry date is determined the first time the application is executed. For example, if a user purchased a 30-day subscription of your product on January 1st, but then runs your product for the first time on January 15, the 30-day license will only start on January 15.