License Activation

11min
Activation of a product license for a specific device identified by its hardware ID
POST
Request
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.
Body Parameters
hardware_id
required
String
Unique hardware ID generated for some device
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. [email protected])
password
optional
String
Required if product is user based. Attach the assigned license user password (eq. somepassword)
id_token
optional
String
Required if using SSO. Attach the id_token received from the SSO if Implicit grant authorization method is being used.
code
optional
String
Required if using SSO. Attach the code received from the SSO if Authorization code grant method is being used.
customer_account_code
optional
String
Required if using SSO. Attach the customer_account_code to which SSO provider is configured. 
license_id
optional
Number
Ensures that the action affects only the license with the specified ID. This is useful if e.g. you have multiple licenses for the same product assigned to the same user. For obtaining a list of licenses assigned to a user, see "User Licenses"
is_vm
optional
Boolean
Set as true if using virtual machine.
vm_info
optional
String
Optional virtual machine informations.
os_ver
optional
String
Version of the operating system.
hostname
optional
String
Device hostname
os_hostname
optional
String
Hostname of the OS ( check this before publishing! )
ip
optional
String
IP address
ip_local
optional
String
Local IP address ( check this before publishing! )
app_ver
optional
String
Version of the product application used with this license.
sdk_ver
optional
String
Version of the SDK used.
mac_address
optional
String
Device MAC address
variables
optional
Object
Device variables. Variables are sent as a JSON object where the key is the variable name, and the value is the value of the variable
Curl
Node.js
JS
Python
Ruby
require "uri"
require "net/http"

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["Date"] = "string"
request["Authorization"] = "string"
request.body = "{\"hardware_id\":\"String\",\"product\":\"string\",\"license_key\":\"string\",\"username\":\"string\",\"password\":\"string\",\"id_token\":\"string\",\"code\":\"string\",\"customer_account_code\":\"string\",\"is_vm\":\"Boolean\",\"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\"}"

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

require "uri"
require "net/http"

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["Date"] = "string"
request["Authorization"] = "string"
request.body = "{\"hardware_id\":\"String\",\"product\":\"string\",\"license_key\":\"string\",\"username\":\"string\",\"password\":\"string\",\"id_token\":\"string\",\"code\":\"string\",\"customer_account_code\":\"string\",\"is_vm\":\"Boolean\",\"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\"}"

response = http.request(request)
puts response.read_body
Responses
200
400
{
    "license_signature": "{license_signature_here}",
    "validity_period": null,
    "product_features": [
        {
      		"name": "feature 3",
            "code": "F3",
            "feature_type": "activation",
            "expiry_date": "2022-02-25"
        },
        {
            "name": "feature 4",
            "code": "F4",
            "feature_type": "consumption",
            "max_consumption": 10,
            "total_consumptions": 0,
          	"expiry_date": null
        }
    ],
    "license_type": "perpetual",
    "license_key": "1111-2222-3333-4444",
    "is_trial": false,
    "maintenance_period": null,
    "custom_fields": [
        {
            "name": "Field1",
            "data_type": null,
            "value": "default"
        }
    ],
    "max_activations": 1,
    "times_activated": 1,
    "customer": {
        "email": "[email protected]",
        "company_name": "",
        "reference": "",
        "phone": "",
        "first_name": "",
        "last_name": "",
        "customer_account": {
            "id": 20,
            "name": "LicenseSpring Inc.",
            "code": "licensespring_inc."
        }
    },
    "allow_overages": false,
    "max_overages": 0,
    "prevent_vm": false,
    "is_floating_cloud": false,
    "is_floating": false,
    "floating_timeout": 120,
    "transfer_count": 417,
    "max_transfers": 0,
    "start_date": null,
    "product_details": {
        "product_id": 1586066454418173,
        "product_name": "Acme App",
        "short_code": "XY",
        "authorization_method": "license-key"
    },
    "can_borrow": false,
    "max_borrow_time": 0,
    "device_id": 1642501399344530,
    "id": 1620711133620270
}
{
    "license_signature": "{license_signature_here}",
    "validity_period": null,
    "product_features": [
        {
      		"name": "feature 3",
            "code": "F3",
            "feature_type": "activation",
            "expiry_date": "2022-02-25"
        },
        {
            "name": "feature 4",
            "code": "F4",
            "feature_type": "consumption",
            "max_consumption": 10,
            "total_consumptions": 0,
          	"expiry_date": null
        }
    ],
    "license_type": "perpetual",
    "license_key": "1111-2222-3333-4444",
    "is_trial": false,
    "maintenance_period": null,
    "custom_fields": [
        {
            "name": "Field1",
            "data_type": null,
            "value": "default"
        }
    ],
    "max_activations": 1,
    "times_activated": 1,
    "customer": {
        "email": "test@example.com",
        "company_name": "",
        "reference": "",
        "phone": "",
        "first_name": "",
        "last_name": "",
        "customer_account": {
            "id": 20,
            "name": "LicenseSpring Inc.",
            "code": "licensespring_inc."
        }
    },
    "allow_overages": false,
    "max_overages": 0,
    "prevent_vm": false,
    "is_floating_cloud": false,
    "is_floating": false,
    "floating_timeout": 120,
    "transfer_count": 417,
    "max_transfers": 0,
    "start_date": null,
    "product_details": {
        "product_id": 1586066454418173,
        "product_name": "Acme App",
        "short_code": "XY",
        "authorization_method": "license-key"
    },
    "can_borrow": false,
    "max_borrow_time": 0,
    "device_id": 1642501399344530,
    "id": 1620711133620270
}
﻿
User-Based License Activation
Curl
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 '{
    "username": "[email protected]",
    "password": "some_password123",
    "hardware_id": "some-unique-id",
    "product": "XY"
}'
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 '{
    "username": "test@example.com",
    "password": "some_password123",
    "hardware_id": "some-unique-id",
    "product": "XY"
}'
﻿
Single-Sign-On License Activation:
Short instructions and link to detailed section about using Single Sign On directly via License Api can be find here﻿ 
Curl
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"
}'
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 parameter lets you set device variables during activation. For more information on how device variables work, see Device Variables﻿﻿
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.
﻿
Updated 25 Sep 2024
Did this page help you?
License Activation/Deactivation
License Deactivation