Developer Zone

License Management

Revulytics Usage Intelligence allows you to maintain your own license key registry on the Revulytics Usage Intelligence server in order to track license key usage and verify the status/validity of license keys used on your clients.

There are multiple ways that the key registry is populated with license keys.

  1. Keys are collected automatically from your clients whenever you call the ruiSetLicenseKey() function.
  2. You can add/edit keys manually via the Revulytics Usage Intelligence dashboard.
  3. You can add/edit keys directly from your CRM by using the Revulytics Usage Intelligence Web API.

Client vs. Server Managed Licensing

Revulytics Usage Intelligence gives you the option to choose between managing your license key status (i.e. Blacklisted, Whitelisted, Expired or Activated) and key type on the server (server managed) or managing this status through the application (client managed). Applications can individually set whether each license status or license type is either Sever Managed or Client Managed by visiting the License Key Management Settings page on the Revulytics Usage Intelligence dashboard. The major difference is outlined below:

1- Client managed: The server licensing mechanism works in reporting-only mode and your application is expected to notify the server that the license status has changed through the use of ruiSetLicenseData().

When to use: You have implemented your own licensing module/mechanism within your application that can identify whether the license key used by this client is blacklisted, whitelisted, expired or activated. In this case you do not need to query the Revulytics Usage Intelligence server to get this license status. However you can simply use this function to passively inform Revulytics Usage Intelligence about the license status used by the client. In this case:

  1. Revulytics Usage Intelligence will use this info to filter and report the different key types and statuses and their activity.
  2. Revulytics Usage Intelligence licensing server will operate in passive mode (i.e. reporting only).
  3. Calling ruiCheckLicenseKey() will return the license type and flags as Unknown (-1).

2- Server managed: You manage the key status on the server side and your application queries the server to determine the status of a particular license key by calling ruiCheckLicenseKey() or ruiSetLicenseKey().

When to use: If you do not have your own licensing module/mechanism within your application and thus you have no way to identify the license status at the client side. In this mode, whenever a client changes their license key your application can call ruiSetLicenseKey() to register the new license key. In reply to this API call, the server will check if the license key exists on the key register and in the reply it will specify to your application whether this key is flagged as blacklisted, whitelisted, expired or activated, along with the type of key submitted. If you want to verify a key without actually registering a key change for this client you can use ruiCheckLicenseKey() which returns the same values but does not register this key with the server. In this case:

  1. The key register is maintained manually on the server by the software owner
  2. Revulytics Usage Intelligence licensing server will operate in active mode so apart from using this key info for filtering and reporting, it will also report back the key status (validity) to the SDK whenever requested through the API.
  3. Calling ruiCheckLicenseKey() or ruiSetLicenseKey() will return the 4 status flags denoting whether a registered key is: Blacklisted, Whitelisted, Expired and Activated and the key type.
  4. If the key does not exist on the server, all 4 status flags will be returned as false (0).

RUIRESULT ruiCheckLicenseKey(RUIINSTANCE* ruiInstance, const char* licenseKey, int32_t** licenseArray)

Checks the RUI Server for the license data for the supplied licenseKey. Whereas ruiCheckLicenseKey() is a passive check, ruiSetLicenseKey() changes the license key. The license array has size, indexes and values as specified in RUISDKDefines.h.

NOTE: The order of the license array data has changed from the RUI (Trackerbird) SDK V4.

ruiCheckLicenseKey() can be called between ruiStartSDK() and ruiStopSDK(), and can be called zero or more times.

ruiCheckLicenseKey() is a synchronous function returning when all functionality is completed.

The function accepts a const char* parameter that is the license key itself and an int32_t pointer to an array of length 5 that it fills with the returned result. You may use the following constants to refer to the required value by its index:

* RUI_LICENSE_ARRAY_INDEX_KEY_TYPE        (0)
* RUI_LICENSE_ARRAY_INDEX_KEY_EXPIRED     (1)
* RUI_LICENSE_ARRAY_INDEX_KEY_ACTIVE      (2)
* RUI_LICENSE_ARRAY_INDEX_KEY_BLACKLISTED (3)
* RUI_LICENSE_ARRAY_INDEX_KEY_WHITELISTED (4)

Each of the values 1 through 4 will be set to either 0 or 1 that refers to false or true respectively. The first value (RUI_LICENSE_ARRAY_INDEX_KEY_TYPE) will be set to a number between 0 and 7 (inclusive) that refers to the 8 possible license types listed below. The values may also be -1 that means “Unknown”.

The following are the possible license types:

* RUI_KEY_TYPE_UNCHANGED  (-1) - Key Type is Unchanged (when in parameter) or Unknown (when out parameter)
* RUI_KEY_TYPE_EVALUATION (0)
* RUI_KEY_TYPE_PURCHASED  (1)
* RUI_KEY_TYPE_FREEWARE   (2)
* RUI_KEY_TYPE_UNKNOWN    (3)
* RUI_KEY_TYPE_NFR        (4) - Key Type is Not For Resale
* RUI_KEY_TYPE_CUSTOM1    (5)
* RUI_KEY_TYPE_CUSTOM2    (6)
* RUI_KEY_TYPE_CUSTOM3    (7)

The following are the possible key status values:

* RUI_KEY_STATUS_UNCHANGED (-1) - Key Status is Unchanged (when in parameter) or Unknown (when out parameter).
* RUI_KEY_STATUS_NO        (0)  - Key Status is No.
* RUI_KEY_STATUS_YES       (1)  - Key Status is Yes.

Parameters:

ruiInstance (RUIINSTANCE*) - Pointer to the RUI instance created via ruiCreateInstance()

licenseKey (const char*) - The license key to be checked. This value cannot be empty.

licenseArray (int32_t**) - The array that will be filled to contain the license status flags.

Returns:One of the return status constants below.
* RUI_OK - Function successful.
* RUI_INVALID_SDK_OBJECT - SDK Instance parameter is NULL or invalid.
* RUI_SDK_INTERNAL_ERROR_FATAL - Irrecoverable internal fatal error.  No further API calls should be made.
* RUI_SDK_ABORTED - A required New Registration has failed, and hence the SDK is aborted.  ruiStopSDK and ruiDestroyInstance are possible.
* RUI_SDK_SUSPENDED - The RUI Server has instructed a temporary back-off.
* RUI_SDK_PERMANENTLY_DISABLED - The RUI Server has instructed a permanent disable.
* RUI_SDK_OPTED_OUT - Instance has been instructed by the application to opt-out.
* RUI_CONFIG_NOT_CREATED - Configuration has not been successfully created.
* RUI_SDK_ALREADY_STOPPED - SDK has already been successfully stopped.
* RUI_INVALID_PARAMETER_EXPECTED_NON_EMPTY - Some API parameter is expected to be non-empty, and is not.
* RUI_TIME_THRESHOLD_NOT_REACHED - The API call frequency threshold (set by the RUI Server) has not been reached.
* RUI_NETWORK_CONNECTION_ERROR - Not able to reach the RUI Server.
* RUI_NETWORK_SERVER_ERROR - Error while communicating with the RUI Server.
* RUI_NETWORK_RESPONSE_INVALID - Message format error while communicating with the RUI Server.

Code Example:

//Test a license key
bool useDefaultReachOutHandler = true;
RUIINSTANCE* mySDK = ruiCreateInstance(useDefaultReachOutHandler); //...; //Creation and initialization shown in other snippets.
char* myProductKey = "xyz";
int32_t* licenseResult = NULL;

RUIRESULT rc = ruiCheckLicenseKey(mySDK, myProductKey, &licenseResult);
if(rc == RUI_OK)
{
    if (licenseResult[RUI_LICENSE_ARRAY_INDEX_KEY_TYPE] == RUI_KEY_TYPE_UNCHANGED) {
        cout << "License key information is unknown\n" << endl;
    } else {
        cout << "License key type is " << licenseResult[RUI_LICENSE_ARRAY_INDEX_KEY_TYPE] << endl;
    }
    //Check if the license key is activated
    if (licenseResult[RUI_LICENSE_ARRAY_INDEX_KEY_ACTIVE] == RUI_KEY_STATUS_YES){
        cout << "License Active" << endl;
    } else if (licenseResult[RUI_LICENSE_ARRAY_INDEX_KEY_ACTIVE] == RUI_KEY_STATUS_NO) {
        cout << "License Inactive" << endl;
    } else {
        cout << "License key information is unknown" << endl;
    }

    //check if license key is blacklisted
    if (licenseResult[RUI_LICENSE_ARRAY_INDEX_KEY_BLACKLISTED] == RUI_KEY_STATUS_YES){
        cout << "License is blacklisted" << endl;
    } else if (licenseResult[RUI_LICENSE_ARRAY_INDEX_KEY_BLACKLISTED] == RUI_KEY_STATUS_NO) {
        cout << "License is NOT blacklisted" << endl;
    } else {
        cout << "License blacklist status unknown" << endl;
    }

    //Check if license key is expired
    if (licenseResult[RUI_LICENSE_ARRAY_INDEX_KEY_EXPIRED] == RUI_KEY_STATUS_YES){
        cout << "License is expired" << endl;
    } else if (licenseResult[RUI_LICENSE_ARRAY_INDEX_KEY_EXPIRED] == RUI_KEY_STATUS_NO) {
        cout << "License is NOT expired" << endl;
    } else {
        cout << "License expiration status unknown" << endl;
    }

    //Check if license key is white listed
    if (licenseResult[RUI_LICENSE_ARRAY_INDEX_KEY_WHITELISTED] == RUI_KEY_STATUS_YES){
        cout << "Key is white listed" << endl;
    } else if (licenseResult[RUI_LICENSE_ARRAY_INDEX_KEY_WHITELISTED] == RUI_KEY_STATUS_NO) {
        cout << "Key is NOT white listed" << endl;
    } else {
        cout << "Key white list status unknown" << endl;
    }
} else {
    cout << "Failed to invoke function ruiCheckLicenseKey()" << endl;
}

