Licenses

Controlling Access and Features: Understanding Licenses

In the Babel Licensing Service API, 'Licenses' form the cornerstone of the system, representing the critical information that clients consume to authorize access to application features. These licenses are the key elements that define the terms of use, restrictions, and access levels for various components and functionalities within applications.

The concept of a license in Babel Licensing is multifaceted. Each license encapsulates specific details such as the duration of validity, the scope of features it covers, and any particular usage rights or limitations. This allows for a granular level of control over how different aspects of an application are accessed and utilized by end-users.

Get

Roles: Administrator, LicenseManager, Sales

This method is used to fetch details of existing licenses. It allows for querying license data, including their terms, scope, and validity. This is essential for monitoring and managing the licenses currently in use, ensuring they align with compliance and business requirements.

Retrieves a list of licenses.

get

Authorizations

Query parameters

selectstringoptional

filterstringoptional

sortstringoptional

takeinteger · int32optional

skipinteger · int32optional

includestringoptional

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url '/v1/licenses' \
  --header 'x-api-key: YOUR_API_KEY'

200

default

200

{
  "success": true,
  "code": 1,
  "message": "text",
  "licenses": [
    {
      "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"
          }
        }
      ]
    }
  ],
  "totalLicensesCount": 1
}

Success

C#

using System.Net.Http;
using Babel.Licensing.Service.Management;

using var httpClient = CreateHttpClient();

var get = new GetLicensesRequest();
var httpMessage = MakeApiRequest(get, HttpMethod.Get, $"/v1/licenses");

var result = await httpClient.SendAsync(httpMessage);
var getResponse = await ParseResponseAsync<GetLicensesResponse>(result);

VB.NET

Imports System.Net.Http
Imports Babel.Licensing.Service.Management

Using httpClient = CreateHttpClient()
    Dim get As New GetLicensesRequest()
    Dim httpMessage As var = MakeApiRequest(get, HttpMethod.Get, "/v1/licenses")

    Dim result As var = Await httpClient.SendAsync(httpMessage)
    Dim getResponse As var = Await ParseResponseAsync(Of GetLicensesResponse)(result)
End Using

Shell

curl -X 'GET' \
  'https://localhost:5455/v1/licenses' \
  -H 'accept: application/json' \
  -H 'x-api-key: ApiKey'

Post

Roles: Administrator, LicenseManager, Sales

The POST method facilitates the creation of new licenses. It's used to define and add new license to the system, specifying parameters such as duration, licensing mode, features and restrictions. This method is crucial for expanding the licensing capabilities to new users or applications.

Inserts a new license.

post

Authorizations

Body

licenseobjectoptional

License represents a software license.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url '/v1/licenses' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
          }
        }
      ]
    }
  }'

application/json

200

default

200

{
  "licenseId": 1,
  "success": true,
  "code": 1,
  "message": "text",
  "licenseKeyId": "text",
  "userKey": "text",
  "licenseKey": "text"
}

Success

Put

Roles: Administrator, LicenseManager, Sales

Utilizing the PUT method allows for modifications to existing licenses. It's employed to update license terms, extend validity, or alter the scope of access. This method is vital for maintaining the relevance and accuracy of licenses as user needs and application features evolve.

Updates an existing license.

put

Authorizations

Body

licenseobjectoptional

License represents a software license.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url '/v1/licenses' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "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"
          }
        }
      ]
    }
  }'

application/json

200

default

200

{
  "success": true,
  "code": 1,
  "message": "text",
  "licenseKeyId": "text",
  "userKey": "text",
  "licenseKey": "text"
}

Success

Delete

Roles: Administrator, LicenseManager

The DELETE method is used for removing existing licenses from the system. This action is typically performed when a license is no longer needed or if it's being replaced by an updated license. It's a critical step in managing the lifecycle of licenses and ensuring that outdated or invalid licenses are not in circulation.

Deletes a license by ID.

delete

Authorizations

Path parameters

licenseIdinteger · int32required

license_id is the ID of the license to delete.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

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

200

default

200

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

Success