Activate License (Online Method)

Endpoint

Method: POST
Path: /api/v4/activate_license
Description: Activates a license for a device and returns the license payload.

Authentication

These requests are authenticated and signed. See License API Authorization.

Required headers

Date (string) — RFC7231 GMT date string (example: Thu, 17 Nov 2022 20:51:35 GMT)
Authorization (string) — signature or bearer token (depending on auth method)

Recommended headers

Accept: application/json
Content-Type: application/json

Request

Body parameters

Required:

hardware_id (string) — Unique hardware ID generated for the client device
product (string) — Product short code

One of (depending on product authorization method):

license_key (string) — Required for key-based products
username + password (string) — Required for user-based products
id_token + customer_account_code (string) — Required for SSO Implicit grant
code + customer_account_code (string) — Required for SSO Authorization Code grant

Optional:

license_id (number) — Ensures the action affects only the license with this ID
is_vm (boolean) — Set to true if request is sent from a VM
vm_info (string)
os_ver (string)
hostname (string)
os_hostname (string)
ip (string)
ip_local (string)
app_ver (string)
sdk_ver (string)
mac_address (string)
variables (object) — Device variables as a JSON object

Minimal example (JSON)

{
  "hardware_id": "some-unique-id",
  "product": "XY",
  "license_key": "AAAA-BBBB-CCCC-DDDD"
}

Schema

Request Body

Request schema (TypeScript + JSON Schema)

TypeScript

type LicenseActivationRequestBody = ({

  // for key-based licenses:
  license_key: string

} | {

  // for user-based licenses, using username & password authentication:
  username: string
  password: string

} | {

  // for user-based licenses, using single sign-on Implicit grant authentication:
  id_token: string
  customer_account_code: string

} | {

  // for user-based licenses, using single sign-on Authorization code grant authentication:
  code: string
  customer_account_code: string

}) & {

  // required properties:
  hardware_id: string
  product: string

  // optional properties:
  bundle_code?: string | undefined
  license_id?: number | undefined
  is_vm?: boolean | undefined
  vm_info?: string | undefined
  os_ver?: string | undefined
  hostname?: string | undefined
  os_hostname?: string | undefined
  ip?: string | undefined
  ip_local?: string | undefined
  app_ver?: string | undefined
  sdk_ver?: string | undefined
  mac_address?: string | undefined
  variables?: { [key: string]: string } | undefined
}

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "allOf": [
    {
      "oneOf": [
        {
          "type": "object",
          "properties": {
            "license_key": { "type": "string" }
          },
          "required": ["license_key"],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "username": { "type": "string" },
            "password": { "type": "string" }
          },
          "required": ["username", "password"],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "id_token": { "type": "string" },
            "customer_account_code": { "type": "string" }
          },
          "required": ["id_token", "customer_account_code"],
          "additionalProperties": false
        },
        {
          "type": "object",
          "properties": {
            "code": { "type": "string" },
            "customer_account_code": { "type": "string" }
          },
          "required": ["code", "customer_account_code"],
          "additionalProperties": false
        }
      ]
    },
    {
      "type": "object",
      "properties": {
        "hardware_id": { "type": "string" },
        "product": { "type": "string" },
        "bundle_code": { "type": "string" },
        "license_id": { "type": "number" },
        "is_vm": { "type": "boolean" },
        "vm_info": { "type": "string" },
        "os_ver": { "type": "string" },
        "hostname": { "type": "string" },
        "os_hostname": { "type": "string" },
        "ip": { "type": "string" },
        "ip_local": { "type": "string" },
        "app_ver": { "type": "string" },
        "sdk_ver": { "type": "string" },
        "mac_address": { "type": "string" },
        "variables": {
          "type": ["object", "null"],
          "additionalProperties": { "type": "string" }
        }
      },
      "required": ["hardware_id", "product"],
      "additionalProperties": false
    }
  ]
}

Response Body

Response schema (TypeScript + JSON Schema)

Full response schemas are shared across activation endpoints. See Activate License Offline Method for the complete response TypeScript shape.

TypeScript

// See Activate License (Offline) for the full shape.
type LicenseActivationResponseBody = object;

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "$comment": "See Activate License (Offline) for the full schema."
}

Response objects contain a license_signature value which the client app can use to verify authenticity (see Response Signature).

License Authorization Method

There are two types of product licenses based on how the client application authorizes itself to interact with a license:

Key-based product licenses

Each license assigned to the product requires the client to provide a license key (license_key) in order to activate, check or deactivate the license. The response will contain license_key and product_details.authorization_method will be "license-key".

User-based product licenses

Each license has a corresponding "license user" instead of a license key. Ways to access:

username & password
id_token & customer_account_code (SSO Implicit grant)
code & customer_account_code (SSO Authorization code grant)

