Summary

When your client application performs a capability exchange using the CMAPI, it uses the POST method on either of /access_request or /signed_access_request REST APIs to send a capability request in JSON format to the license server to obtain licenses for the requesting enterprise client.

In this example, we use /access_request API to obtain licenses

Step 1: Create Public/Private Key Pair

A Private and Public key are required to use the REST-driven licensing APIs (CMAPI)

There are many publicly available tools; one example is provided below.

To create a public/private key pair:

1. Download and Install OpenSSL “Light” for Windows @ https://slproweb.com/products/Win32OpenSSL.html
2. Open command prompt in C:\Program Files\OpenSSL-Win64\bin (or OpenSSL installed location)
3. Run the following commands:

   openssl genrsa -out SaaSDemoPrivate.pem 2048
   openssl rsa -inform PEM -outform DER -in SaaSDemoPrivate.pem -pubout-out SaaSDemoPublic.der

4. The following will be generated:
   • Private Key: SaaSDemoPrivate.pem
   • Public Key: SaaSDemoPublic.der
5. They will be created in C:\Program Files\OpenSSL-Win64\bin

   

Step 2: Get CLS Authorization Token

To get the CLS authorization token:

1. In the Customer Portal, set the admin password on the target Cloud Server (CLS). The Producer password (for all Cloud Servers) can also be used.
2. Use /authorize REST endpoint to get the authorization token.

   

NOTE: For more information, see the License Server Producer Guide.

Step 3: Upload Public Key to Customer CLS Instance Using /rest_licensing_keys

To upload public key to customer CLS:

1. Add Authorization with token generated from Step 2.
2. Add Body - Attach SaaSDemoPublic.der Public Key from C:\Program Files\OpenSSL-Win64\bin.

   

3. Add Content-Type: application/octet stream to Headers.
4. Send POST to rest_licensing_keys endpoint. Status should be “200 OK” and then we will get Public key with a successful upload.

Step 4: Create JSON Web Token (JWT) from Private Key

To create JSON web token (JWT) from Private Key:

1. JWT Creation example we can use online tools such as https://jwt.io/ are readily available.
2. Select the RS256 Algorithm and enter the following Payload Data:

   {
   "sub": "1234567890",
   "roles": "ROLE_CAPABILITY"
   }

3. Copy contents of SaaSDemoPrivate.pem from C:\Program Files\OpenSSL-Win64\bin into the Verify Signature Private Key Section

   

4. Copy Public key from Step 3 and paste it below “Begin Public key” line, then we will get J W T Token on the left side like below:

   

Step 5: Request User License using /access_request

To request user license:

1. Add the newly created JWT token to the Header.

   

2. Create the desired license request in the Body, for an example request under raw section.

    {
                              "hostId" : {
                              "type" : "string",
                              "value" : " Access_Request"
                              },
                            "incremental" : true,
                            "borrow-interval" : "0",
                           "partial" : true,
                           "features" : [
                                         {
                                         "count" : 1,
                                         "name" : "0000Test",
                                         "version" : "1"
                                         },
                                         {
                                       "count" : 1,
                                       "name" : "ManiDemoFeature",
                                       "version" : "1.0"   
                                       }
                           ]
             }

   

3. Send the POST request (/access_request) and view the response for the above request with two features and one count for each.
4. Find the response below with status: 200 OK.

   

5. Served Device Details can then be viewed in the Producer/Customer Portals:
6. In this example Served device ID = Access_Request.

   

7. We can see the requested features with the number of counts for each.

Step 6: View Available Licenses in the CLS

To view available licenses in the CLS:

1. One method to see all licenses (with available quantities) is to use /preview_request endpoint. The /features endpoint can also be used (verbose). Sample request for preview.

    {
                     "hostId": {
                    "type": "string",
                   "value": "Client1"
                  },
                  "selectorsDictionary": {}
                  }

2. Preview response contains available count “count” and Maximum Entitled count “maxCount” for each feature, find the attached preview_request.png.

NOTE: I have also attached as document format for your reference.