Product Documentation

Our Discord

Weblutions Documentation / Product Documentation / Independent License System API

Independent License System API

This page contains all the API routes that are available in the Independent License System.

All route documentation is for versions 2.0.0 and up.

Table of Contents

Creating a API Token

To establish authentication to the Independent License Systems API a API token must be set in the configuration file.

Open the config.json
On line eight (by default) change the token to what is desired. Using a site RandomKeygen is recommended.
```
"apiKey": "123",
```
Save the configuration file and restart Independent License System for changes to take effect.

Unset API Token Risks

If the installation of Independent License System has no API key set it opens the system to risk and abuse. Even if not using the API it's recommended to set a secure token.

Unauthorised Responses

If an API request is made with the incorrect or an invalid authorization header the below 403 response is returned.

"Not authorized to access this resource."

Get All License Keys

GET/api/keys

Returns an array of all license keys in the database.

Authorization

Name	Type	Required	Description
authorization	String	required

Responses

200OKjson

View response body

[
  {
    "id": 3,
    "userId": "282762192544333827",
    "productId": 1,
    "status": 1,
    "lastRequest": "",
    "authIP": "1.1.1.1",
    "authKey": "4zWqp0Npqkcp3XT_42pIjrBP6kbR23kI2cahk0cSYx1EG",
    "disabled": 0,
    "iplocked": 0
  }
]

Examples

curl -X GET 'https://api.example.com/api/keys' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const response = await fetch('https://api.example.com/api/keys', {
  "method": "GET",
  "headers": {
    "Authorization": "Bearer YOUR_API_TOKEN"
  }
})
const data = await response.json()

import requests

response = requests.get('https://api.example.com/api/keys', headers={
    "Authorization": "Bearer YOUR_API_TOKEN"
})
data = response.json()

<?php
$context = stream_context_create([
  'http' => [
    'method' => 'GET',
    'header' => "Authorization: Bearer YOUR_API_TOKEN"
  ]
]);

$response = file_get_contents('https://api.example.com/api/keys', false, $context);
$data = json_decode($response, true);

Get Single License Key

GET/api/keys/:id

Returns an object with the requested key information.

Authorization

Name	Type	Required	Description
authorization	String	required

Path parameters

Name	Type	Required	Description
id	Integer	required	The ID of the key as presented in the database and website.

Responses

200OKjson

View response body

{
  "id": 3,
  "userId": "282762192544333827",
  "productId": 1,
  "status": 1,
  "lastRequest": "",
  "authIP": "1.1.1.1",
  "authKey": "4zWqp0Npqkcp3XT_42pIjrBP6kbR23kI2cahk0cSYx1EG",
  "disabled": 0,
  "iplocked": 0
}

404Not Foundplaintext

View response body

License key not found.

Examples

curl -X GET 'https://api.example.com/api/keys/123' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const response = await fetch('https://api.example.com/api/keys/123', {
  "method": "GET",
  "headers": {
    "Authorization": "Bearer YOUR_API_TOKEN"
  }
})
const data = await response.json()

import requests

response = requests.get('https://api.example.com/api/keys/123', headers={
    "Authorization": "Bearer YOUR_API_TOKEN"
})
data = response.json()

<?php
$context = stream_context_create([
  'http' => [
    'method' => 'GET',
    'header' => "Authorization: Bearer YOUR_API_TOKEN"
  ]
]);

$response = file_get_contents('https://api.example.com/api/keys/123', false, $context);
$data = json_decode($response, true);

Get Single License Key Logs

GET/api/keys/:id/logs

Returns the 100 most recent license logs in an array.

Authorization

Name	Type	Required	Description
authorization	String	required

Path parameters

Name	Type	Required	Description
id	Integer	required	The ID of the key as presented in the database and website.

Responses

200OKjson

View response body

[
  {
    "id": 147,
    "keyId": 3,
    "timeAt": "1788648761000",
    "authIP": "192.168.1.10",
    "details": "",
    "status": "AUTHORISED"
  }
]

404Not Foundplaintext

View response body

License key not found or there is no logs to show.

Examples

