License API Collection

Base URL and Authentication Requirements

License API Base URL

All License API requests must use the License API domain: https://api.licensespring.com

Do not use https://saas.licensespring.com for License API requests. The saas domain is reserved for the Management API.

Required Authentication Keys

The License API supports the following authentication methods:

• apiKey
• sharedKey

Both keys must be configured in the environment for Shared Key authentication workflows.

OAuth Authentication (optional)

If using the OAuth version of the License API, the following credentials are required:

• client_id
• client_secret

The OAuth collection will obtain an access token using these values and automatically apply it to subsequent requests.

License API Environment Variables

Used by License API and License API – OAuth collections.

Variable	Description
default_product_code	Product code associated with the license.
default_license_key	License key used for activation/validation.
default_hardware_id	Hardware ID for binding and validation.
default_feature_code	Feature identifier for license feature operations.
default_username / default_password	Used for user-based licenses.
default_customer_account_code	Customer account reference used by some endpoints.
default_license_id / default_bundle_code	Identifiers for specific license or bundle operations.
request	Required for offline flows. Must be set to activation or deactivation.

Values can be set manually or retrieved through License API requests or the LicenseSpring UI. Please populate fields based on your use case for each endpoint.

How the Collections Work

License api collection

Purpose: To interact with licensing endpoints using either API Key/Shared Key authentication.

Requirements: Most requests require:

• default_product_code
• default_license_key
• default_hardware_id

Headers such as Date and Authorization are generated automatically.

License api - Oauth collection

Purpose: To interact with License API endpoints using OAuth 2.0 authentication.

Usage: Set client_id and client_secret in the environment from our vendor platform. The collection obtains an access token automatically and uses it for all subsequent licensing requests.

Manual variable adjustment (optional)

If you want to test with a specific license key, hardware ID, feature code, or bundle ID, you may replace the corresponding environment variable manually.

1

Open the LicenseSpring platform UI

Navigate to the LicenseSpring platform where your product and license information is available.

2

Copy the license key or product code you want to test

Locate the specific license or product and copy the relevant values.

3

Paste it into the relevant environment variable

Update variables such as default_license_key, default_product_code, etc., in your collection environment.

4

Re-run the desired request

Execute the request in the collection to test with the updated values.

You may also temporarily place literal values directly into the request body. Every needed variable can be found and created through our vendor platform.

Offline Licensing Notes

Some License API workflows require special handling:

• Offline activation
• Offline deactivation
• v2 offline schema

In these cases, the variable request must be set to one of the following:

activation

deactivation

Ensure the final JSON object in the body does not contain trailing commas when uncommenting optional parameters.

Examples of available offline requests v1 used for activation/deactivation:

• {{offline_request_file}} -> used for key-based license
• {{offline_request_file_bundle}} -> used for key-based bundle licenses
• {{offline_request_file_user}} -> used for user-based licenses
• {{offline_request_file_user}} -> can also be used for user-based licenses if default_product_code points to bundle_code (set in the environment)

Examples of available offline requests v2 used for activation/deactivation:

• {{offline_request_file_v2}} -> key-based licenses — also can be used for bundle if default_product_code set to bundle_code (set in the environment)
• {{offline_request_file_v2_user}} -> user-based licenses — also can be used for bundle if default_product_code set to bundle_code (set in the environment)

Data manipulation

For manual data manipulation, the same principles apply as with the Management API.

If any aspect is unclear, consult the License API docs for each request.

Please check your company settings and under preferences tab you will see:

Some of the license api requests depends on the selected settings in order to work, so keep that in mind.

Remember to review any comments associated with each request. For instance, to enable the floating release functionality, you should edit the desired license, verify the floating cloud checkbox via the platform, and subsequently execute the request to ensure proper operation.

Floating Cloud Checkbox Selected.

Floating Release

Example Comment: Verify Floating Cloud Status on Desired License via Platform

Here's an example of how to perform this check using two different scenarios: license-based and user-based.

License-Based Verification

For license-based verification, use the following request body:

License-based request body

{
  "license_key": "{{activate}}",
  "hardware_id": "{{hardware_id}}",
  "product": "{{product_code}}"
}

User-Based Verification

For user-based verification, utilize the following request body:

User-based request body

{
  "hardware_id": "{{default_hardware_id}}",
  "product": "{{default_product_code}}",
  "username": "{{default_username}}",
  "password": "{{default_password}}",
}

Note: You can also use the same environment as on our management API with the provided data.