License System Integration

The FaxStore license system has two API endpoints to have license keys validated with the database.

Single Request Validation Endpoint

POST/api/check/PRODUCT_ID

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

Authorization

AuthorizationStringrequired

The license key issued for the product

Content-TypeStringrequired

Typically 'application/json'

Responses

200OKjson

{
  "status": "AUTHORISED",
  "pass": true,
  "details": "Authorisation completed - https://license.example.com"
}

Multiple Request Validation Endpoint

POST/api/check/multiple

Check a single license key against the system to confirm it complies with all its set conditions and that it's valid. This method allows for multiple products to be provided if any have the matching license key it authorises.

Authorization

AuthorizationStringrequired

The license key to check/authorise

Request body

proIdsArrayrequired

An array of product IDs to have checked

infoString

Additional notes to send with the request

logBoolean

Whether to log the license request or not, by default all requests are logged

Responses

200OKjson

{
    status: "AUTHORISED",
    pass: true,
    details: `Authorisation completed - https://license.example.com`,
    proId: PASSED_PRODUCT_ID
}

Request Error Codes

KEY DISABLED; The license key is forcefully disabled by staff
NOT ACTIVE; The user marked the license key as inactive, they just need to enable it
NOT AUTHORISED; The IP the request came from does not match the IP listed on the license website
NOT FOUND (Unauthorised); The product ID could not be found, it's either deleted or was not passed in the request correctly
NOT FOUND (License key); The license key provided was not found in the license system

Legacy V1 Request

Note the License System V1 API has been removed from the License system in versions 1.9.0 and above. If absolutely needed the V1 API can be loaded via an extension by downloading this file - v1api.js

Type: POST
URL: 'https://license.your.domain/api/checkitem/PRODUCT_ID'
Headers:
    User-Agent: '*'
    Accept:  'application/json, text/plain, */*'
    authorization: USERS_LICENSE_KEY