curl -X GET 'https://api.example.com/api/keys/123/logs' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const response = await fetch('https://api.example.com/api/keys/123/logs', {
  "method": "GET",
  "headers": {
    "Authorization": "Bearer YOUR_API_TOKEN"
  }
})
const data = await response.json()

import requests

response = requests.get('https://api.example.com/api/keys/123/logs', headers={
    "Authorization": "Bearer YOUR_API_TOKEN"
})
data = response.json()

<?php
$context = stream_context_create([
  'http' => [
    'method' => 'GET',
    'header' => "Authorization: Bearer YOUR_API_TOKEN"
  ]
]);

$response = file_get_contents('https://api.example.com/api/keys/123/logs', false, $context);
$data = json_decode($response, true);

Check License Key Authorisation

POST/api/check/:productID

The API returns a JSON response indicating whether the license is valid.

Authorization

Name	Type	Required	Description
authorization	String	required	The license key to compare to the product and key details.

Path parameters

Name	Type	Required	Description
productID	Integer	required	The product ID to check.

Query parameters

Name	Type	Required	Description
info	String	optional	Additional information to include in the license log.
log	Boolean	optional	Defaults to true. Whether to log the request into the license logs database table.

Responses

200OKjson

View response body

{
    "status": "AUTHORISED",
    "pass": true,
    "details": "Status message"
}

Examples

curl -X POST 'https://api.example.com/api/check/123?info=example_info&log=true' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const response = await fetch('https://api.example.com/api/check/123?info=example_info&log=true', {
  "method": "POST",
  "headers": {
    "Authorization": "Bearer YOUR_API_TOKEN"
  }
})
const data = await response.json()

import requests

response = requests.post('https://api.example.com/api/check/123?info=example_info&log=true', headers={
    "Authorization": "Bearer YOUR_API_TOKEN"
})
data = response.json()

<?php
$context = stream_context_create([
  'http' => [
    'method' => 'POST',
    'header' => "Authorization: Bearer YOUR_API_TOKEN"
  ]
]);

$response = file_get_contents('https://api.example.com/api/check/123?info=example_info&log=true', false, $context);
$data = json_decode($response, true);

List of response statuses:

AUTHORISED - Authorisation completed
KEY DISABLED - This license key has been disabled by an administrator
NOT ACTIVE - The supplied key is not active
NOT AUTHORISED - The supplied IP is not authorised
NOT FOUND - No key was provided
NOT FOUND - The supplied license key was not found. Please check your auth key is correct

Create License Key

POST/api/keys

Creates a license key with the desired information.

Authorization

Name	Type	Required	Description
authorization	String	required

Request body

Name	Type	Required	Description
uid	String	required	The user ID to attach the license key to.
pid	Integer	required	The product ID to register the license key for.
status	Boolean	optional	The active state of the license key.
ip	String	optional	The authorised IP address for the license key to pass authentication.
disabled	Boolean	optional	Determines if the license key is force disabled. Defaults to false.

Responses

200OKjson

View response body

{
  "id": 4,
  "userId": "282762192544333827",
  "productId": 1,
  "status": 1,
  "lastRequest": null,
  "authIP": "",
  "authKey": "WrPF2MCWFLlyIteUYjr6drjM9hSGtXVpboaNx9xBH_6vI",
  "disabled": 0,
  "iplocked": 1
}

201OKplaintext

View response body

Data created but could not be read back immediately. Please fetch manually.

400Bad Requestplaintext

View response body

Missing body content. uid and pid are required.

Examples

curl -X POST 'https://api.example.com/api/keys' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "uid": "123",
  "pid": 123,
  "status": true,
  "ip": "example_ip",
  "disabled": true
}'

const response = await fetch('https://api.example.com/api/keys', {
  "method": "POST",
  "headers": {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
  },
  "body": JSON.stringify({
  "uid": "123",
  "pid": 123,
  "status": true,
  "ip": "example_ip",
  "disabled": true
})
})
const data = await response.json()

import requests

response = requests.post('https://api.example.com/api/keys', headers={
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}, json={
    "uid": "123",
    "pid": 123,
    "status": True,
    "ip": "example_ip",
    "disabled": True
})
data = response.json()

