Products

Core of Licensing and Release Management

The 'Products' section of the Babel Licensing API is a component dedicated to managing Products and their associated Releases. In the framework of Babel Licensing, Products represent the heart of the licensing system, as they encompass the licensed applications or a collective group of licensed applications. This section is essential for controlling and overseeing the lifecycle of these Products and their various iterations or versions.

Get

Roles: Administrator, Sales

The GET method in the Products section is used for querying and obtaining detailed information about various Products within the Babel Licensing system. It enables users to view comprehensive data on each Product, including its description, current Releases, and associated licensing terms.

Retrieves a list of products.

GET/v1/products

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.

productsarray of Product (object)

products is the list of products.

totalProductsCountinteger (int32)

total_products_count is the total number of products.

Request

JavaScriptCurl

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

Response

{
  "success": false,
  "message": "text",
  "products": [
    {
      "code": "text",
      "name": "text",
      "description": "text",
      "url": "text",
      "copyright": "text",
      "createdAt": "text",
      "image": "text",
      "price": 0,
      "resellerPrice": 0,
      "currency": "text"
    }
  ]
}

Post

Roles: Administrator, Sales

The POST method facilitates the introduction of new Products into the Babel Licensing system. It is used to define and add new Products, specifying essential details such as the product name, description, and initial licensing parameters such as the encryption keys used to digitally sign the licenses.

Inserts a new product.

POST/v1/products

Body

application/json

productProduct (object)

Product represents a product in the system.

Response

200default

Success

Body

application/json

productIdinteger (int32)

product_id is the ID of the inserted product.

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

Response

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

Put

Roles: Administrator, Sales

Utilizing the PUT method allows for modifications to the details of existing Products. This could involve updating product descriptions.

Updates an existing product.

PUT/v1/products

Body

application/json

productProduct (object)

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

Response

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

Delete

Roles: Administrator, Sales

The DELETE method is used to remove Product records from the Babel Licensing system.

Deletes a product by ID.

DELETE/v1/products/{productId}

Path parameters

productId*integer (int32)

product_id is the ID of the product 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/products/{productId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

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