License API

Trial Key

7min

The default behavior is that a Combination of same hardwareID and product will give you the same trial key. This prevents people getting new trial keys on same computer.
Product needs to allow trial for trial license to be created. allow_trial field on the product needs to be set as true.
If you want to allow multiple licenses on trial for the same device, you can enable this behaviour by changing Allow multiple licenses on trial inside the vendor platform on your company account settings view
GET
Params
Query Parameters
hardware_id
required
String
Unique value which identifies some device/container/session or similar resource.
product
required
String
Product short code
license_key
optional
String
Required if product is key_based. Attach the license key (eq. 1111-2222-3333-4444)
username
optional
String
Required if product is user based. Attach the assigned license user email (eq. user@example.com)
license_policy
optional
String
Contains license policy code, if omited the default license policy for the product will be used
Header Parameters
Date
required
String
eq. Thu, 17 Nov 2022 20:51:35 GMT
Authorization
required
String
See signing of the License API calls article.
Curl
Node.js
JS
Python
Ruby
|
import requests

url = "/api/v4/trial_key?hardware_id=string&product=string&license_key=string&username=string"

payload={}
headers = {
   'Accept': 'application/json',
   'Date': 'string',
   'Authorization': 'string'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

import requests

url = "/api/v4/trial_key?hardware_id=string&product=string&license_key=string&username=string"

payload={}
headers = {
   'Accept': 'application/json',
   'Date': 'string',
   'Authorization': 'string'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)
RESPONSES
200
|
License-based products
{
    "license_type": "perpetual",
    "is_trial": true,
    "license": "132-31-31-3-1-3123"
}
User-based products
{
    "license_type": "perpetual",
    "is_trial": true,
    "license_user": "licensed_user_email@gmail.com"
}
License-based products
{
    "license_type": "perpetual",
    "is_trial": true,
    "license": "132-31-31-3-1-3123"
}
User-based products
{
    "license_type": "perpetual",
    "is_trial": true,
    "license_user": "licensed_user_email@gmail.com"
}
﻿
Additional optional data
These GET parameters are optional and valid ONLY if email is also supplied. Customer is automatically created (or associated) when they are provided
first_name - optional, user first name
last_name - optional, user last name
phone - optional, user phone
address - optional, customer address
postcode - optional, customer postcode
state - optional, , customer state
country - optional, , customer country
city - optional, , customer city
reference - optional, customer reference (max 200 char)
List of exceptions
missing_parameters (400): Some parameters are missing in the request: { params }
missing_hardware_id (400): The hardware_id missing in the request
unknown_product (400): Provided product was not found
trial_not_allowed (400):Product does not allow trial
email_missing (400): An email is missing for user-based product
﻿

Updated 22 Sep 2023

Did this page help you?

TABLE OF CONTENTS

GET

/api/v4/trial_key

Additional optional data

List of exceptions