Resources

Assets Management

The 'Resources' section of the Babel Licensing API is a versatile and crucial component dedicated to the management of various assets, termed as Resources, within the Babel Licensing Database. This section is designed to handle a wide range of assets, making it a central point for managing diverse elements essential to the licensing process.

1. Asset Management: The primary function of the Resources section is to manage different types of assets that are integral to the Babel Licensing system. These can range from digital keys used for the digital signing of licenses to HTML templates for emails and other processes.

2. Digital Key Storage and Management: This includes storing, updating, and managing digital keys, which are critical for ensuring the security and integrity of the licensing process. These keys are used to digitally sign licenses, adding an extra layer of security and authenticity.

3. HTML Email Templates: The section also manages HTML templates for emails, which are used in various processes like license issuance notifications, renewal reminders, or other communications. These templates can be customized and managed to ensure consistent and professional communication with users.

4. Flexibility and Customization: The Resources section is designed to be highly flexible, accommodating a wide variety of assets. This flexibility allows the Babel Licensing system to adapt to different operational needs and store assets that are crucial for specific functions or processes.

Get

Roles: Administrator, LicenseManager, Sales

The GET method in the Resources section is used to access detailed information about various assets stored within the Babel Licensing Database. This method enables users to view and retrieve data on resources, such as digital keys for license signing or HTML email templates.

Retrieves a list of resources.

GET/v1/resources

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.

resourcesarray of Resource (object)

resources is the list of resources.

totalResourcesCountinteger (int32)

total_resources_count is the total number of resources.

Request

JavaScriptCurl

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

Response

{
  "success": false,
  "message": "text",
  "resources": [
    {
      "name": "text",
      "type": "text",
      "code": "text",
      "description": "text",
      "source": "text",
      "password": "text",
      "createdAt": "text",
      "updatedAt": "text",
      "data": "text",
      "dataFormat": "text"
    }
  ]
}

Post

Roles: Administrator, LicenseManager, Sales

The POST method facilitates the addition of new resources to the Babel Licensing Database. It is used to upload and store new assets, be they digital keys, email templates, or other types of resources necessary for the licensing operations.

Inserts a new resource.

POST/v1/resources

Body

application/json

resourceResource (object)

Resource represents a resource in the system.

Response

200default

Success

Body

application/json

resourceIdinteger (int32)

resource_id is the ID of the inserted resource.

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/resources', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

Put

Roles: Administrator, LicenseManager, Sales

Employing the PUT method allows for modifications to existing resources in the database. This could involve updating the content of HTML email templates, renewing digital keys, or altering other asset attributes.

Updates an existing resource.

PUT/v1/resources

Body

application/json

resourceResource (object)

Resource represents a resource in the system.

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/resources', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

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

Delete

Roles: Administrator, LicenseManager, Sales

The DELETE method is used to delete existing resources from the Babel Licensing Database. This action may be necessary when a resource is outdated, replaced, or no longer needed.

Deletes a resource by ID.

DELETE/v1/resources/{resourceId}

Path parameters

resourceId*integer (int32)

resource_id is the ID of the resource 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/resources/{resourceId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

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