Generate license key

Generate the license key

get

The license key is not stored in the system. It is generated by the system.

Query parameters

packageIdstringRequired

The packageId of the license.

subscriptionTypeIdstringRequired

The subscriptionTypeId of the license.

startDatestring · date-timeOptional

The startDate of the license.

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

429

The user has exceeded the rate limit.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/licenses/generate-key HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": "JFWLICENSEKEY",
  "errors": []
}