Tokens

Managing and Tracking Licenses in Babel Licensing Service

In the Babel Licensing Service API, License Tokens play a crucial role in the management and tracking of licenses. License tokens are specialized digital keys that are central to the effective enforcement and monitoring of licensing terms. There are two main types of license tokens, each serving a distinct purpose in the licensing ecosystem.

Get

Roles: Administrator, LicenseManager

This method is used to obtain details about license tokens associated with a specific license. It enables users to query and view information related to both floating license tokens and license activation tokens under a particular license. This is crucial for monitoring how each license's tokens are distributed and used, ensuring alignment with compliance and licensing strategies.

Retrieves a list of tokens for a specific license.

get

Authorizations

Path parameters

licenseIdinteger · int32required

license_id is the ID of the license.

Query parameters

selectstringoptional

filterstringoptional

sortstringoptional

takeinteger · int32optional

skipinteger · int32optional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/licenses/{licenseId}/tokens' \
  --header 'x-api-key: YOUR_API_KEY'

200

default

200

{
  "success": true,
  "code": 1,
  "message": "text",
  "licenseTokens": [
    {
      "id": 1,
      "token": "text",
      "address": "text",
      "clientId": "text",
      "clientName": "text",
      "machineId": "text",
      "issueDate": "text",
      "expireDate": "text",
      "lastHeartbeat": "text",
      "hash": "text",
      "licenseId": 1,
      "license": {
        "id": 1,
        "licenseId": "text",
        "licenseType": "text",
        "format": "Xml",
        "description": "text",
        "issueDate": "text",
        "expireDate": "text",
        "supportExpireDate": "text",
        "revoked": true,
        "licenseKey": "text",
        "maxAllowedSites": 1,
        "userKey": "text",
        "licensingMode": "File",
        "hash": "text",
        "templateId": 1,
        "signatureKeysId": 1,
        "customerId": 1,
        "orderId": 1,
        "product": {
          "id": "text",
          "name": "text",
          "version": "text",
          "copyright": "text",
          "url": "text",
          "description": "text"
        },
        "licensee": {
          "name": "text",
          "company": "text",
          "contactInfo": "text",
          "url": "text"
        },
        "components": [
          "text"
        ],
        "assemblies": [
          {
            "id": 1,
            "name": "text",
            "version": "text",
            "culture": "text",
            "publicKeyToken": "text",
            "mappingFileId": 1,
            "debugSymbolsKey": "text"
          }
        ],
        "fields": [
          {
            "name": "text",
            "value": "text"
          }
        ],
        "features": [
          {
            "id": "text",
            "name": "text",
            "description": "text",
            "expireDate": "text",
            "key": "text",
            "data": "text"
          }
        ],
        "restrictions": [
          {
            "id": "text",
            "name": "text",
            "expireDate": "text",
            "properties": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            }
          }
        ]
      },
      "nodeLockedLicenseId": 1,
      "nodeLockedLicense": {
        "id": 1,
        "licenseId": "text",
        "licenseType": "text",
        "format": "Xml",
        "description": "text",
        "issueDate": "text",
        "expireDate": "text",
        "supportExpireDate": "text",
        "revoked": true,
        "licenseKey": "text",
        "maxAllowedSites": 1,
        "userKey": "text",
        "licensingMode": "File",
        "hash": "text",
        "templateId": 1,
        "signatureKeysId": 1,
        "customerId": 1,
        "orderId": 1,
        "product": {
          "id": "text",
          "name": "text",
          "version": "text",
          "copyright": "text",
          "url": "text",
          "description": "text"
        },
        "licensee": {
          "name": "text",
          "company": "text",
          "contactInfo": "text",
          "url": "text"
        },
        "components": [
          "text"
        ],
        "assemblies": [
          {
            "id": 1,
            "name": "text",
            "version": "text",
            "culture": "text",
            "publicKeyToken": "text",
            "mappingFileId": 1,
            "debugSymbolsKey": "text"
          }
        ],
        "fields": [
          {
            "name": "text",
            "value": "text"
          }
        ],
        "features": [
          {
            "id": "text",
            "name": "text",
            "description": "text",
            "expireDate": "text",
            "key": "text",
            "data": "text"
          }
        ],
        "restrictions": [
          {
            "id": "text",
            "name": "text",
            "expireDate": "text",
            "properties": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            }
          }
        ]
      }
    }
  ],
  "totalLicenseTokensCount": 1
}

Success

Post

Roles: Administrator, LicenseManager

The POST method is instrumental in generating new license tokens for a given license. Whether it’s for issuing new floating license tokens or activation tokens, this method plays a key role in expanding or renewing the licensing capabilities associated with a particular license. It is essential for granting additional access under an existing license or for activating new user or device rights.

