website logo
⌘K
Getting Started
Introduction
Basic Concepts
Opening an Account
Creating & Configuring Products
Integrating SDK and Configuring License Fulfillment
Activate a Key-Based License
Vendor Platform
Issuing New Licenses
License Detail View
Order Detail View
Customer Detail View
Metadata
Analytics
Settings
Product Configuration
Product Features
Product Custom Fields
Product Versioning
License Policies
Product Bundles
License Entitlements
License Types
Activations & Device Transfers
Features
Custom Fields
License Start Date
License Note
Maintenance Period
Trial Licenses
Floating Licenses
License Activation Types
Portals
End-User Portal
Offline Portal
Air-Gapped Portal
License API
License API Authorization
License Activation/Deactivation
License Check
Consumption
Floating
Trial Key
Product Details
Device Variables
Changing Password
Management API
Making API Requests
Management API Authorization
Customer
Product
Order
License
Device
Analytics
SDKs
Tutorials
.NET/C# SDK
.NET/C# Management SDK
C++ SDK
Java SDK
Python SDK
Go SDK
Delphi SDK
Swift/Objective-C SDK
Android SDK
Unity SDK
Errors and Response Codes
Floating Server
API Reference
Deployment
Configuration
Floating Server UI
Securing the Server
Whitelabeling
FAQ
Floating Server Changelog
Integrations
Salesforce
FastSpring
Stripe
Shopify
Common Scenarios
Single Sign On (SSO)
Glossary
General
SDK Glossary
Vendor Platform
Product Configuration Glossary
License Configuration
Postman Collections
Frequently Asked Questions
Changelog
License API changelog
Platform changelog
Docs powered by
Archbee
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)

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"
}


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?
PREVIOUS
Borrow
NEXT
Product Details
Docs powered by
Archbee
/api/v4/trial_key
TABLE OF CONTENTS
GET
/api/v4/trial_key
Additional optional data
List of exceptions
Docs powered by
Archbee