ruiFree(licenseResult);

RUIRESULT ruiSetLicenseKey(RUIINSTANCE* ruiInstance, const char* licenseKey, int32_t** licenseArray, const char* sessionID)

Checks the RUI Server for the license data for the supplied licenseKey and sets the current license to licenseKey. Whereas ruiCheckLicenseKey() is a passive check, ruiSetLicenseKey() changes the license key. The RUI Server always registers the licenseKey even if the RUI Server knows nothing about the licenseKey. When a new (unknown) licenseKey is registered, the RUI Server sets the license data to keyType RUI_KEY_TYPE_UNKNOWN and the four status flags (blacklisted, whitelisted, expired, activated) to RUI_KEY_STATUS_NO. The license array has size, indexes and values as specified in RUISDKDefines.h:

NOTE: Different from the V4 of the RUI SDK, a sessionID parameter can be supplied (based on ruiCreateConfig() multi session value):

* multiSessionEnabled = false - sessionID must be empty.  This is similar to event tracking APIs.
* multiSessionEnabled = true  - sessionID must be a current valid value used in ruiStartSession(), or it can be
                                empty.  This is different than normal event tracking APIs, whereby a empty value is not be allowed.

NOTE: The order of the license array data has changed from the RUI SDK V4.

ruiSetLicenseKey() can be called between ruiStartSDK() and ruiStopSDK(), and can be called zero or more times.

ruiSetLicenseKey() is primarily a synchronous function, returning once the check with RUI Server has completed. Some post- processing functionality is performed asynchronously, executed on separate thread(s).

This function should be called when an end user is trying to enter a new license key into your application and you would like to confirm that the key is in fact valid (i.e. blacklisted or whitelisted), active, or expired. The function is very similar to the ruiCheckLicenseKey() function, however rather than just being a passive license check, it also registers the new key with the server and associates it with this particular client installation.

The function accepts a const char* parameter that is the license key itself and an int32_t pointer to array of length 5 that it fills with the returned result. You may use the following constants to refer to the required value by its index:

* RUI_LICENSE_ARRAY_INDEX_KEY_TYPE        (0)
* RUI_LICENSE_ARRAY_INDEX_KEY_EXPIRED     (1)
* RUI_LICENSE_ARRAY_INDEX_KEY_ACTIVE      (2)
* RUI_LICENSE_ARRAY_INDEX_KEY_BLACKLISTED (3)
* RUI_LICENSE_ARRAY_INDEX_KEY_WHITELISTED (4)

Each of the index values 1 through 4 will be set to either 0 or 1 that refers to false or true respectively. The first value (RUI_LICENSE_ARRAY_INDEX_KEY_TYPE) will be set to a number between 0 and 7 (inclusive) that refers to the 8 possible license types listed below. The values may also be -1 that means “Unknown”.

The following are the possible license types:

* RUI_KEY_TYPE_UNCHANGED  (-1) - Key Type is Unchanged (when in parameter) or Unknown (when out parameter)
* RUI_KEY_TYPE_EVALUATION (0)
* RUI_KEY_TYPE_PURCHASED  (1)
* RUI_KEY_TYPE_FREEWARE   (2)
* RUI_KEY_TYPE_UNKNOWN    (3)
* RUI_KEY_TYPE_NFR        (4) - Key Type is Not For Resale
* RUI_KEY_TYPE_CUSTOM1    (5)
* RUI_KEY_TYPE_CUSTOM2    (6)
* RUI_KEY_TYPE_CUSTOM3    (7)

The following are the possible key status values:

* RUI_KEY_STATUS_UNCHANGED (-1) - Key Status is Unchanged (when in parameter) or Unknown (when out parameter).
* RUI_KEY_STATUS_NO        (0)  - Key Status is No.
* RUI_KEY_STATUS_YES       (1)  - Key Status is Yes.

Parameters:

ruiInstance (RUIINSTANCE*) - Pointer to the RUI instance created via ruiCreateInstance()