In the response, product_details.authorization_method will be "user" and the response will contain a user object.

License Types

license_type property values:

Perpetual: perpetual
Time-limited: time-limited
Subscription: subscription
Consumption: consumption

See: License Types

Errors

If an error occurs, HTTP status will be 400 or higher and the response body will have:

{
  status: number,
  code: string,
  message: string
}

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "status": { "type": "number" },
    "code": { "type": "string" },
    "message": { "type": "string" }
  },
  "required": [
    "status",
    "code",
    "message"
  ],
  "additionalProperties": false
}

List of exceptions:

unknown_product (400): Provided product was not found

license_not_found (400): License with the provided license user not found

license_not_enabled (400): The license is not enabled

vm_not_allowed (400): Virtual machine not allowed

offline_floating_cloud_not_supported (400): Floating cloud licenses cannot be activated offline

license_start_date_error (400): This license cannot be activated before start date: {date}

blacklisted (400): This device is blacklisted

license_activated_max_times (400): This license key has already been activated the maximum number of times

license_user_activated_max_times (400): License user has activated this license max times

license_expired (400): License validity period has expired

license_transferred_max_times (400): This license has already been transferred the maximum number of times

license_device_exists (409): A device matching this hardware_id is already created on the license.

product_version_not_supported (400): License product version does not support the app_ver sent in the request

Examples

curl --location --request POST '/api/v4/activate_license' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Date: string' \
--header 'Authorization: string' \
--data-raw '{
  "hardware_id": "some-unique-id",
  "product": "XY",
  "license_key": "AAAA-BBBB-CCCC-DDDD"
}'

var request = require('request');

var options = {
  method: 'POST',
  url: '/api/v4/activate_license',
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'Date': 'string',
    'Authorization': 'string'
  },
  body: JSON.stringify({
    hardware_id: 'some-unique-id',
    product: 'XY',
    license_key: 'AAAA-BBBB-CCCC-DDDD'
  })
};

request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

var myHeaders = new Headers();
myHeaders.append("Accept", "application/json");
myHeaders.append("Content-Type", "application/json");
myHeaders.append("Date", "string");
myHeaders.append("Authorization", "string");

var raw = JSON.stringify({
  hardware_id: "some-unique-id",
  product: "XY",
  license_key: "AAAA-BBBB-CCCC-DDDD"
});

var requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: raw,
  redirect: 'follow'
};

fetch("/api/v4/activate_license", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

import requests

url = "/api/v4/activate_license"

payload = {
  "hardware_id": "some-unique-id",
  "product": "XY",
  "license_key": "AAAA-BBBB-CCCC-DDDD"
}

headers = {
  "Accept": "application/json",
  "Content-Type": "application/json",
  "Date": "string",
  "Authorization": "string"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)

require "uri"
require "net/http"
require "json"

url = URI("/api/v4/activate_license")

http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request["Date"] = "string"
request["Authorization"] = "string"
request.body = JSON.dump({
  hardware_id: "some-unique-id",
  product: "XY",
  license_key: "AAAA-BBBB-CCCC-DDDD"
})

response = http.request(request)
puts response.read_body

Single-Sign-On License Activation

SSO setup and how to get the SSO URL: Single Sign On URL.

curl --location --request POST 'https://api.licensespring.com/api/v4/activate_license/' \
--header 'Date: Mon, 10 May 2021 13:14:18 GMT' \
--header 'Authorization: algorithm="hmac-sha256",headers="date",signature="{generated_signature}",apikey="{your_api_key}"' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id_token": "{id_token_here_}",
  	"code": "{code_here}",
    "customer_account_code": "acme_inc",
    "hardware_id": "some-unique-id",
    "product": "XY"
}'

Use either id_token or code, not both at the same time.

Device Variables

The optional variables property lets you set device variables during activation. See Device Variables.

PreviousLicense Activation & Deactivation NextActivate License (Offline Method)

Last updated 26 days ago

Was this helpful?

Good night

hashtagEndpoint

hashtagAuthentication

hashtagRequired headers

hashtagRecommended headers

hashtagRequest

hashtagBody parameters

hashtagMinimal example (JSON)

hashtagSchema

hashtagRequest Body

hashtagResponse Body

hashtagLicense Authorization Method

hashtagKey-based product licenses

hashtagUser-based product licenses

hashtagLicense Types

hashtagErrors

hashtagExamples

hashtagSingle-Sign-On License Activation

hashtagDevice Variables

Endpoint

Authentication

Required headers

Recommended headers

Request

Body parameters

Minimal example (JSON)

Schema

Request Body

Response Body

License Authorization Method

Key-based product licenses

User-based product licenses

License Types

Errors

Examples

Single-Sign-On License Activation

Device Variables