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/v1/licenses

Query parameters

Response

200default

Success

Body

application/json

successboolean

success indicates whether the operation was successful.

codeinteger (int32)

code is the status code of the operation.

messagestring

message is a human-readable message indicating the result of the operation.

licensesarray of License (object)

licenses is the list of licenses.

totalLicensesCountinteger (int32)

total_licenses_count is the total number of licenses.

Request

JavaScriptCurl

const response = await fetch('/v1/licenses', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text",
  "licenses": [
    {
      "licenseId": "text",
      "licenseType": "text",
      "format": "Xml",
      "description": "text",
      "issueDate": "text",
      "expireDate": "text",
      "supportExpireDate": "text",
      "revoked": false,
      "licenseKey": "text",
      "userKey": "text",
      "licensingMode": "File",
      "hash": "text",
      "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": [
        {
          "name": "text",
          "version": "text",
          "culture": "text",
          "publicKeyToken": "text",
          "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"
        }
      ]
    }
  ]
}

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/v1/licenses

Body

application/json

licenseLicense (object)

License represents a software license.

Response

200default

Success

Body

application/json

licenseIdinteger (int32)

license_id is the ID of the inserted license.

successboolean

success indicates whether the operation was successful.

codeinteger (int32)

code is the status code of the operation.

messagestring

message is a human-readable message indicating the result of the operation.

licenseKeyIdstring

license_key_id is the ID of the license key.

userKeystring

user_key is the key of the user.

licenseKeystring

license_key is the key of the license.

Request

JavaScriptCurl

const response = await fetch('/v1/licenses', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text",
  "licenseKeyId": "text",
  "userKey": "text",
  "licenseKey": "text"
}

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/v1/licenses

Body

application/json

licenseLicense (object)

License represents a software license.

Response

200default

Success

Body

application/json

successboolean

success indicates whether the operation was successful.

codeinteger (int32)

code is the status code of the operation.

messagestring

message is a human-readable message indicating the result of the operation.

licenseKeyIdstring

license_key_id is the ID of the license key.

userKeystring

user_key is the key of the user.

licenseKeystring

license_key is the key of the license.

Request

JavaScriptCurl

const response = await fetch('/v1/licenses', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text",
  "licenseKeyId": "text",
  "userKey": "text",
  "licenseKey": "text"
}

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/v1/licenses/{licenseId}

Path parameters

licenseId*integer (int32)

license_id is the ID of the license to delete.

Response

200default

Success

Body

application/json

successboolean

success indicates whether the operation was successful.

codeinteger (int32)

code is the status code of the operation.

messagestring

message is a human-readable message indicating the result of the operation.

Request

JavaScriptCurl

const response = await fetch('/v1/licenses/{licenseId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "success": false,
  "message": "text"
}