post

Authorizations

Path parameters

licenseIdinteger · int32required

license_id is the ID of the license.

Body

licenseIdinteger · int32optional

license_id is the ID of the license.

licenseTokenobjectoptional

LicenseToken represents a license allocated on the client.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/licenses/{licenseId}/tokens' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "licenseId": 1,
    "licenseToken": {
      "id": 1,
      "token": "text",
      "address": "text",
      "clientId": "text",
      "clientName": "text",
      "machineId": "text",
      "issueDate": "text",
      "expireDate": "text",
      "lastHeartbeat": "text",
      "hash": "text",
      "licenseId": 1,
      "license": {
        "id": 1,
        "licenseId": "text",
        "licenseType": "text",
        "format": "Xml",
        "description": "text",
        "issueDate": "text",
        "expireDate": "text",
        "supportExpireDate": "text",
        "revoked": true,
        "licenseKey": "text",
        "maxAllowedSites": 1,
        "userKey": "text",
        "licensingMode": "File",
        "hash": "text",
        "templateId": 1,
        "signatureKeysId": 1,
        "customerId": 1,
        "orderId": 1,
        "product": {
          "id": "text",
          "name": "text",
          "version": "text",
          "copyright": "text",
          "url": "text",
          "description": "text"
        },
        "licensee": {
          "name": "text",
          "company": "text",
          "contactInfo": "text",
          "url": "text"
        },
        "components": [
          "text"
        ],
        "assemblies": [
          {
            "id": 1,
            "name": "text",
            "version": "text",
            "culture": "text",
            "publicKeyToken": "text",
            "mappingFileId": 1,
            "debugSymbolsKey": "text"
          }
        ],
        "fields": [
          {
            "name": "text",
            "value": "text"
          }
        ],
        "features": [
          {
            "id": "text",
            "name": "text",
            "description": "text",
            "expireDate": "text",
            "key": "text",
            "data": "text"
          }
        ],
        "restrictions": [
          {
            "id": "text",
            "name": "text",
            "expireDate": "text",
            "properties": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            }
          }
        ]
      },
      "nodeLockedLicenseId": 1,
      "nodeLockedLicense": {
        "id": 1,
        "licenseId": "text",
        "licenseType": "text",
        "format": "Xml",
        "description": "text",
        "issueDate": "text",
        "expireDate": "text",
        "supportExpireDate": "text",
        "revoked": true,
        "licenseKey": "text",
        "maxAllowedSites": 1,
        "userKey": "text",
        "licensingMode": "File",
        "hash": "text",
        "templateId": 1,
        "signatureKeysId": 1,
        "customerId": 1,
        "orderId": 1,
        "product": {
          "id": "text",
          "name": "text",
          "version": "text",
          "copyright": "text",
          "url": "text",
          "description": "text"
        },
        "licensee": {
          "name": "text",
          "company": "text",
          "contactInfo": "text",
          "url": "text"
        },
        "components": [
          "text"
        ],
        "assemblies": [
          {
            "id": 1,
            "name": "text",
            "version": "text",
            "culture": "text",
            "publicKeyToken": "text",
            "mappingFileId": 1,
            "debugSymbolsKey": "text"
          }
        ],
        "fields": [
          {
            "name": "text",
            "value": "text"
          }
        ],
        "features": [
          {
            "id": "text",
            "name": "text",
            "description": "text",
            "expireDate": "text",
            "key": "text",
            "data": "text"
          }
        ],
        "restrictions": [
          {
            "id": "text",
            "name": "text",
            "expireDate": "text",
            "properties": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            }
          }
        ]
      }
    }
  }'

application/json

200

default

200

{
  "success": true,
  "code": 1,
  "message": "text",
  "licenseId": 1,
  "licenseTokenId": 1,
  "token": "text"
}

Success

Delete

Roles: Administrator, LicenseManager

Utilizing the DELETE method revokes and removes a license token from a specific license. This is a necessary action when a token is no longer needed, such as in cases of license expiration or termination of user access. It is an important aspect of license management, helping to keep the licensing system streamlined and free from redundant or invalid tokens.

Deletes a specific token from a given license.

delete

Authorizations

Path parameters

licenseIdinteger · int32required

license_id is the ID of the license.

tokenIdinteger · int32required

token_id is the ID of the license token to delete.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url '/v1/licenses/{licenseId}/tokens/{tokenId}' \
  --header 'x-api-key: YOUR_API_KEY'

200

default

200

{
  "success": true,
  "code": 1,
  "message": "text"
}

Success