Authorize API requests using a license key

In the case of a key-based license that has a license key, the license key can be used in most requests to the 10Duke Scale License Checkout API, for example, to handle the checkout flow for the license in both enforced and metered consumption mode, or to retrieve information on the license.

In these requests, the license key also provides the authorization for accessing the API. No authorization tokens are needed: the license key is the shared secret between you (the vendor) and the end user or device accessing your product, and is sufficient authorization in itself.

The scope of the authorization is limited to the license that the license key can access. No separate permissions are used.

Provide license key in API request

An example request with a license key 66422efb-7d6b-43ed-81c1-2b1660b5ca6a given as a path parameter:

curl -H "Content-Type: application/json" /
     -X POST --data '[{"productName":"string","qty":1,"qtyDimension":"SEATS"}]' /
      https://<API_BASE_URL>/licensing/actions/checkout/66422efb-7d6b-43ed-81c1-2b1660b5ca6a

Delete license keys

When a license key in the possession of an end user is deleted, the key becomes invalid. License keys are unique secrets and cannot be reused or assigned to another user or license once deleted.

Once the key is deleted, any subsequent API requests using it, such as checkout, heartbeat, or release, will fail and return an error.

When revoking access, follow these best practices:

  • If a customer is ending their subscription permanently, we recommend deleting both the license key and its associated license.

  • If a customer is temporarily pausing their subscription, do not delete the key or license. Instead, set the license’s end date (the last valid date) to the current time, allowing you to reactivate the license later if needed.

See more

On this page