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

Authorizations

Query parameters

selectstringOptional

filterstringOptional

sortstringOptional

takeinteger · int32Optional

skipinteger · int32Optional

Responses

application/json

objectOptional

GetProductsResponse is the response message for the GetProductsRequest.

application/json

get

HTTPcURLJavaScriptPython

GET /v1/products HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "code": 1,
  "message": "text",
  "products": [
    {
      "id": 1,
      "code": "text",
      "name": "text",
      "description": "text",
      "url": "text",
      "copyright": "text",
      "createdAt": "text",
      "image": "text",
      "price": 1,
      "resellerPrice": 1,
      "currency": "text",
      "signatureKeysId": 1
    }
  ],
  "totalProductsCount": 1
}

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

Authorizations

Body

InsertProductRequest is used to insert a new product.

productobjectOptional

Product represents a product in the system.

Responses

application/json

objectOptional

InsertProductResponse is the response message for the InsertProductRequest.

application/json

post

HTTPcURLJavaScriptPython

POST /v1/products HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 201

{
  "product": {
    "id": 1,
    "code": "text",
    "name": "text",
    "description": "text",
    "url": "text",
    "copyright": "text",
    "createdAt": "text",
    "image": "text",
    "price": 1,
    "resellerPrice": 1,
    "currency": "text",
    "signatureKeysId": 1
  }
}

{
  "productId": 1,
  "success": true,
  "code": 1,
  "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

Authorizations

Body

UpdateProductRequest is used to update an existing product.

productobjectOptional

Product represents a product in the system.

Responses

application/json

objectOptional

UpdateProductResponse is the response message for the UpdateProductRequest.

application/json

put

HTTPcURLJavaScriptPython

PUT /v1/products HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 201

{
  "product": {
    "id": 1,
    "code": "text",
    "name": "text",
    "description": "text",
    "url": "text",
    "copyright": "text",
    "createdAt": "text",
    "image": "text",
    "price": 1,
    "resellerPrice": 1,
    "currency": "text",
    "signatureKeysId": 1
  }
}

{
  "success": true,
  "code": 1,
  "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

Authorizations

Path parameters

productIdinteger · int32Required

product_id is the ID of the product to delete.

Responses

application/json

objectOptional

DeleteProductResponse is the response message for the DeleteProductRequest.

application/json

delete

HTTPcURLJavaScriptPython

DELETE /v1/products/{productId} HTTP/1.1
Host: 
x-api-key: YOUR_API_KEY
Accept: */*

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