<?php
$context = stream_context_create([
  'http' => [
    'method' => 'POST',
    'header' => "Authorization: Bearer YOUR_API_TOKEN\\r\\nContent-Type: application/json",
    'content' => json_encode([
        "uid" => "123",
        "pid" => 123,
        "status" => true,
        "ip" => "example_ip",
        "disabled" => true
    ])
  ]
]);

$response = file_get_contents('https://api.example.com/api/keys', false, $context);
$data = json_decode($response, true);

Update License Key

PUT/api/keys/:id

Updates an existing license key details. Content defaults to existing data if not provided in the body. Returns updated key object.

Authorization

Name	Type	Required	Description
authorization	String	required

Path parameters

Name	Type	Required	Description
id	Integer	required	The ID of the key as presented in the database and website.

Request body

Name	Type	Required	Description
disabled	Boolean	optional	Determines if the license key is force disabled. Defaults to false.
ip	String	optional	The authorised IP address for the license key to pass authentication.
iplocked	Boolean	optional	Determines if the license key is locked only to the authorised IP address.

Responses

200OKjson

View response body

{
  "id": 3,
  "userId": "282762192544333827",
  "productId": 1,
  "status": 1,
  "lastRequest": "",
  "authIP": "1.1.1.1",
  "authKey": "4zWqp0Npqkcp3XT_42pIjrBP6kbR23kI2cahk0cSYx1EG",
  "disabled": 0,
  "iplocked": 0
}

404Not Foundplaintext

View response body

License key not found.

Examples

curl -X PUT 'https://api.example.com/api/keys/123' \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
  "disabled": true,
  "ip": "example_ip",
  "iplocked": true
}'

const response = await fetch('https://api.example.com/api/keys/123', {
  "method": "PUT",
  "headers": {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
  },
  "body": JSON.stringify({
  "disabled": true,
  "ip": "example_ip",
  "iplocked": true
})
})
const data = await response.json()

import requests

response = requests.put('https://api.example.com/api/keys/123', headers={
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Content-Type": "application/json"
}, json={
    "disabled": True,
    "ip": "example_ip",
    "iplocked": True
})
data = response.json()

<?php
$context = stream_context_create([
  'http' => [
    'method' => 'PUT',
    'header' => "Authorization: Bearer YOUR_API_TOKEN\\r\\nContent-Type: application/json",
    'content' => json_encode([
        "disabled" => true,
        "ip" => "example_ip",
        "iplocked" => true
    ])
  ]
]);

$response = file_get_contents('https://api.example.com/api/keys/123', false, $context);
$data = json_decode($response, true);

Delete License Key

DELETE/api/keys/:id

Deletes the desired license key and its logs. Returns the last license object before deletion.

Authorization

Name	Type	Required	Description
authorization	String	required

Path parameters

Name	Type	Required	Description
id	Integer	optional	The ID of the key as presented in the database and website.

Responses

200OKjson

View response body

{
  "id": 3,
  "userId": "282762192544333827",
  "productId": 1,
  "status": 1,
  "lastRequest": "",
  "authIP": "1.1.1.1",
  "authKey": "4zWqp0Npqkcp3XT_42pIjrBP6kbR23kI2cahk0cSYx1EG",
  "disabled": 0,
  "iplocked": 0
}

404Not Foundplaintext

View response body

License key not found.

Examples

curl -X DELETE 'https://api.example.com/api/keys/123' \
  -H 'Authorization: Bearer YOUR_API_TOKEN'

const response = await fetch('https://api.example.com/api/keys/123', {
  "method": "DELETE",
  "headers": {
    "Authorization": "Bearer YOUR_API_TOKEN"
  }
})
const data = await response.json()

import requests

response = requests.delete('https://api.example.com/api/keys/123', headers={
    "Authorization": "Bearer YOUR_API_TOKEN"
})
data = response.json()

<?php
$context = stream_context_create([
  'http' => [
    'method' => 'DELETE',
    'header' => "Authorization: Bearer YOUR_API_TOKEN"
  ]
]);

$response = file_get_contents('https://api.example.com/api/keys/123', false, $context);
$data = json_decode($response, true);