Generate License Key

Learn how to use the API endpoint "/api/v1/orders/generate_license/" to generate license keys for your products. This document explains the available query/body parameters such as product and quantity and includes example responses.

API Summary

• Name: Generates License keys if requesting manager has access permissions to it.

• Method: GET

• URL: /api/v1/orders/generate_license/

• Try it out: No

Although this endpoint uses GET in the API spec, the parameters below are documented under "bodyDataParameters" in the original specification—treat them as query parameters when calling the endpoint (e.g., ?product=wbhk&quantity=1).

Parameters

• product (required, string) Short code of a product. Example: product=wbhk

• quantity (optional, integer) Number of keys to generate. Example: quantity=1

• key_length (optional, integer) Number of characters in each key. Must be between 16 and 240. Default: 16

• alphabet (optional, string) Possible characters for each key. Default: 23456789ABCDEFGHJKLMNPQRSTUVWXYZ

Example Responses

200 OK

[
    "G8HA-SRRZ-A6WK-TJWB"
]

404 Not Found

{
  "message": "Ain't no cake like that."
}

Notes

• Ensure the requesting manager/account has the necessary permissions to generate license keys for the requested product.

• Keep permitted values for key_length within the allowed range (16–240) and use the alphabet parameter only if you need a custom character set for generated keys.