licenseKey (const char*) - The license key to be checked. This value cannot be empty.

licenseArray (int32_t**) - Pointer to the array that will be filled to contain the license status flags.

sessionID (const char*) - An optional session ID complying with above usage (content conditioning and validation rules in ruiStartSession()). Use empty if not used.

Returns:One of the return status constants below.
* RUI_OK - Function successful.
* RUI_INVALID_SDK_OBJECT - SDK Instance parameter is NULL or invalid.
* RUI_SDK_INTERNAL_ERROR_FATAL - Irrecoverable internal fatal error.  No further API calls should be made.
* RUI_SDK_ABORTED - A required New Registration has failed, and hence the SDK is aborted.  ruiStopSDK and ruiDestroyInstance are possible.
* RUI_SDK_SUSPENDED - The RUI Server has instructed a temporary back-off.
* RUI_SDK_PERMANENTLY_DISABLED - The RUI Server has instructed a permanent disable.
* RUI_SDK_OPTED_OUT - Instance has been instructed by the application to opt-out.
* RUI_CONFIG_NOT_CREATED - Configuration has not been successfully created.
* RUI_SDK_ALREADY_STOPPED - SDK has already been successfully stopped.
* RUI_INVALID_PARAMETER_EXPECTED_NON_EMPTY - Some API parameter is expected to be non-empty, and is not.
* RUI_TIME_THRESHOLD_NOT_REACHED - The API call frequency threshold (set by the RUI Server) has not been reached.
* RUI_NETWORK_CONNECTION_ERROR - Not able to reach the RUI Server.
* RUI_NETWORK_SERVER_ERROR - Error while communicating with the RUI Server.
* RUI_NETWORK_RESPONSE_INVALID - Message format error while communicating with the RUI Server.

Code Example:

//Register a new license key
bool useDefaultReachOutHandler = true;
RUIINSTANCE* mySDK = ruiCreateInstance(useDefaultReachOutHandler); //...; //Creation and initialization shown in other snippets.
char* myProductKey = "xyz";
int32_t* licenseResult = NULL;

if(ruiSetLicenseKey(mySDK, myProductKey, &licenseResult, NULL)==RUI_OK)
{
    if (licenseResult[RUI_LICENSE_ARRAY_INDEX_KEY_TYPE] == RUI_KEY_TYPE_UNCHANGED) {
        cout << "License key information is unknown" << endl;
    } else {
        cout << "License key type is " << licenseResult[RUI_LICENSE_ARRAY_INDEX_KEY_TYPE] << endl;
    }
    //Check if the license key is activated
    if (licenseResult[RUI_LICENSE_ARRAY_INDEX_KEY_ACTIVE] == RUI_KEY_STATUS_YES){
        cout << "License Active" << endl;
    } else if (licenseResult[RUI_LICENSE_ARRAY_INDEX_KEY_ACTIVE] == RUI_KEY_STATUS_NO) {
        cout << "License Inactive" << endl;
    } else {
        cout << "License status unknown" << endl;
    }

    //check if license key is blacklisted
    if (licenseResult[RUI_LICENSE_ARRAY_INDEX_KEY_BLACKLISTED] == RUI_KEY_STATUS_YES){
        cout << "License is blacklisted" << endl;
    } else if (licenseResult[RUI_LICENSE_ARRAY_INDEX_KEY_BLACKLISTED] == RUI_KEY_STATUS_NO) {
        cout << "License is NOT blacklisted" << endl;
    } else {
        cout << "License blacklist status unknown" << endl;
    }

    //Check if license key is expired
    if (licenseResult[RUI_LICENSE_ARRAY_INDEX_KEY_EXPIRED] == RUI_KEY_STATUS_YES){
        cout << "License is expired" << endl;
    } else if (licenseResult[RUI_LICENSE_ARRAY_INDEX_KEY_EXPIRED] == RUI_KEY_STATUS_NO) {
        cout << "License is NOT expired" << endl;
    } else {
        cout << "License expiration status unknown" << endl;
    }

    //Check if license key is white listed
    if (licenseResult[RUI_LICENSE_ARRAY_INDEX_KEY_WHITELISTED] == RUI_KEY_STATUS_YES){
        cout << "Key is white listed" << endl;
    } else if (licenseResult[RUI_LICENSE_ARRAY_INDEX_KEY_WHITELISTED] == RUI_KEY_STATUS_NO) {
        cout << "Key is NOT white listed" << endl;
    } else {
        cout << "Key white list status unknown" << endl;
    }
} else {
    cout << "Failed to invoke function ruiSetLicenseKey()" << endl;
}

ruiFree(licenseResult);