FaxStore

Prerequisites
Installation & Setup
API
Config File
Developer Mode
Developer Tools
Enable Debug Mode
Events
Extensions
Features
Integrations
License System Extension
Permissions
Updating FaxStore

Weblutions Documentation > FaxStore > License System Extension > Integration

Integration

This section covers the backend API calls for the license system along with validating the product(s) you wish to authorise.

Simply placing the license request into a program doesn't guarantee security for the product. Research ways to further secure your product via manipulation methods in your programming language.

Contents:


Single Request

POST /api/check/:PRODUCT_ID

Check a single license key against the system to confirm it complies with all its set conditions and that it's valid.

Parameters:

PRODUCT_ID[URL] the FaxStore item product ID
Authorization[Header] The license key to check/authorise
info[Body] Additional notes to send with the request
log[Body] Whether to log the license request or not, by default all requests are logged

Response: [Expand]

Multiple Request

Make an API call to the license system to see if a key matches any of an array of items.

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.

Parameters:

Authorization[Header] The license key to check/authorise
proIds[Body] An array of product IDs to have checked
info[Body] Additional notes to send with the request
log[Body] Whether to log the license request or not, by default all requests are logged

Response: [Expand]

Request Errors/Failure Codes

Below is a list of reasons why a license check out fail.

  • 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

V1 Request

Please note the V1 API has been removed from the License System in versions 1.9.0 and above. If you really need to use the V1 API, you can load this JS file as an extension.

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

Suggest an edit

Review this page

FAXES
  • 3 years ago - updated (6 months ago)

2 recommend this page