Swagger UI

Sentinel Connect API Reference
 1 
OAS3

Sentinel Connect is an integration platform that empower companies to rapidly integrate enterprise applications and automate business processes. It offers a no-code, native connector and a low-code option to connect your business systems with Sentinel EMS. Sentinel Connect API simplifies the business logic and minimizes the coding effort, which is known as the low-code option. It offers lightweight API endpoints that are easy to integrate into your application source code. With a minimal coding effort, Sentinel Connect API offers great flexibility and allows you to connect any of your business systems with Sentinel EMS.

Its user interface assists to easily manage configurable entitlement business rules, track transactions and verify success.

API Call Sequence
To create or update an entitlement, execute the APIs in the specified sequential order only:
    1. Generate Token
    2. Create Entitlement
    3. Update Entitlement
    4. Get Entitlement

Servers
Computed URL:https://testconnectapi.sentinelcloud.com/v1

Server variables

basePath

Sentinel Connect

Use JSON format to create and update entitlement.

This API creates a new entitlement in EMS through Sentinel Connect. You can create an entitlement based on the available payloads – Entitlement with Custom Attributes, Entitlement With Customer and Contact, and Entitlement with Channel Partner. To create an entitlement you need a valid access token (generated using Generate Token API) and UUID.

Parameters

NameDescription
guid *
($uuid)
(header)

Globally unique identifier. In the live portal, click the Generate New UUID available on the top-right and paste the value in the guid field.

Request body

Examples: 
{
  "refId1": "PO78521",
  "refId2": "SO15865",
  "startDate": "2020-06-12",
  "endDate": "2025-03-19",
  "customAttribute": [
    {
      "attributeName": "Order Type",
      "attributeValue": "Perpectual"
    }
  ],
  "product": [
    {
      "startDate": "2020-07-01",
      "endDate": "2021-06-30",
      "totalQuantity": "200",
      "externalId": "GC3040",
      "customAttribute": [
        {
          "attributeName": "Item Number",
          "attributeValue": "Test1"
        },
        {
          "attributeName": "OrderDate",
          "attributeValue": "2200-01-01"
        }
      ]
    }
  ]
}

Responses

CodeDescriptionLinks
201

201 – Entitlement is successfully created.

Media type
Controls Accept header.
{
  "status": "string",
  "entitlements": [
    {
      "status": "string",
      "entitlement": {
        "externalId": "string",
        "creationDate": "string",
        "lastModifiedDate": "string",
        "entitlementAsWhole": true,
        "eId": "string",
        "id": "string",
        "startDate": "string",
        "expiry": {
          "neverExpires": true,
          "endDate": "string",
          "expiryInDays": 0
        },
        "customer": {
          "id": "string",
          "name": "string",
          "identifier": "string",
          "externalId": "string"
        },
        "contact": {
          "id": "string",
          "emailId": "string"
        },
        "entitlementPartners": {
          "entitlementPartner": [
            {
              "partner": {
                "id": "string",
                "name": "string",
                "identifier": "string",
                "externalId": "string"
              }
            }
          ]
        },
        "entitlementFingerprints": {
          "userRegistration": "string",
          "refId1": "string",
          "refId2": "string",
          "activationAllowed": true,
          "revocationAllowed": true,
          "state": "string",
          "sendNotification": true,
          "ccEmail": "string",
          "isTest": true,
          "customAttributes": {
            "customAttribute": [
              {
                "name": "string",
                "value": "string"
              }
            ]
          },
          "productKeys": {
            "productKey": [
              {
                "pkId": "string",
                "creationDate": "string",
                "lastModifiedDate": "string",
                "startDate": "string",
                "expiry": {
                  "neverExpires": true,
                  "endDate": "string",
                  "expiryInDays": 0
                },
                "id": "string",
                "enforcement": {
                  "id": "string",
                  "name": "string",
                  "version": "string"
                },
                "totalQuantity": 0,
                "availableQuantity": 0,
                "splittedQuantity": 0,
                "activationMethod": "string",
                "fixedQuantity": 0,
                "state": "string",
                "item": {
                  "itemProduct": {
                    "product": {
                      "externalId": "string",
                      "id": "string",
                      "nameVersion": {
                        "name": "string",
                        "version": "string"
                      }
                    },
                    "itemProductFeatures": {
                      "itemProductFeature": [
                        {
                          "feature": {
                            "externalId": "string",
                            "id": "string",
                            "identifier": 0,
                            "nameVersion": {
                              "name": "string",
                              "version": "string"
                            }
                          },
                          "itemFeatureLicenseModel": {
                            "licenseModel": {
                              "id": "string",
                              "name": "string"
                            },
                            "attributes": {
                              "attribute": [
                                {
                                  "name": "string",
                                  "value": "string",
                                  "displayText": "string"
                                }
                              ]
                            }
                          },
                          "itemFeatureState": "string"
                        }
                      ]
                    }
                  }
                },
                "commonLicenseAttributes": {
                  "commonLicenseAttribute": [
                    {
                      "name": "string",
                      "value": "string",
                      "displayText": "string"
                    }
                  ]
                },
                "activationAttributes": {
                  "activationAttribute": [
                    {
                      "groupName": "string",
                      "subGroupName": "string",
                      "name": "string",
                      "value": "string",
                      "readOnly": true,
                      "mandatory": true,
                      "associatedAttribute": {
                        "name": "string",
                        "value": "string",
                        "readOnly": true,
                        "mandatory": true
                      }
                    }
                  ]
                },
                "customAttributes": {
                  "customAttribute": [
                    {
                      "name": "string",
                      "value": "string"
                    }
                  ]
                }
              }
            ]
          }
        }
      }
    }
  ]
}
No links
400

