Generate license code

Generate the license code

get

The license code 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

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

This provides interfaces for API responses with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Read-onlyRequired

This is the message to be displayed to the user.

datastring · nullableRead-onlyOptional

This is the data to be returned to the client.

401

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

application/json

429

API call exceeded rate limit due to too many requests.

application/json

get

/api/v1/licenses/generate-code

HTTPcURLJavaScriptPython

GET /api/v1/licenses/generate-code?packageId=text&subscriptionTypeId=text 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": []
}