Public REST API

A public REST API for Keyforge. No API key is needed to access the endpoints. Currently, you can only validate and activate licenses. It allows you to create a licensed app without any backend or API.

POST

/api/v1/public/licenses/validate

Validate a license

See if a license is valid.

Request Body

licenseKey
Required
string

The license key.

Example: "ABCDE-ABCDE-ABCDE-ABCDE-ABCDE"

deviceIdentifier
Required
string

The identifier of the device to validate the license for.

Example: "some_device_id"

productId
Required
string

The product ID to validate the license for.

Example: "p_123456"
Status codeDescription
200Success
400Bad Request
curl
curl -X POST "https://keyforge.dev/api/v1/public/licenses/validate" \
  -d '{
  "licenseKey": "ABCDE-ABCDE-ABCDE-ABCDE-ABCDE",
  "deviceIdentifier": "some_device_id",
  "productId": "p_123456"
}'

The response to a license validation request.

Example Response
{
  "isValid": true
}

POST

/api/v1/public/licenses/activate

Activate a license

Activate a license.

Request Body

licenseKey
Required
string

The key of the license to activate.

Example: "ABCDE-ABCDE-ABCDE-ABCDE-ABCDE"

deviceIdentifier
Required
string

A unique identifier of the device.

Example: "some_device_id"

deviceName
Required
string

The name of the device.

Example: "My computer name"

productId
Required
string

The ID of the product the license will be activated.

Example: "p_123456"
Status codeDescription
200Success
400Bad Request
curl
curl -X POST "https://keyforge.dev/api/v1/public/licenses/activate" \
  -d '{
  "licenseKey": "ABCDE-ABCDE-ABCDE-ABCDE-ABCDE",
  "deviceIdentifier": "some_device_id",
  "deviceName": "My computer name",
  "productId": "p_123456"
}'

The response to a license activation request.

Example Response
{
  "isValid": true,
  "licenseKey": "ABCDE-ABCDE-ABCDE-ABCDE-ABCDE"
}

Previous

Create private session