Vendor Issued Licenses System

Functionally

• Create new licenses in real-time both demo and sales
• Modify existing licenses in real-time
• Handles both Concurrent and Named Users.
• The API Key determines the basic rules for license changes like the number of days
• License expiry dates are restricted by the API Key setup.
• License will auto renewal depending on the API Key setup.
• Call a simple REST API URL address using a GET or POST method
• Just the minimal settings can be passed when calling the REST API as many fields have default logic.
• License changes and rules are validated and auto registered with the Sharperlight Online License System.
• License changes are reflected in real-time without a restart of the Sharperlight Window Service
• License that are set for auto-renewal, will automatically renew two days before expiring.

Prerequisites

• Version 6.0.0 or higher
• Partner API Key (Obtained from Sharperlight which is linked to your Vendor code)
• Internet Access on port 443 (https SSL)

Compliance

• Do not use spaces or special character in Vendor or Site Codes (only use – or _ when needed)
• Do not keep extending demo licenses or the Site Code will be locked out.
• Remember that licenses that are not demos are a sale and will be billed.
• Be aware of license pricing when setting the User Counts and License Type (Named / Concurrent)
• API Keys are linked to your vendor code and should kept secret and not be shared.
• All license changes are registered with Sharperlight for billing and compliance purposes.
• If you think your API Keys has been compromised, contact Sharperlight to have it revoked.
• The API Key terms like number of days, renewals and demos are determined when making a request
• If the same license is deployed in multiple locations, it will be flagged in audit reporting. These will require some feedback on the reason or it may be revoked.

Create new Named User License using REST API URL GET method

This example shows how to create a new license for 1 Full User and 3 Web users for a client named Client ABC.

The Named User admin takes the full license and guest, user2 and user3 are allocated as Web only users.  Because the named users are specified the license type is automatically set to Named and the User Counts are also automatically set based on the number of users listed.  Note the named Users need to already exist in Site Setup otherwise a error will be raised detailing the invalid users.

Noticed the Site Code was not specified and therefore it was auto generated, prefixed with the Vendor Code associated with the API Key.  In this case the Vendor associated with the API Key is REDRIBBON so the Site Code ends up being REDRIBBON:0B5CBA8D.  If you need to assign you own Site Code use the URL parameter &siteCode={YourVendorCode}:{YourSideCode} while avoiding special characters and spaces. The URL parameters that can be set, closely match the JSON names.  For example, setting the expiry date would be &expiryDate={yyyy-mm-dd} and Full User Count would be &fullUserCount=2.  Remember to URL encode parameters to protect special characters when present.

Notice that just the bare minimum information can be provided to generate a License Key and if not enough or invalid data is set the “errorMessage”: “” will contain an error number and details on what went wrong.

GET Method

https://yourServer/mdService1Rest/SystemLicenseUpdate?apiKey=99999-999-9999-FEED&fullUserNamedList=admin&webUserNamedList=guest;user2;user3&SiteName=Client%20A&VendorSiteCode=V1234

ERROR RESPONSE

{
   "errorMessage": "304: Invalid API Key '99999-999-9999-FEED' contact support@sharperlight.com",
   "message": "",
....
}


{
   "errorMessage": "541: The Vendor Site Code must be set when using this API Key",
   "message": "",
....
}

OK RESPONSE

{
  "errorMessage": "",
  "message": "100: Need at least one Full User license (Auto set)",
  "license": {
    "api": {
      "key": "99999-999-9999-FEED",
      "vendorCode": "REDRIBBON",
      "vendorName": "Red Ribbon Pty Ltd",
      "maxDays": 30,
      "maxDaysDemo": 7,
      "isLocked": false,
      "isTest": false,
      "isDelete": false,
      "allowAutoRenewal": true,
      "allowStartDate": true,
      "requireVendorSiteCode": true,
      "featuresKeyDefault": "[DM=************,MQSYSDM]"
    },
    "site": {
      "code": "REDRIBBON:0B5CBA8D",
      "name": "Client A"
    },
    "vendor": {
      "code": "REDRIBBON",
      "name": "Red Ribbon Pty Ltd",
      "contact": "",
      "email": "",
      "siteCode": "V4567"
    },
    "featureKey": "[DM=********,MQSYSDM][AutoRenew=30][VendorSiteCode=V4567]",
    "referenceCode": "",
    "startDate": "0001-01-01T00:00:00",
    "expiryDate": "2021-10-21T00:00:00+08:00",
    "autoRenewalOverride": "DEFAULT",
    "isDemo": false,
    "scheduler": false,
    "licenseType": "Named_Users",
    "licenseKey": "*********VZV",
    "full": {
      "userCount": 1,
      "userNamedList": "admin"
    },
    "web": {
      "userCount": 3,
      "userNamedList": "guest; user2; user3"
    },
    "other": ""
  }
}