License Get

Validate a License Key, revert to a previous License Key, or attain a new one.

Please note that if your app stores additional in-app data which is not directly associated with License Keys, we recommend that you disable "Device Recovery" and reset all locally-stored data if a new License Key is issued. Otherwise, License Keys will not correctly relate to in-app activity.

Example Usage


http://api.cloudapplicenser.com/v1/license_get?token={TOKEN}&appuniqueid={UNIQUEID}&licensekey={LICENSEKEY}&deviceid={DEVICEID}&version={VERSION}

Usage Notes

When your app initiates (opens),it should query our API to check it's License Key. If no License Key exists, either the last License Key to be used on that device will be returned (if "Device Recovery" is enabled for this app),or a new one will be issued (if the app is freshly installed or "Device Recovery" is disabled for this app). In all cases, the JSON data returned will include a License Key and the number of in-app credits applicable to that license. You can then associate any additional in-app data that is stored locally or in a separate remote system with this License Key. If you optionally include your app's locally stored Version ID in your API call, the JSON data returned will include whether or not a more recent version is available ("true" or "false") and any comments associated with the newer version, if applicable. Note that any special characters (such as '"' and '\') in the "about" field will be escaped with a backslash, as in the example below.

Example Output


{
    "status": "success",
    "licensekey": "78328235235",
    "credits": "3",
    "newversion": "true",
    "about": "Fixes a bug in the \"Magic Carpet\" level."
}

Parameters
token
(int) (Required)
Your app's Security Token.
appuniqueid
(int) (Required)
Your app's Unique ID.
licensekey
(int) (Required)
The locally stored License Key (can be empty).
deviceid
(string) (Required)
Universally Unique Identifier or "UUID" of the device being used. Can be empty if the licensekey parameter is supplied.
version
(string) (Optional)
Your app's locally stored Version ID.

Examples

Validate the locally stored License Key:


http://api.cloudapplicenser.com/v1/license_get?token=54321&appuniqueid=12345&licensekey=99999&deviceid=2fa572bc96cd99g

There is no locally stored License Key, so a new one is required:


http://api.cloudapplicenser.com/v1/license_get?token=54321&appuniqueid=12345&licensekey=&deviceid=2fa572bc96cd99g

Validate the locally stored License Key and check for new versions:


http://api.cloudapplicenser.com/v1/license_get?token=54321&appuniqueid=12345&licensekey=99999&deviceid=2fa572bc96cd99g&version=1.1.2

Error Codes
403 Status: 001 - The App's Unique ID or Security Token is missing.
403 Status: 002 - The App's Unique ID or Security Token supplied is invalid, or the App is suspended.
400 Status: 003 - The License Key is missing.
400 Status: 005 - The License Key supplied is invalid or does not apply to the App's Unique ID.
400 Status: 007 - The License Key supplied is suspended.
400 Status: 023 - The Device ID was missing or invalid.
400 Status: 024 - This app is currently closed to new licences.
400 Status: 025 - The License Quota for this app's parent account has been exhausted.
400 Status: 029 - The Version ID supplied is invalid or does not apply to the App's Unique ID.
Changelog
- 1.0: Introduced.

Want news and insights from SiteCenter?

Send me your newsletter about industry trends plus news of SiteCenter products and services.

You can unsubscribe at any time, and we promise to never share your email address - read our Privacy Policy.