400 – Failed to create an entitlement.

Media type
{
  "status": "string",
  "error": "string",
  "requiredParameters": [
    {
      "element": "string",
      "message": "string"
    }
  ]
}
No links

This API is used when an existing entitlement needs to be retrieved from EMS. You need to provide an already created entitlement ID

Parameters

NameDescription
guid *
($uuid)
(header)

Globally unique identifier. In the live portal, click the Generate New UUID available on the top-right and paste the value in the guid field.

EID *
string
(query)

Entitlement ID of the entitlement that needs to be retrieved.

Responses

CodeDescriptionLinks
200

200 response

Media type
Controls Accept header.
{
  "status": "string",
  "entitlementInfo": [
    {
      "status": "string",
      "entitlement": {
        "externalId": "string",
        "creationDate": "string",
        "lastModifiedDate": "string",
        "entitlementAsWhole": true,
        "eId": "string",
        "id": "string",
        "startDate": "string",
        "expiry": {
          "neverExpires": true,
          "endDate": "string",
          "expiryInDays": 0
        },
        "customer": {
          "id": "string",
          "name": "string",
          "identifier": "string",
          "externalId": "string"
        },
        "contact": {
          "id": "string",
          "emailId": "string"
        },
        "entitlementPartners": {
          "entitlementPartner": [
            {
              "partner": {
                "id": "string",
                "name": "string",
                "identifier": "string",
                "externalId": "string"
              }
            }
          ]
        },
        "entitlementFingerprints": {
          "userRegistration": "string",
          "refId1": "string",
          "refId2": "string",
          "activationAllowed": true,
          "revocationAllowed": true,
          "state": "string",
          "sendNotification": true,
          "ccEmail": "string",
          "isTest": true,
          "customAttributes": {
            "customAttribute": [
              {
                "name": "string",
                "value": "string"
              }
            ]
          },
          "productKeys": {
            "productKey": [
              {
                "pkId": "string",
                "creationDate": "string",
                "lastModifiedDate": "string",
                "startDate": "string",
                "expiry": {
                  "neverExpires": true,
                  "endDate": "string",
                  "expiryInDays": 0
                },
                "id": "string",
                "enforcement": {
                  "id": "string",
                  "name": "string",
                  "version": "string"
                },
                "totalQuantity": 0,
                "availableQuantity": 0,
                "splittedQuantity": 0,
                "activationMethod": "string",
                "fixedQuantity": 0,
                "state": "string",
                "item": {
                  "itemProduct": {
                    "product": {
                      "externalId": "string",
                      "id": "string",
                      "nameVersion": {
                        "name": "string",
                        "version": "string"
                      }
                    },
                    "itemProductFeatures": {
                      "itemProductFeature": [
                        {
                          "feature": {
                            "externalId": "string",
                            "id": "string",
                            "identifier": 0,
                            "nameVersion": {
                              "name": "string",
                              "version": "string"
                            }
                          },
                          "itemFeatureLicenseModel": {
                            "licenseModel": {
                              "id": "string",
                              "name": "string"
                            },
                            "attributes": {
                              "attribute": [
                                {
                                  "name": "string",
                                  "value": "string",
                                  "displayText": "string"
                                }
                              ]
                            }
                          },
                          "itemFeatureState": "string"
                        }
                      ]
                    }
                  }
                },
                "commonLicenseAttributes": {
                  "commonLicenseAttribute": [
                    {
                      "name": "string",
                      "value": "string",
                      "displayText": "string"
                    }
                  ]
                },
                "activationAttributes": {
                  "activationAttribute": [
                    {
                      "groupName": "string",
                      "subGroupName": "string",
                      "name": "string",
                      "value": "string",
                      "readOnly": true,
                      "mandatory": true,
                      "associatedAttribute": {
                        "name": "string",
                        "value": "string",
                        "readOnly": true,
                        "mandatory": true
                      }
                    }
                  ]
                },
                "customAttributes": {
                  "customAttribute": [
                    {
                      "name": "string",
                      "value": "string"
                    }
                  ]
                }
              }
            ]
          }
        }
      }
    }
  ]
}
No links
400

400 response

Media type
{
  "status": "string",
  "error": "string",
  "requiredParameters": [
    {
      "element": "string",
      "message": "string"
    }
  ]
}
No links