REST-Based Web API Version 2 – Support Center

Introduction

Here we describe the REST-based API (Version 2) used for common operations in Zentitle using Web API Keys.

Zentitle REST-based Web API Version2 URL format - https://my.nalpeiron.com/api/v2/<controller_name>

The process of creating new Web API Keys is described here

Example Calls using Postman

Example code for making the API calls described here is provided in a variety of languages at the following link which uses the third-party Postman API test application:

https://documenter.getpostman.com/view/13916863/TzefB4Lm

To run tests or generate code in your preferred programming language in Postman, please replace the example values for various fields with the correct ones for your Zentitle account and products.

Creating Web API Keys

1 Login to my.nalpeiron.com

2 Navigate to "settings" on the top toolbar and then click "webservices" from the drop down menu.

3 Navigate to "API Keys" tab and then click "Generate New API Key" button.

4 Select the Key type from the drop-down menu and click "REQUEST" to generate an API Key.
Now click "Save"

You will need this API Key to access Web API. CAUTION: Use web services only on a machine that is 100% under your control.

Types of API Keys :

WebAPI READ-ONLY - With this Key, you can only access our Read-Only Web API calls (for example all GET calls except for the DataStreamer controller which requires a separate WebAPI DS key).

WebAPI READ-WRITE - With this Key, you can access all our Web API calls except for the DataStreamer controller which requires a separate WebAPI DS key.

WebAPI Offline - With this Key, customers can only access OfflineActivation controller and OfflineDeActivation controller.

WebAPI DS - With this Key, customers can only access DataStreamer controller.

Web API Calls

Below are the basic Web API calls that are available.

Controller	Action	Description
LicenseCode	GET	Gets the supplied license code details.
	POST	Allocates or Imports license codes.
	PUT	Updates the supplied license code with the supplied values.
	DELETE	Deletes the supplied license code details. Please note that this will delete all historical and current information on this license code and the action is irreversable.

LicenseCodes	GET	Gets the license code details for your company.

Products	GET	Gets details of all products.

Product	GET	Gets the supplied product details.
	POST	Creates a new product with features, feature groups, applicationAgility fields.
	PUT	Updates supplied product with supplied values.

ProductFeatureGroups	POST	Creates supplied list of product feature groups.
	PUT	Updates details of supplied list of product feature groups.
	DELETE	Deletes supplied product feature group.

ProductFeatures	POST	Creates supplied list of product features.
	PUT	Updates details of supplied list of product features.
	DELETE	Deletes supplied product feature.

ProductApplicationAgility	POST	Creates supplied list of product Application Agility data.
	PUT	Updates details of supplied list of product Application Agility data.
	DELETE	Deletes supplied product Application Agility data.

NextLicenseCode	GET	Gets the next available (unused) license code for given profile.

ActivatedLicenseCodes	GET	Gets all currently activated license codes and corresponding productIDs associated with a given computerID.

LicenseCodeActivity	GET	Gets the supplied license code activity details.
	PUT	Sets all statuses of all activations associated with a given license code to 'returned'.
	DELETE	Deletes activity associated with the provided license code.

LicenseCodesByOrderID	GET	Gets all license codes linked to the supplied OrderID. (Returns all license codes that contains the supplied OrderID string).

PassiveLicense	POST	Creates a client activation certificate for passive licenses.

NetworkMasterLicense	POST	Creates a master license to activate the LAN daemon.
	GET	Gets information about master license(s). Coming soon.

Profile	GET	Gets information about the supplied profile.
	POST	Creates a new code profile.
	PUT	Updates existing code profile.

Profiles	GET	Gets information about all profiles.

ConsumerData	GET	Gets the supplied consumer records for the specified ProductID.
	POST	Creates consumer record and makes it searchable on optional fields - firstname, lastname, company and email.

Trial	GET	Checks the trial status (including if activated with license code) for a given productID and computerID.
	DELETE	Resets an existing trial for a given user, productID and computerID.

Trials	GET	Gets status information about all trials.

OfflineActivation	POST	Gets the offline activation certificate for the supplied certificate request.

OfflineDeActivation	POST	Deactivates via the supplied deactivation certificate.

SystemDetails	GET	Gets the supplied computerid’s system details (if available).

Company	GET	Gets company details for supplied companyID.
	POST	Creates new company details.
	PUT	Updates details for company with supplied companyID.
	DELETE	Deletes a company.

CompanyID	GET	Gets CompanyID for given company name and productID.

CompaniesProducts	GET	Gets all company IDs and associated product IDs.

Group	GET	Gets information about the supplied group.
	POST	Creates a group.
	PUT	Updates a group.
	DELETE	Deletes a group.

Groups	GET	Gets information about all the groups.

GroupUser	GET	Gets information about the supplied group user.
	POST	Adds a group user.
	PUT	Updates a group user.
	DELETE	Deletes a group user.

GroupUserPassword	PUT	Updates the password of a group user.

GroupLicenseCode	GET	Gets information about the supplied group license code.
	POST	Assigns a license code to a group.
	DELETE	Unassigns a license code from a group.

GroupUserLicense	POST	Creates a group, user and assigns a license.

LicenseNote	GET	Gets all notes associated with the supplied license code.
	POST	Creates a note to be associated with a license code.
	PUT	Updates a note associated with a license code.
	DELETE	Deletes a note associated with a license code.

AuthenticateUser	GET	Authenticates the credentials of a (non-admin) end-user.

DataStreamer	GET	Gets DataStreamer data for the supplied eventType.
	POST	Creates custom DataStreamer events.

ConsumptionTokens	PUT	Updates the ConsumptionToken TokenMax/CheckedOutTokens value.

APIKey	POST	Creates a new APIKey.
	PUT	Updates APIKey details.
	DELETE	Deletes the APIKey.

(* - Mandatory field)

Non-Mandatory fields that are not included (omitted) in any PUT call will not be updated and the original field values will stay the same as before the call.

All GET and DELETE methods are implemented to get input parameters from the request URI as Query String Parameters.

All characters in the input string that are passed as query string parameters should be URL encoded if required to avoid invalid character issues.

All POST and PUT methods are implemented to get input parameters from the request body.

All datetimes are in UTC.

GET LicenseCode

Accessible API Keys	WebAPI READ-ONLY, WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

licenseCode*	string	License code in question.
productId	string	ProductID in question. If omitted displays details of the supplied license code across all products.
details	int	Set to 1 for a detailed breakdown of feature usage by computerID. Must be either 1 or 0 - default (if omitted) - 0.
getNotes	int	Set to 1 to see notes associated with this license code. Must be either 1 or 0 - default (if omitted) - 0.
userDetails	int	Set to 1 for a detailed breakdown of feature usage by computerID and username (for account-based licensing). Must be either 1 or 0 - default (if omitted) - 0.
getSfs	int	Get server functions (1=yes, 0 otherwise). Must be either 1 or 0 - default (if omitted) - 0.
showFeatures	string	Must be either 'on' or 'all' - default (if omitted) - 'all'. If 'on' gets features details for the features that are ON for the license code. If 'all' gets the features details for the features that are ON and OFF for the license code.

Output:

licenseCode		string	License code in question.
productId		string	ProductID to which the license code has been assigned.
company		string	Company to which the license code has been assigned.
companyId		int	CompanyID to which the license code has been assigned.
orderId		string	Any OrderID linked to the license code.
enabledForUse		string	Is the LC enabled for use (true or false)
licenseType		string	The license type - Perpetual, SubscriptionPeriod or ExpirationDate.
clientsAllowed		int	Number of clients allowed.
clientLeasePeriod		int	Client lease period in hours.
vmLeasePeriod		int	Virtual machine lease period in hours (0=unlimited).
clientOfflineLeasePeriod		int	Client offline lease period in hours.
acquiredByWebservice		string	Is the license code acquired by GET NextLicenseCode webservice (true or false).
networkSeats		int	Number of network seats (LAN) (0-2147483647).
heartBeat		int	LAN daemon heartbeat (mins) (5-1440).
profileName		string	Profile to which license code belongs. Returns 'default' if none.
profileId		int	ID of the Profile to which license code belongs. Returns '0' if none.
concurrentProcesses		int	Number of concurrent processes allowed (0=unlimited).
numActivations		int	Number of current activations for this license code.
concurrencyMode		string	Concurrency mode of the license code - off, cloud or network.
subscriptionPeriod		int	Subscription period in days.
subscriptionEndDate		datetime	Subscription end datetime.
subscriptionLastActivated		datetime	Subscription last activation datetime.
maintenanceEndDate		datetime	Maintenance end datetime.
created		datetime	Date when code was imported/allocated.
modified		datetime	Date when code was last modified.
features (for each feature)	featureCode	string	The feature code.
	featureAvailability	string	Availability of the feature - ON or OFF.
	featureType	string	The feature type - Normal, Floating, Element Pool, Consumption Tokens or SecureStore.
	featureDetails	string	MaximumActive/TotalActive=max seats/current seats checked out on floating feature. ElementLimit/ElementCount=max elements/current no. of elements checked out for element pool. TokenLimit/TokenCount=max tokens/current no. of tokens checked out for consumption tokens. If details=1, Total gives the total number of seats/elements/tokens checked out for this feature on the computerID shown. If userdetails=1, Total gives the total number of seats/elements/tokens checked out for this feature on the computerID and username shown.
applicationAgility (for each AA)	name	string	Application Agility variable field name.
applicationAgility (for each AA)	value	string	The set value for the Application Agility field.
notes (for each note)	noteId	int	ID attribute of the note.
	type	string	Note Type - General or System.
	created	datetime	Created datetime.
	createdBy	string	Logged in user or blank if created by webservices.
	description	string	Note description.
serverFunctions (for each server function)	functionName	string	Server function name.
	enabled	string	ON or OFF.
	parameterValue	int	The value of custom parameter.
currentLiveActivations		int	The number of current activations whose lease has not expired.

Example Input URL format:

Input data from request URI

https://my.nalpeiron.com/api/v2/licensecode?productId=6453300110&licenseCode=206454320110930859&getSfs=1&details=1&getNotes=1&showFeatures=all

Example Output

[
 {
   "licenseCode": "206454320110930859",
   "productId": "6453300110",
   "company": "",
   "companyId": 0,
   "orderId": "orderID_1",
   "enabledForUse": "true",
   "licenseType": "perpetual",
   "clientsAllowed": 9,
   "clientLeasePeriod": 12,
   "vmLeasePeriod": 0,
   "clientOfflineLeasePeriod": 8760,
   "acquiredByWebservice": "true",
   "networkSeats": 0,
   "heartBeat": 0,
   "profileName": "Test-PC",
   "profileId": "12",
   "concurrentProcesses": 15,
   "numActivations": 1,
   "concurrencyMode": "off",
   "subscriptionPeriod": 0,
   "subscriptionEndDate": null,
   "subscriptionLastActivated": "2018-08-02T06:59:02.043Z",
   "maintenanceEndDate": "2021-04-30T00:00:00Z",
   "created": "2018-08-02T06:59:02.043Z",
   "modified": "2021-04-30T00:00:00Z",
   "features": [
               {
                "featureCode": "EPOOL",
                "featureAvailability": "ON",
                "featureType": "ElementPool",
                "featureDetails": [
                                  "elementLimit : 10000",
                                  "elementCount : 0"
                                  ]
               },
               {
                "featureCode": "FLOAT",
                "featureAvailability": "ON",
                "featureType": "Floating",
                "featureDetails": [
                                  "maximumActive : 100",
                                  "totalActive : 0"
                                  ]
               },
               {
                "featureCode": "FEAT5",
                "featureAvailability": "OFF",
                "featureType": "Normal",
                "featureDetails": []
               }
               ],
  "applicationAgility": [
               {
                "name": "TEST1",
                "value": "6"
               },
               {
                "name": "TEST2",
                "value": "test"
               }
               ],
  "notes": [
           {
            "noteId": 102509,
            "type": "System",
            "created": "2020-12-18T17:11:15.7Z",
            "createdBy": "",
            "description": "note"
           },
           {
            "noteId": 102511,
            "type": "General",
            "created": "2020-12-18T17:15:39.387Z",
            "createdBy": "",
            "description": "General note updated"
           }
           ],
  "serverFunctions": [
                     {
                      "functionName": "LTCO",
                      "enabled": "ON",
                      "parameterValue": "20"
                     },
                     {
                      "functionName": "FeatureAvailability",
                      "enabled": "ON",
                      "parameterValue": ""
                     },
                     {
                      "functionName": "Otherfunc",
                      "enabled": "OFF",
                      "parameterValue": ""
                     }
                     ], 
      "currentLiveActivations": 0
 }
]

POST LicenseCode

Accessible API Keys	WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

productId*	string	ProductID in question.
companyId	int	ID of the company to which the license code is to be assigned (optional). Omit to not assign to any company(set to 0) - default - set to 0.
licenseCodes	string	Json list of license codes to be imported. If omitted, will generate/allocate number of Zentitle license codes specified in the numcodes parameter instead (optional - see below).
numCodes	int	Number of Zentitle license codes to generate. Will be ignored if custom license codes are imported (optional - see above).
profileName	string	Profile to which codes are allocated. If omitted - none/default.
reference	string	Any reference string. (Max 200 characters).
orderId	string	Any OrderID linked to the license codes created. (Max 200 characters).

Output:

When Zentitle-generated codes are allocated, the output will be a Json list of these codes or an error description.
When your own codes are imported, the output message will be "OK" or an error description.

Example Input:

Input data from request body.

Data - raw:

{
 "productId":"6453300110",
 "profileName": "testingProfile",
 "companyId":"17",
 "numCodes":"2",
 "reference":"LCforProductA",
 "orderId": "orderID_1"
}

Example Output

{
"licenseCodes": [
"278310026536907968",
"278547268546994461"
]
}

Example Input

Input data from request body.

Data - raw:

{
 "productId":"6453300110",
 "profileName": "testingProfile",
 "companyId":"10",
 "licenseCodes": ["123410225741720791", "567810225741720792"],
 "reference":"LCforProductB",
 "orderId": "orderID_1"
}

Example Output

{

"message": "OK"

}

PUT LicenseCode

Accessible API Keys	WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

productId*		string	Product in question.
licenseCode*		string	License code in question.
companyId		int	ID of the company to which the license code is to be assigned (optional). Set to 0 to not assign to any company.
clientLeasePeriod		int	Client lease period in hours (max 8760).
clientOfflineLeasePeriod		int	Client Offline lease period in days (max 500).
vmLeasePeriod		int	Virtual machine lease period in hours (max 500) (0=unlimited).
enabledForUse		string	Is the LC enabled for use (true or false). Must be either true or false.
licenseType		string	The license type - Must be either perpetual, subscriptionperiod or expirationdate. Note: this must be included whenever the license type is changed, including from subscriptionperiod to expirationdate and vice versa.
clientsAllowed		int	Number of clients allowed. Must be between 0 and 50000.
acquiredByWebservice		string	Is the license code acquired by GET NextLicenseCode webservice (true or false). Must be either true or false.
profileName		string	Sets the code profile ('default'=none/default).
inheritProfile		string	Inherits profile properties - Must be either true or false. Default (if omitted) - false.
subscriptionPeriod		int	Subscription period in days (mandatory for subscriptionperiod licensetype). Please supply the licensetype to update the subscription period. This field is validated only for subscriptionPeriod licensetype. Note: Whenever licenseType is changed to 'subscriptionPeriod', subscriptionPeriod parameter must be between 1 and 5000. To extend subscriptionPeriod duration days, subscriptionPeriod parameter must be between 1 and 1000.
subscriptionEndDate		datetime	Subscription end date (mandatory for ExpirationDate licensetype). Please supply the licensetype to update the subscription end date. To set to null, the input should be 'reset' (for licensetypes except ExpirationDate). Otherwise this field is validated only for ExpirationDate licensetype.
maintenanceEndDate		datetime	Maintenance end date. To set to null, the input should be 'reset'.
concurrentProcesses		int	Number of concurrent processes allowed (0= unlimited).
concurrencyMode		string	Concurrency type - Must be either off, cloud or network. Note: Whenever concurrencyMode is changed to 'network', networkSeats parameter and heartBeat parameter must be included.
networkSeats		int	Number of network seats (LAN) for 'network' concurrency mode. Must be between 0 and 2147483647.
heartBeat		int	LAN daemon heartbeat for 'network' concurrency mode. (mins) (5-1440).
orderId		string	Any OrderID linked to the license code. (Max 200 characters).
features (for each feature)	featureCode	string	The feature code.
	featureAvailability	string	Set to on/off to enable/disable the feature for the specified license code. Must be either on or off.
	limit	int	Limit attribute applies to floating features and element pools, for which it respectively sets the maximum number of seats and the maximum number of elements available to this code.
applicationAgility (for each AA)	name	string	Application agility variable field name.
applicationAgility (for each AA)	value	string	Value for the application agility field.
notes (for each note)	type	string	Must be either general, system, delete or deleteall.
notes (for each note)	description	string	If "type"="general" or "system", a corresponding general or system note will be created with the specified description. If "type"="delete" and description = a noteID, then the note with this noteID will be deleted. If "type"="deleteall" then all notes associated with this license code will be deleted. Note: Types are processed in the following order: deleteall, then delete, then general/system.
serverFunctions (for each server function)	functionName	string	Server function name.
	enabled	string	Set to on/off to enable/disable the server function for the specified license code. Must be either on or off.
	parameterValue	int	The value of custom parameter. Currently, only one editable server function has been implemented - Long-Term CheckOut License with function name 'LTCO'. The value must be the integer value of the maximum check-out period in days (0 - 2147483647).

Output:

"License Code Details Updated Successfully" for correct update or error description.

If there is any error description, the license code update has failed and none of the details are updated.
For the fields that are not included (omitted), the original field values will stay the same as before the call.

Example Input:

Input data from request body.

Data - raw:

{
"productId":"6453300110",
"licenseCode": "206454320110930859",
"companyId": "17",
"enabledForUse": "true",
"licenseType": "subscriptionPeriod",
"clientsAllowed": "2",
"clientLeasePeriod": "0",
"vmLeasePeriod": "0",
"clientOfflineLeasePeriod": "1",
"acquiredByWebservice": "true",
"profileName": "testingProfile",
"inheritProfile":"false",
"concurrentProcesses": "0",
"concurrencyMode":"network",
"networkSeats":"1",
"heartBeat": "5",
"orderId": "orderID_1",
"subscriptionPeriod": "10",
"maintenanceEndDate": "reset",
"features": [
            {
             "featureCode": "FEAT1",
             "featureAvailability": "on",
             "limit": "10"
            },
            {
             "featureCode": "EPOOL",
             "featureAvailability": "on",
             "limit": "15"
            }
            ],
"applicationAgility": [
             {
              "name": "TEST1",
              "value": "udf1"
             },
             {
              "name": "TEST2",
              "value": "udf2"
             }
             ],
"notes": [
         {
          "type": "general",
          "description": "general note"
         }
         ],
"serverfunctions": [
                   {
                    "functionName": "LTCO",
                    "enabled": "on",
                    "parameterValue": "20"
                   },
                   {
                    "functionName": "Otherfunc",
                    "enabled": "off"
                   }
                   ]
}

Example Output

{

"message": "License Code Details Updated Successfully"

}

DELETE LicenseCode

Caution: Please note that this will delete all historical and current information on this license code and the action is irreversable.

Accessible API Keys	WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

productid	string	Product ID of license code.
licensecode *	string	License code to be deleted.

Output

"License Code Deleted Successfully" or error message.

Example Input URL format:

Input data from request URI

https://my.nalpeiron.com/api/v2/licenseCode?productId=6872450105&licenseCode=27835001310249256

Example Output

{

"message": "License Code Deleted Successfully"

}

GET LicenseCodes

Accessible API Keys	WebAPI READ-ONLY, WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

productId	string	Selects only license codes for this productid (optional).
pageNumber	int	If >0 then returns the results on that page. If 0 or omitted then returns only the number of license codes (count) (optional).
pageSize	int	Number of records per page (default and max. value=10000) (optional).
company	string	Selects only license codes for this company (optional). If supplied, please supply either company or companyID, not both (see the below input parameter).
companyId	int	Selects only license codes for this companyID (optional). If supplied, please supply either company or companyID, not both (see the above input parameter).
profileName	string	Selects only license codes for with this profile (optional).
acquiredByWebservice	string	Selects only license codes acquired ('true') or not acquired ('false') by GET NextLicenseCode webservice (optional). Must be either true or false. Default (if omitted) - selects all.
used	string	Selects only license codes that have been activated at some point ('true') or never activated ('false') (optional). Must be either true or false. Default (if omitted) - selects all.
activated	string	Selects only license codes currently activated ('true') or not currently activated ('false') (optional). Must be either true or false. Default (if omitted) - selects all.
passive	string	Selects only passive license codes ('true') or license codes that are not passive ('false') (optional). Must be either true or false. Default (if omitted) - selects all.
getSfs	int	Get server functions (1=yes, no otherwise). Must be either 1 or 0 - default (if omitted) - 0.

Output -

If pageNumber parameter is 0 or omitted then returns only the count of license codes.

Else, returns one or more sets of:

licenseCode		string	License code in question.
productId		string	ProductID to which the license code has been assigned.
company		string	Company to which the license code has been assigned.
companyId		int	Company ID to which the license code has been assigned.
orderId		string	Any OrderID linked to the license code.
enabledForUse		string	Is the LC enabled for use (true or false).
licenseType		string	The license type - Perpetual, SubscriptionPeriod or ExpirationDate.
profileName		string	Profile to which license code belongs.
profileId		int	ID of the Profile to which license code belongs. Returns '0' if none.
acquiredByWebservice		string	Is the license code acquired by GET NextLicenseCode webservice (true or false).
clientsAllowed		int	Number of activations allowed.
clientLeasePeriod		int	Client lease period in hours.
vmLeasePeriod		int	Virtual machine lease period in hours (0=unlimited).
clientOfflineLeasePeriod		int	Client offline lease period in hours.
networkSeats		int	Number of network seats (LAN) (0-2147483647).
heartBeat		int	LAN daemon heartbeat (mins) (5-1440).
concurrentProcesses		int	Number of concurrent processes allowed (0=unlimited).
numActivations		int	Number of current activations for this license code.
numDeActivations		int	Number of deactivations.
concurrencyMode		string	Concurrency mode of the license code - off, cloud or network.
subscriptionPeriod		int	Subscription period in days.
subscriptionEndDate		datetime	Subscription end datetime.
subscriptionLastActivated		datetime	Subscription last activation datetime.
maintenanceEndDate		datetime	Maintenance end datetime.
created		datetime	date when code was allocated/imported.
modified		datetime	date when code was last modified.
features (for each feature)	featureCode	string	The feature code.
	featureAvailability	string	Availability of the feature - ON or OFF.
	featureType	string	The feature type - Normal, Floating, Element Pool, Consumption Tokens or SecureStore.
	featureDetails	string	MaximumActive/TotalActive=max seats/current seats checked out on floating feature. ElementLimit/ElementCount=max elements/current no. of elements checked out for element pool. TokenLimit/TokenCount=max tokens/current no. of tokens checked out for consumption tokens.
applicationAgility (for each AA)	name	string	Application Agility variable field name.
applicationAgility (for each AA)	value	string	The set value for the Application Agility field.
serverFunctions (for each server function)	functionName	string	Server function name.
	enabled	string	ON or OFF.
	parameterValue	int	The value of custom parameter.

Example Input URL format:

Input data from request URI

https://my.nalpeiron.com/api/v2/licensecodes?pagenumber=1&pagesize=2&activated=true&getsfs=1

Example Output

[
 {
 "licenseCode": "206454320110930859",
 "productId": "6453300110",
 "company": "",
 "companyId": 0,
 "orderId": "orderID_1",
 "enabledForUse": "true",
 "licenseType": "perpetual",
 "profileName": "Test-PC",
 "profileId": "12",
 "acquiredByWebservice": "true",
 "clientsAllowed": 9,
 "clientLeasePeriod": 12,
 "vmLeasePeriod": 0,
 "clientOfflineLeasePeriod": 8760,
 "networkSeats": 0,
 "heartBeat": 0,
 "concurrentProcesses": 15,
 "numActivations": 1,
 "numDeActivations": 41,
 "concurrencyMode": "off",
 "subscriptionPeriod": 0,
 "subscriptionEndDate": null,
 "subscriptionLastActivated": "2020-08-02T06:59:02.043Z",
 "maintenanceEndDate": "2021-04-30T00:00:00Z",
 "created": "2013-06-12T00:00:00Z",
 "modified": "2021-01-11T15:36:55.723Z",
 "features": [
             {
             "featureCode": "EPOOL",
             "featureAvailability": "ON",
             "featureType": "ElementPool",
             "featureDetails": [
                               "elementLimit : 10000",
                               "elementCount : 0"
                               ]
             },
             {
             "featureCode": "FEAT5",
             "featureAvailability": "ON",
             "featureType": "Normal",
             "featureDetails": []
             }
             ],
"applicationAgility": [
             {
             "name": "TEST1",
             "value": "6"
             },
             {
             "name": "TEST2",
             "value": "testvalue6"
             }
             ],
"serverFunctions": [
                   {
                   "functionName": "LTCO",
                   "enabled": "ON",
                   "parameterValue": "20"
                   },
                   {
                   "functionName": "FeatureAvailability",
                   "enabled": "ON",
                   "parameterValue": ""
                   },
                   {
                   "functionName": "Otherfunc",
                   "enabled": "OFF",
                   "parameterValue": ""
                   }
                   ]
},
{
 "licenseCode": "286502700212974761",
 "productId": "6843607105",
 "company": "abcLtd",
 "companyId": 11,
 "enabledForUse": "true",
 "licenseType": "perpetual",
 "profileName": "default",
 "profileId": 0,
 "acquiredByWebservice": "true",
 "clientsAllowed": 1,
 "clientLeasePeriod": 1,
 "vmLeasePeriod": 0,
 "clientOfflineLeasePeriod": 8760,
 "networkSeats": 0,
 "heartBeat": 0,
 "concurrentProcesses": 14,
 "numActivations": 1,
 "numDeActivations": 27,
 "concurrencyMode": "cloud",
 "subscriptionPeriod": 0,
 "subscriptionEndDate": null,
 "subscriptionLastActivated": "2018-09-11T08:52:34.467Z",
 "maintenanceEndDate": "2019-01-01T00:00:00Z",
 "created": "2016-08-19T01:43:29Z",
 "modified": "2016-10-25T08:46:43.99Z",
 "features": [
             {
             "featureCode": "FEAT2",
             "featureAvailability": "ON",
             "featureType": "Floating",
             "featureDetails": [
                               "maximumActive : 7",
                               "totalActive : 0"
                               ]
             },
             {
             "featureCode": "TOKEN",
             "featureAvailability": "ON",
             "featureType": "ConsumptionToken",
             "featureDetails": [
                               "tokenLimit : 100",
                               "tokenCount : 20"
                               ]
             }
             ],
"applicationAgility": [
             {
             "name": "TEST1",
             "value": "AAFieldvalue1"
             }
             ],
"serverFunctions": [
                   {
                   "functionName": "LTCO",
                   "enabled": "ON",
                   "parameterValue": "15"
                   },
                   {
                   "functionName": "FeatureAvailability",
                   "enabled": "ON",
                   "parameterValue": ""
                   },
                   {
                   "functionName": "Otherfunc",
                   "enabled": "OFF",
                   "parameterValue": ""
                   }
                   ]
 }
]

GET Products

Accessible API Keys	WebAPI READ-ONLY, WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:
None

Output -

one or more sets of:

productName		string	Name of product.
productId		string	ID of product.
clientLeasePeriod		int	Client lease period (Trial) in hours.
vmLeasePeriod		int	Virtual machine lease period in hours (0=unlimited).
clientOfflineLeasePeriod		int	Client offline lease period in hours.
trialPeriod		int	Trial Period in days.
licenseType		string	The license type - Perpetual, SubscriptionPeriod or ExpirationDate.
clientsAllowed		int	Number of clients allowed.
features (for each feature)	featureCode	string	The feature code.
	featureName	string	The feature name.
	featureAvailability	string	Availability of the feature - ON or OFF.
	featureType	string	The feature type - Normal, Floating, Element Pool, Consumption Tokens or SecureStore.
	featureNotes	string	The feature notes.
	featureGroup	string	The feature group name to which the feature is assigned.
applicationAgility (for each AA)	name	string	Application Agility variable field name.
applicationAgility (for each AA)	value	string	The set value for the Application Agility field.

Example Output

[
 {
  "productName": "Product A 0105",
  "productId": "6872450105",
  "clientLeasePeriod": 24,
  "vmLeasePeriod": 0,
  "clientOfflineLeasePeriod": 24,
  "trialPeriod": 4,
  "licenseType": "perpetual",
  "clientsAllowed": 10,
  "features": [
              {
              "featureCode": "FEAT1",
              "featureAvailability": "OFF",
              "featureType": "ElementPool",
              "featureName": "Example Feature 1",
              "featureNotes": "Example Feature 1",
              "featureGroup": "Default"
              },
              {
              "featureCode": "FEAT2",
              "featureAvailability": "ON",
              "featureType": "Floating",
              "featureName": "Example Feature 2",
              "featureNotes": "Example Feature 2",
              "featureGroup": "Group2"
              },
              {
              "featureCode": "FEAT5",
              "featureAvailability": "ON",
              "featureType": "Normal",
              "featureName": "Example Feature 3",
              "featureNotes": "Example Feature 3",
              "featureGroup": "Default"
              }
              ],
"applicationAgility": [
             {
             "name": "TEST1",
             "value": "Prod1Default"
             },
             {
             "name": "TEST2",
             "value": "Prod1Default2"
             }
             ]
 },
 {
  "productName": "Product 2A",
  "productId": "3659400101",
  "clientLeasePeriod": 48,
  "vmLeasePeriod": 0,
  "clientOfflineLeasePeriod": 408,
  "trialPeriod": 30,
  "licenseType": "Perpetual",
  "clientsAllowed": 10,
  "features": [
              {
              "featureCode": "tfeat",
              "featureAvailability": "ON",
              "featureType": "Floating",
              "featureName": "Example Feature 4",
              "featureNotes": "Example Feature 4",
              "featureGroup": "Default"
              }
              ],
 "applicationAgility": [
              {
              "name": "Test",
              "value": "Prod2Default"
              }
              ]
 }
]

GET Product

Accessible API Keys	WebAPI READ-ONLY, WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

productId*	string	Product in question.

Output

productName		string	Name of product.
productId		string	ID of product.
clientLeasePeriod		int	Client lease period (Trial) in hours.
vmLeasePeriod		int	Virtual machine lease period in hours (0=unlimited).
clientOfflineLeasePeriod		int	Client offline lease period in hours.
trialPeriod		int	Trial Period in days.
licenseType		string	The license type - Perpetual, SubscriptionPeriod or ExpirationDate.
clientsAllowed		int	Number of clients allowed.
features (for each feature)	featureCode	string	The feature code.
	featureName	string	The feature name.
	featureAvailability	string	Availability of the feature - ON or OFF.
	featureType	string	The feature type - Normal, Floating, Element Pool, Consumption Tokens or SecureStore.
	featureNotes	string	The feature notes.
	featureGroup	string	The feature group name to which the feature is assigned.
applicationAgility (for each AA)	name	string	Application Agility variable field name.
applicationAgility (for each AA)	value	string	The set value for the Application Agility field.

Example Input URL format:

Input data from request URI

https://my.nalpeiron.com/api/v2/product?productId=6872450105

Example Output

[
 {
  "productName": "Product A 0105",
  "productId": "6872450105",
  "clientLeasePeriod": 24,
  "vmLeasePeriod": 0,
  "clientOfflineLeasePeriod": 24,
  "trialPeriod": 4,
  "licenseType": "perpetual",
  "clientsAllowed": 10,
  "features": [
              {
              "featureCode": "FEAT1",
              "featureAvailability": "OFF",
              "featureType": "ElementPool",
              "featureName": "Example Feature 1",
              "featureNotes": "Example Feature 1",
              "featureGroup": "Default"
              },
              {
              "featureCode": "FEAT2",
              "featureAvailability": "ON",
              "featureType": "Floating",
              "featureName": "Example Feature 2",
              "featureNotes": "Example Feature 2",
              "featureGroup": "Group2"
              },
              {
              "featureCode": "FEAT5",
              "featureAvailability": "ON",
              "featureType": "Normal",
              "featureName": "Example Feature 5",
              "featureNotes": "Example Feature 5",
              "featureGroup": "Default"
              }
              ],
"applicationAgility": [
             {
             "name": "TEST1",
             "value": "Prod1Default"
             },
             {
             "name": "TEST2",
             "value": "Prod1Default2"
             }
             ]
 }
]

POST Product

Accessible API Keys	WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

productName*		string	New Product Name.
inTrial		string	Is the product in Trial - Must be either true or false. Default (if omitted) - false
clientLeasePeriod		int	Client lease period in hours (max 8760). Default (if omitted) - 0.
clientOfflineLeasePeriod		int	Client Offline lease period in days (max 500). Default (if omitted) - 0.
vmLeasePeriod		int	Virtual machine lease period in hours (max 500) (0=unlimited). Default (if omitted) - 0.
trialPeriod		int	Product trial period in days (for product in trial). If omitted and the product is in Trial - default 30 days.
licenseType		string	The license type - Must be either perpetual, subscriptionperiod or expirationdate. Default (if omitted) - perpetual.
clientsAllowed		int	Number of clients allowed. Must be between 1 and 50000. Default (if omitted) - 1.
subscriptionPeriod		int	Subscription period in days (for subscriptionperiod licensetype). Default (if omitted) - 0. This field is validated only for subscriptionperiod licensetype.
subscriptionEndDate		datetime	Subscription end date (Required and validated only for expirationdate licensetype).
featureGroups (for each feature group)	featureGroupName	string	New feature group name to be created [Mandatory].
featureGroups (for each feature group)	notes	string	Feature Group Notes.
features (for each feature)	featureName	string	New feature name/title [Mandatory].
	featureCode	string	New unique feature code/ID [Mandatory].
	notes	string	Feature Notes [Mandatory].
	featureType	string	The feature type - Must be either normal, floating, elementpool, consumptiontokens or securestore. Default (if omitted) - Normal.
	featureGroupName	string	Feature Group to which the feature must be assigned. Default (if omitted) - Default group.
	availableInTrials	string	Is the feature available in trials - Must be either true or false. (Only for the 'Normal' feature type the AvailableInTrials parameter can be set to 'true'). Default (if omitted) - false.
applicationAgility (for each AA)	name	string	New Application agility variable field name [Mandatory].
applicationAgility (for each AA)	value	string	Value for the application agility field.

Output:

"Product Created Successfully. The new ProductID is <ProductID>" or error message.

Example Input:

Input data from request body.

Data - raw:

{
"productName": "APITest 0110",
"clientLeasePeriod": "2",
"vmLeasePeriod": "1",
"clientOfflineLeasePeriod": "1",
"clientsAllowed":"2",
"inTrial":"true",
"trialPeriod":"10",
"licenseType": "subscriptionPeriod",
"subscriptionPeriod": 100,
"featureGroups": [
{
"featureGroupName": "groupAPI1",
"notes": "groupAPI1"
},
{
"featureGroupName": "groupAPI2",
"notes": "groupAPI2"
},
{
"featureGroupName": "groupAPI3"
}
],
"features": [
{
"featureCode": "FEAT1API01",
"featureName": "featureAPI1",
"notes":"featureAPI1",
"featureType": "normal",
"featureGroupName": "groupAPI1",
"availableInTrials":"true"
},
{
"featureCode": "FEAT2API02",
"featureName": "featureAPI2",
"featureType": "ConsumptionTokens",
"notes":"featureAPI2",
"featureGroupName": "groupAPI2"
},
{
"featureCode": "FEAT3API03",
"featureName": "featureAPI3",
"featureType": "floating",
"notes":"featureAPI3"
},
{
"featureCode": "FEAT3API04",
"featureName": "featureAPI4",
"notes":"featureAPI4"
}
],
"applicationAgility": [
{
"name": "TEST1",
"value": "udf1"
},
{
"name": "TEST2",
"value": "udf2"
}
]
}

Example Output

{

"message": "Product Created Successfully. The new ProductID is 6872450105"

}

PUT Product

Accessible API Keys	WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

productId*	string	Product in question.
productName	string	New unique product name.
clientLeasePeriod	int	Client lease period in hours (max 8760).
vmLeasePeriod	int	Virtual machine lease period in hours (max 500) (0=unlimited).
clientOfflineLeasePeriod	int	Client offline lease period in days (max 500).
trialPeriod	int	Product trial period in days.
clientsAllowed	int	Number of clients allowed. Must be between 1 and 50000.
licenseType	string	The license type - Must be either perpetual, subscriptionperiod or expirationdate. Note: this must be included whenever the license type is changed, including from SubscriptionPeriod to ExpirationDate and vice versa.
subscriptionPeriod	int	Subscription period in days (for subscriptionPeriod licensetype). Please supply the licensetype to update the subscription period. This field is validated only for subscriptionPeriod licensetype.
subscriptionEndDate	datetime	Subscription end date (for expirationDate licensetype). Please supply the licensetype to update the subscription end date. To set to null, the input should be 'reset'. Otherwise this field is validated only for expirationDate licensetype.

Output:

"Product Updated Successfully" for correctly updated or error description.

If there is any error description, the product update has failed and none of the details are updated.
For the fields that are not included (omitted), the original field values will stay the same as before the call.

Example Input:

Input data from request body.

Data - raw:

{
 "productId": "6872450105",
 "clientLeasePeriod":"48",
 "trialPeriod":"10",
 "licenseType":"perpetual"
}

Example Output

{

"message": "Product Updated Successfully"

}

POST ProductFeatureGroups

Accessible API Keys	WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

productId*		string	Product in question.
featureGroups (for each feature group)	featureGroupName*	string	The new feature group name to be created [Mandatory].
featureGroups (for each feature group)	notes	string	The feature group notes.

Output:

"Product FeatureGroups Created Successfully" or error description.

Example Input:

Input data from request body.

Data - raw:

{
 "productId": "6872450105",
 "featureGroups":[
                {
                 "featureGroupName":"testgroup1",
                 "notes":"test"
                },
                {
                 "featureGroupName":"testgroup2"
                }
                ]
}

Example Output

{

"message": "Product FeatureGroups Created Successfully"

}

PUT ProductFeatureGroups

Accessible API Keys	WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

productId*		string	Product in question.
featureGroups (for each feature group)	featureGroupName*	string	Name of the feature group to be updated [Mandatory].
	newFeatureGroupName	string	New feature group name (Omit to not update existing group name).
	notes	string	The feature group notes (Omit to not update existing notes).

Output:

"Product FeatureGroups Updated Successfully" or error description.

Example Input:

Input data from request body.

Data - raw:

{
 "productId": "6872450105",
 "featureGroups":[
                {
                 "featureGroupName":"testgroup1",
                 "newFeatureGroupName":"group1"
                },
                {
                 "featureGroupName":"testgroup2",
                 "notes":"test notes"
                }
                ]
}

Example Output

{

"message": "Product FeatureGroups Updated Successfully"

}

DELETE ProductFeatureGroups

Accessible API Keys	WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

productId*	string	Product in question.
featureGroupName*	string	Name of the feature group to be deleted.

Output:

"Product FeatureGroup Deleted Successfully" or error description.

Example Input URL format:

Input data from request URI

https://my.nalpeiron.com/api/v2/productfeaturegroups?productId=6453300110&featureGroupName=testgroup

Example Output

{

"message": "Product FeatureGroup Deleted Successfully"

}

POST ProductFeatures

Accessible API Keys	WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

productId*		string	Product in question.
features (for each feature)	featureCode*	string	The feature code to be created [Mandatory].
	featureName*	string	The feature name [Mandatory].
	notes*	string	The feature notes [Mandatory].
	featureType	string	The feature type. Must be either normal, floating, elementPool, consumptionTokens or secureStore. Default (if omitted) - normal.
	featureGroupName	string	Feature Group to which the feature must be assigned. Default (if omitted) - Default group.
	availableInTrials	string	Is the feature available in trials - Must be either true or false. (Only for the 'normal' feature type the availableInTrials parameter can be set to 'true'). Default (if omitted) - false.

Output:

"Product Features Created Successfully" or error description.

Example Input:

Input data from request body.

Data - raw:

{
 "productId": "6872450105",
 "features": [
            {
                "featureCode": "FEAT1API01",
                "featureName": "featureAPI1",
                "notes": "featureAPI1",
                "featureGroupName": "groupAPI1",
                "availableInTrials": "true"
            },
            {
                "featureCode": "FEAT2API03",
                "featureName": "featureAPI2",
                "notes": "featureAPI2",
                "featureType": "consumptionTokens"
            }
             ]
}

Example Output

{

"message": "Product Features Created Successfully"

}

PUT ProductFeatures

Accessible API Keys	WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

productId*		string	Product in question.
features (for each feature)	featureCode*	string	The code of the feature to be updated [Mandatory].
	newfeatureCode	string	The new feature code to update. Omit to not update existing featureCode.
	featureName	string	The new feature name. Omit to not update existing featureName.
	notes	string	The new feature notes. Omit to not update existing feature notes.
	featureGroupName	string	The new feature group to which the feature must be assigned. Omit to not update existing featuregroup assignment. Set to 'default' to assign to default group.
	availableInTrials	string	Is the feature available in trials - Must be either true or false. (Only for the 'normal' feature type the availableInTrials parameter can be set to 'true'). Default (if omitted) - false.

Output:

"Product Features Updated Successfully" or error description.

Example Input:

Input data from request body.

Data - raw:

{
 "productId": "6872450105",
 "featureGroups":[
                {
                 "featureCode": "FEAT1API01",
                 "newFeatureCode": "FEAT101",
                 "featureName": "featureAPI1",
                 "notes": "featureAPI1 updated",
                 "featureGroupName": "default",
                 "availableInTrials": "true"
                },
                {
                 "featureCode": "FEAT1API02",
                 "newFeatureCode": "FEAT102"
                }
                ]
}

Example Output

{

"message": "Product Features Updated Successfully"

}

DELETE ProductFeatures

Accessible API Keys	WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

productId*	string	Product in question.
featureCode*	string	Code of the feature to be deleted.

Output:

"Product Feature Deleted Successfully" or error description.

Example Input URL format:

Input data from request URI

https://my.nalpeiron.com/api/v2/productfeatures?productId=6453300110&featureCode=FEAT101

Example Output

{

"message": "Product Feature Deleted Successfully"

}

POST ProductApplicationAgility

Accessible API Keys	WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

productId*		string	Product in question.
applicationAgility (for each AA)	name*	string	Application agility variable field name [Mandatory].
applicationAgility (for each AA)	value	string	Value for the application agility field.

Output:

"Product ApplicationAgility Created Successfully" or error description.

Example Input:

Input data from request body.

Data - raw:

{
 "productId": "6872450105",
 "applicationAgility":[
            {
                "name": "TEST1",
                "value":"udf1"
            },
            {
                "name": "TEST2"
            } 
             ]
}

Example Output

{

"message": "Product ApplicationAgility Created Successfully"

}

PUT ProductApplicationAgility

Accessible API Keys	WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

productId*		string	Product in question.
applicationAgility (for each AA)	name*	string	The field name of the Application Agility to be updated [Mandatory].
	newName	string	The new Application Agility field name. Omit to not update existing field name.
	value	string	The new Value for the application agility field. Omit to not update existing value.

Output:

"Product ApplicationAgility Updated Successfully" or error description.

Example Input:

Input data from request body.

Data - raw:

{
"productId": "6872450105",
"applicationAgility":[
            {
                "name": "TEST1",
                "value":"udf1updated"
            },
            {
                "name": "TEST2",
                "newName": "Test3"
            } 
]
}

Example Output

{

"message": "Product ApplicationAgility Updated Successfully"

}

DELETE ProductApplicationAgility

Accessible API Keys	WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

productId*	string	Product in question.
name*	string	The field name of the Application Agility to be deleted [Mandatory].

Output:

"Product ApplicationAgility Deleted Successfully" or error description.

Example Input URL format:

Input data from request URI

https://my.nalpeiron.com/api/v2/productApplicationAgility?productId=6453300110&name=test3

Example Output

{

"message": "Product ApplicationAgility Deleted Successfully"

}

GET NextLicenseCode

Accessible API Keys	WebAPI READ-ONLY, WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

productId*	string	Product in question.
amount	int	Number of license codes to return. Default (if omitted) - 1.
profileName	string	Profile name of license codes to return. If omitted, license codes with the default profile will be returned.

Output

List of license code(s), which have not been used (no activity) and have not been chosen before via webservices. Once a license code has been obtained in this manner, it will be flagged as 'Used by Webservices' on the codeedit page. It will not be retrieved again while it remains flagged as such, and the flag can be changed manually on this page.

Example Input URL format:

Input data from request URI

https://my.nalpeiron.com/api/v2/nextlicensecode?productId=6453300110&amount=2

Example Output

{

"message": "268400357100474509,276300357113980114"

}

GET ActivatedLicenseCodes

Accessible API Keys	WebAPI READ-ONLY, WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

computerId*	string	ComputerID of activity.

Output -

one or more sets of:

productId		string	productID to which the license code is assigned.
licenseCode		string	Activated license code.

Example Input URL format:

Input data from request URI

https://my.nalpeiron.com/api/v2/activatedlicensecodes?computerId=BLXRrZJ5T9imK7qPrJSL

Example Output

[
 {
  "productId": "6872450105",
  "licenseCode": "206454320110930859"
 },
 {
  "productId": "6872450105",
  "licenseCode": "286901020157066211"
 }
]

GET LicenseCodeActivity

Accessible API Keys	WebAPI READ-ONLY, WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

productId*	string	Product in question.
licenseCode*	string	License code in question.
activated	int	Set to 1 to show only current activations. Must be either 1 or 0 - default (if omitted) - 0. (optional)
getSysInfo	int	Set to 1 to retrieve system information. Must be either 1 or 0 - default (if omitted) - 0. (optional)
pageNumber	int	PageNumber must be >= 0. If Omitted returns all records. (optional) If 0 returns record count.
pageSize	int	Number of records per page. Must be between 1 and 10000. (default 10000) If supplied must be passed with pageNumber Parameter. (optional)

Output -

Empty (if no activity) or (depending on activity) one or more sets of:

licenseCode	string	Licensecode in question.
computerId	string	ComputerID of activity.
systemInfo	string	If getsysinfo=1, gets system information.
status	string	Activated or Deactivated.
vmLeasePeriod	int	Virtual machine lease period in hours (0=unlimited).
clientLeaseEndDate	datetime	Client lease end date.
leaseLastDate	datetime	Lease last date.
vmPlatform	string	Virtualisation platform (hypervisor) hosting the virtual machine.
userName	string	Group username.
activated	datetime	Activation datetime.
deactivated	datetime	Deactivation datetime.
count	int	Record count - total or just activations depending on value of activated flag. Returned when and only when pageNumber=0.

Example Input URL format:

Input data from request URI

https://my.nalpeiron.com/api/v2/licensecodeactivity?productId=6872450105&licenseCode=206454320110930859&activated=1&getSysInfo=1

Example Output (pageNumber!=0)

{
 "licenseCode": "206454320110930859",
 "computerId": "kQe0MRH12bYgemkYW2bc",
 "systemInfo": {
               "computerId": "kQe0MRH12bYgemkYW2bc",
               "operatingSystem": "Microsoft Windows 10 Home Edition 16299, 64-bit",
               "bitage": "64",
               "screenResX": "1920",
               "screenresy": "1080",
               "processor": "GenuineIntel:Intel(R) Core(TM) i7-4500U CPU @ 1.80GHz",
               "cores": "4",
               "memory": "8090",
               "oslanguage": "en-GB",
               "applanguage": "en-GB",
               "type": "",
               "licensestatus": "Activated",
               "version": "2",
               "build": "2",
               "edition": "ENT",
               "computername": "Work_Laptop",
               "vmplatform": "Physical"
               },
 "status": "ACTIVATED",
 "vmLeaseperiod": 0,
 "clientleaseenddate": "2018-01-22T11:28:55.56Z",
 "leaseLastDate": "2018-02-28T14:19:49.43Z",
 "vmPlatform": "",
 "username": "",
 "activated": "2018-01-01T00:00:00Z",
 "deactivated": null
}

Example Output (pageNumber=0)

[
    {
        "count": 5
    }
]

PUT LicenseCodeActivity

Accessible API Keys	WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

productId*	string	Product in question.
licenseCode*	string	License code in question.

Output

"License Code Status Set to 'Returned' Successfully" or error message.

Example Input:

Input data from request body.

Data - raw:

{
 "productId": "6872450105",
 "licenseCode": "206454320110930859"
}

Example Output

{

"message": "License Code Status Set to 'Returned' Successfully"

}

DELETE LicenseCodeActivity

Deletes Activity Associated with the provided License Code

Accessible API Keys	WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

productId*	string	ProductID in question.
licenseCode*	string	License code in question.
computerId	string	ID of computer in question (optional). If omitted, all activity associated with the supplied licence code will be deleted.

Output

"License Code Activity Deleted Successfully" or error message.

Example Input URL format:

Input data from request URI

https://my.nalpeiron.com/api/v2/licensecodeactivity?productId=6872450105&licenseCode=206454320110930859&computerId=BLXRrZJ5T9imK7qPrJSL

Example Output

{

"message": "License Code Activity Deleted Successfully"

}

GET LicenseCodesByOrderID

Accessible API Keys	WebAPI READ-ONLY, WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

orderId*	string	OrderId in question.

Output -

Returns all license codes that contains the supplied orderId string.

One or more sets of:

productId	string	ProductID of the license code linked to the orderId.
licenseCode	string	LicenseCode linked to the orderId.
orderId	string	orderId linked to the license code.

Example Input URL format:

Input data from request URI

https://my.nalpeiron.com/api/v2/LicenseCodesByOrderID?orderid=orderid_4

Example Output

[
{
"productId": "2254900117",
"licenseCode": "274559757587509623",
"orderId": "orderId_4"
},
{
"productId": "3254900110",
"licenseCode": "258796391844808232",
"orderId": "orderId_4"
},
{
"productId": "2254900117",
"licenseCode": "368761555058332840",
"orderId": "orderId_44"
},
{
"productId": "4254904517",
"licenseCode": "285480181814807482",
"orderId": "orderId_41_12"
}
]

POST PassiveLicense

Accessible API Keys	WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

productId*		string	ProductID in question.
clientId*		string	Client ID associated with client machine. Must be at least 10 and less than 256 characters long.
companyId		int	ID of the company to which the license is to be assigned (optional). Omit to not assign to any company (set to 0) - default - 0.
profileName		string	Sets the code profile (if omitted or 'default' = none/default).
features (for each feature)	featureCode	string	The feature code of the feature to be enabled.
applicationAgility (for each AA)	name	string	Application Agility variable field name.
applicationAgility (for each AA)	value	string	The set value for the Application Agility field.

Output

Client activation certificate for correct definition or error description.

Example Input:

Input data from request body.

Data - raw:

{
  "productId": "6872450105",
  "clientId":"3487abcdefgh12345",
  "profileName":"testingProfile",
  "companyId":17,
  "features": [
              {
              "featureCode": "FEAT1"
              },
              {
              "featureCode": "FEAT2"
              }
              ],
"applicationAgility": [
             {
             "name": "TEST1",
             "value": "Prod1Default"
             },
             {
             "name": "TEST2",
             "value": "Prod1Default2"
             }
             ]
}

Example Output

"Passive License Created Successfully. 
f0cfb35093cebef123a198c0db25b05244e051a6718888dfd0a3d78eb496da6e977888af72c020551c5ec7d77f614e0060a0434f3528e0d5a6f594e5d162013894adf868bbc574650e38295af4ede5d1b8d130df0876930a88b2583204a19a3f225038b24cd1904b469c1958ba92794a7ac1d5df6bf83aec005ef4482fde7650c1895ff1a3eb0ab0b9f24cb7b9c6478347fd29d000cbc641571fea142adb605883788c5024b02d99d9b8c7dbd77c67f1e5ce6a8fc9d400c4d81447d8bb409d9812936962b845e1c476bfec9cc67a05ecd2f0fec7a9111878a9b3ab742ab36e722547d7568ab46a92f7c06c903645c390b9fcfe5415afc76ad85f9d8332a7b45af7150e7f4a18113949ffbd2b9869c27ccf211c9fdf2f53c3f357ef672368fa09e13618d315a6445b5a002993233b111270b94ed1127254ba888b313fd03381c0b1e81bea969fa27565bb69813cd3bb2c76011131a05c2c35215db3b4bd83b286a2bb6d7327fa3e0f8eeed1c76e3f6d4ea65b3c1c7e3f6f27398b39e3ff08787d3f85d622ee9451c7dda55c21086398dfebfe166d113a1904fb13dc968d92757714890f16fc5c086abf268c47251f72e7f1b23cb984acf37f53814edf5b4ffb3c8676823499512f04e3c90d9b0ed1a53b7c18af9dd05d16062f9b29494e9ed9219d9988dd0e3e17a60bf58d9eddedcef77a89d68f19af4f9f150b930089e4edf615c559ef1c5a6fba0369566e7f5173541f3290a69c7bfa09f4c2cc74b8b138c0d66401576db49b549b6b636d1c97e9480184575dd29a06d17909ca18680b986b88564ff89be9cbad679758ff3db8a546aada148a84bb58f9772aa13d1abf606b0bb9a82e1db28ae78bfa75be1901c27f666709366dc8afbc459f506ec6413674c96e11303ed5eb202535d4d674b3e15ef8ac8b93e826ba194d448a87f2e5525f96911b8e6724f4ec8dcba80df03e237cd65271ff82e5d7a4"

POST NetworkMasterLicense

Accessible API Keys	WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

productId*	string	ProductID in question.
companyId	int	ID of the company to which the license is to be assigned (optional). Omit to not assign to any company (set to 0) - default - 0.

Output

"NetworkMasterLicense Created Successfully" or error message.

Example Input:

Input data from request body.

Data - raw:

{
 "productId": "6872450105",
 "companyId": "17"
}

Example Output

{

"message": "NetworkMasterLicense Created Successfully. 324670604425507942"

}

GET NetworkMasterLicense

Accessible API Keys	WebAPI READ-ONLY, WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

licenseCode*	string	License code in question. All satisfying other conditions are returned if omitted (optional.)
company	string	ID of the company to which the license code has been assigned (optional.)
companyID	int	Name of the company to which the license code has been assigned. 0 for no company. Omit for all companies (optional.)
pageNumber	int	PageNumber must be >= 0. If Omitted returns all records. If 0 returns record count (optional.)
pageSize	int	Number of records per page. Must be between 1 and 10000. (default 10) If supplied must be passed with pageNumber Parameter (optional.)

Output -

Network master licenses for the LAN Daemon subject to input filters

networkLicense	string	License code in question.
maxUsers	string	Maximum number of users (i.e. LAN daemon installations) of this license code.
currentUsers	string	Current number of users (i.e. LAN daemon installations) of this license code.
company	int	Company/customer to which LAN daemon has been assigned.
created	string	Creation date of license code.
activated	datetime	Activation datetime.
deactivated	datetime	Deactivation datetime.
computerID	string	Computer ID of activated LAN Daemon
count	int	Record count. Returned when and only when pageNumber=0.

Example Input URL format:

Input data from request URI

https://my.nalpeiron.com/api/v2/NetworkMasterLicense?ShaferCompanyID=0&LicenseCode=362300000729269708

Example Output (pageNumber!=0)

[
    {
        "networkLicense": "362300000729269708",
        "maxUsers": 1, 
        "currentUsers": 1,
        "shaferCompany": "",
        "activated": "2018-02-13T17:08:47Z",
        "deactivated": null,
        "created": "2018-01-31T00:00:00Z",
        "computerID": "YgLzBAo0+laxPN1jPKbt"
    },
]

Example Output (pageNumber=0)

[
    {
        "count": 5
    }
]

GET Profile

Accessible API Keys	WebAPI READ-ONLY, WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

productId*	string	ProductID in question.
profileName**	string	Name of the profile in question.
profileId**	int	ID of the profile in question.
getSfs	int	Get server functions (1=yes, 0 otherwise). Must be either 1 or 0 - default (if omitted) - 0.

**Either profileId or profileName must be supplied, not both.

Output

profileName		string	Name of the profile in question.
profileID		int	ID of the profile in question.
enabledForUse		string	Is the License enabled for use (true or false).
licenseType		string	The license type - Perpetual, SubscriptionPeriod or ExpirationDate.
clientsAllowed		int	Number of client activations allowed.
clientLeasePeriod		int	Client lease period in hours.
vmLeasePeriod		int	Virtual machine lease period in hours (0=unlimited).
clientOfflineLeasePeriod		int	Client offline lease period in hours.
acquiredByWebservice		string	Is the license codes acquired by GET NextLicenseCode webservice (true or false).
networkSeats		int	Number of network seats (LAN) (0-2147483647).
heartBeat		int	LAN daemon heartbeat (mins) (5-1440).
concurrentProcesses		int	Number of concurrent processes allowed (0=unlimited).
resellerId		int	ID of reseller to which profile is assigned (0=none).
concurrencyMode		string	Concurrency mode of the license code - off, cloud or network.
subscriptionPeriod		int	Subscription period in days.
subscriptionEndDate		datetime	Subscription end datetime.
maintenanceEndDate		datetime	Maintenance end datetime.
created		datetime	Profile created date.
modified		datetime	Profile last modified date.
features (for each feature)	featureCode	string	The feature code.
	featureAvailability	string	Availability of the feature - ON or OFF.
	featureType	string	The feature type - Normal, Floating, Element Pool, Consumption Tokens or SecureStore.
	featureDetails	string	MaximumActive/TotalActive=max seats/current seats checked out on floating feature. ElementLimit/ElementCount=max elements/current no. of elements checked out for element pool. TokenLimit/TokenCount=max tokens/current no. of tokens checked out for consumption tokens.
applicationAgility (for each AA)	name	string	Application Agility variable field name.
applicationAgility (for each AA)	value	string	The set value for the Application Agility field.
serverFunctions (for each server function)	functionName	string	Server function name.
	enabled	string	ON or OFF.
	parameterValue	int	The value of custom parameter.

Example Input URL format:

Input data from request URI

https://my.nalpeiron.com/api/v2/profile?productId=6453300110&profileName=TestProfile&getSfs=1

Example Output

[
 {
   "profileName": "TestProfile",
   "profileId": 12,
   "enabledForUse": "true",
   "licenseType": "perpetual",
   "clientsAllowed": 2,
   "clientLeasePeriod": 12,
   "vmLeasePeriod": 0,
   "clientOfflineLeasePeriod": 8760,
   "acquiredByWebservice": "true",
   "networkSeats": 0,
   "heartBeat": 0,
   "concurrentProcesses": 15,
   "resellerId": 0,
   "concurrencyMode": "off",
   "subscriptionPeriod": 0,
   "subscriptionEndDate": null,
   "maintenanceEndDate": "2022-04-30T00:00:00",
   "created": "2021-01-20T11:08:08.373",
   "modified": "2021-01-20T11:08:08.373",
   "features": [
               {
                "featureCode": "EPOOL",
                "featureAvailability": "ON",
                "featureType": "ElementPool",
                "featureDetails": [
                                  "elementLimit : 1000",
                                  "elementCount : 10"
                                  ]
               },
               {
                "featureCode": "FLOAT",
                "featureAvailability": "ON",
                "featureType": "Floating",
                "featureDetails": [
                                  "maximumActive : 100",
                                  "totalActive : 10"
                                  ]
               },
               {
                "featureCode": "FEAT5",
                "featureAvailability": "OFF",
                "featureType": "Normal",
                "featureDetails": []
               }
               ],
  "applicationAgility": [
               {
                "name": "TEST1",
                "value": "6"
               },
               {
                "name": "TEST2",
                "value": "test"
               }
               ],
  "serverFunctions": [
                     {
                      "functionName": "LTCO",
                      "enabled": "ON",
                      "parameterValue": "20"
                     },
                     {
                      "functionName": "FeatureAvailability",
                      "enabled": "ON",
                      "parameterValue": ""
                     },
                     {
                      "functionName": "Otherfunc",
                      "enabled": "ON",
                      "parameterValue": "10"
                     }
                     ]
 }
]

POST Profile

Accessible API Keys	WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

productId*		string	Product in question.
profileName*		string	New unique name of profile.
clientLeasePeriod		int	Client lease period in hours (max 8760). Default (if omitted) - 0.
clientOfflineLeasePeriod		int	Client Offline lease period in days (max 500). Default (if omitted) - 0.
vmLeasePeriod		int	Virtual machine lease period in hours (max 500) (0=unlimited). Default (if omitted) - 0.
enabledForUse		string	Is the license codes in profile enabled for use (true or false). Must be either true or false - default (if omitted) - false.
licenseType		string	The license type - Must be either perpetual, subscriptionperiod or expirationdate. Default (if omitted) - perpetual.
clientsAllowed		int	Number of clients allowed. Must be between 0 and 50000. Default (if omitted) - 0.
acquiredByWebservice		string	Is the license codes in profile acquired by GET NextLicenseCode webservice (true or false). Must be either true or false - default (if omitted) - false.
subscriptionPeriod		int	Subscription period in days. Default (if omitted) - 0. This field is validated only for subscriptionPeriod licenseType.
subscriptionEndDate		datetime	Subscription end date. This field is validated only for expirationDate licenseType.
maintenanceEndDate		datetime	Maintenance end date.
concurrentProcesses		int	Number of concurrent processes allowed (0= unlimited). Default (if omitted) - 0.
concurrencyMode		string	Concurrency type - Must be either off, cloud or network. Default (if omitted) - off (none).
networkSeats		int	Number of network seats (LAN) (0-2147483647). Default (if omitted) - 0.
heartBeat		int	LAN daemon heartbeat (mins) (5-1440). Default (if omitted) - 5 (for network concurrency mode).
reseller		string	Name of reseller to which profile is to be assigned. Default (if omitted) - none.
features (for each feature)	featurecode	string	The feature code.
	featureAvailability	string	Set to on/off to enable/disable the feature for the license codes in profile. Must be either on or off.
	limit	int	Limit attribute applies to floating features and element pools, for which it respectively sets the maximum number of seats and the maximum number of elements available to the license codes in profile.
applicationAgility (for each AA)	name	string	Application agility variable field name.
applicationAgility (for each AA)	value	string	Value for the application agility field.
serverFunctions (for each server function)	functionName	string	Server function name.
	enabled	string	Set to on/off to enable/disable the server function for the license codes in profile. Must be either on or off.
	parameterValue	int	The value of custom parameter. Currently, only one editable server function has been implemented - Long-Term CheckOut License with function name 'LTCO'. The value must be the integer value of the maximum check-out period in days (0 - 2147483647).

Output:

"Profile Created Successfully. The new Profile ID is <new profile ID>" or error message.

Example Input:

Input data from request body.

Data - raw:

{
"productId":"6453300110",
"profileName": "Test Profile",
"enabledForUse": "true",
"licenseType": "Perpetual",
"clientsAllowed": "2",
"clientLeasePeriod": "0",
"vmLeasePeriod": "0",
"clientOfflineLeasePeriod": "1",
"acquiredByWebservice": "true",
"concurrentProcesses": "0",
"concurrencyMode":"network",
"networkSeats":"1",
"heartBeat": "5",
"reseller":"reseller12",
"subscriptionPeriod": "0",
"maintenanceEndDate": "2020-10-10T00:12:00",
"features": [
            {
             "featurecode": "FEAT1",
             "featureAvailability": "on",
             "limit": "10"
            },
            {
             "featurecode": "EPOOL",
             "featureAvailability": "on",
             "limit": "15"
            }
            ],
"applicationAgility": [
             {
              "name": "TEST1",
              "value": "udf1"
             },
             {
              "name": "TEST2",
              "value": "udf2"
             }
             ],
"serverFunctions": [
                   {
                    "functionName": "LTCO",
                    "enabled": "on",
                    "parameterValue": "20"
                   },
                   {
                    "functionName": "Otherfunc",
                    "enabled": "off"
                   }
                   ]
}

Example Output

{

"message": "Profile Created Successfully. The new Profile ID is 369"

}

PUT Profile

Accessible API Keys	WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

productId*		string	Product in question.
profileName*		string	Name of the profile to be updated.
newProfileName		string	New unique name of profile.
clientLeasePeriod		int	Client lease period in hours (max 8760).
clientOfflineLeasePeriod		int	Client Offline lease period in days (max 500).
vmLeasePeriod		int	Virtual machine lease period in hours (max 500) (0=unlimited).
enabledForUse		string	Is the license codes in profile enabled for use (true or false). Must be either true or false.
licenseType		string	The license type - Must be either perpetual, subscriptionperiod or expirationdate. Note: this must be included whenever the license type is changed, including from SubscriptionPeriod to ExpirationDate and vice versa. Whenever licenseType is changed to 'SubscriptionPeriod', subscriptionPeriod parameter must be included. Whenever licenseType is changed to 'ExpirationDate', subscriptionEndDate parameter must be included.
clientsAllowed		int	Number of clients allowed. Must be between 0 and 50000.
acquiredByWebservice		string	Is the license codes in profile acquired by GET NextLicenseCode webservice (true or false). Must be either true or false.
subscriptionPeriod		int	Subscription period in days (mandatory for subscriptionperiod licensetype). Please supply the licensetype to update the subscription period. This field is validated only for subscriptionPeriod licenseType. Note: Whenever licenseType is changed to 'subscriptionPeriod', subscriptionPeriod parameter must be between 1 and 5000. To extend subscriptionPeriod duration days, subscriptionPeriod parameter must be between 1 and 1000.
subscriptionEndDate		datetime	Subscription end date (mandatory for ExpirationDate licensetype). Please supply the licensetype to update the subscription end date. To set to null, the input should be 'reset' (for licensetypes except ExpirationDate). Otherwise this field is validated only for ExpirationDate licenseType.
maintenanceEndDate		datetime	Maintenance end date. To set to null, the input should be 'reset'.
concurrentProcesses		int	Number of concurrent processes allowed (0= unlimited).
concurrencyMode		string	Concurrency type - Must be either off, cloud or network. Note: Whenever concurrencyMode is changed to 'network', networkSeats parameter and heartBeat parameter must be included.
networkSeats		int	Number of network seats (LAN) for 'network' 0-2147483647).
heartBeat		int	LAN daemon heartbeat (mins) (5-1440).
reseller		string	Name of reseller to which profile is to be assigned.
inheritProfile		string	License codes currently in profile to inherit updated profile properties (true or false). Must be either true or false. Default (if omitted) - false.
features (for each feature)	featureCode	string	The feature code.
	featureAvailability	string	Set to on/off to enable/disable the feature for the license codes in profile. Must be either on or off.
	limit	int	Limit attribute applies to floating features and element pools, for which it respectively sets the maximum number of seats and the maximum number of elements available to the license codes in profile.
applicationAgility (for each AA)	name	string	Application agility variable field name.
applicationAgility (for each AA)	value	string	Value for the application agility field.
serverFunctions (for each server function)	functionName	string	Server function name.
	enabled	string	Set to on/off to enable/disable the server function for the license codes in profile. Must be either on or off.
	parameterValue	int	The value of custom parameter. Currently, only one editable server function has been implemented - Long-Term CheckOut License with function name 'LTCO'. The value must be the integer value of the maximum check-out period in days (0 - 2147483647).

Output:

"Profile Updated Successfully" for correct update or error description.

If there is any error description, profile update has failed and none of the details are updated.
For the fields that are not included (omitted), the original field values will stay the same as before the call.

Example Input:

Input data from request body.

Data - raw:

{
"productId":"6453300110",
"profileName": "Test Profile",
"newProfileName": "New Profile",
"enabledForUse": "true",
"licenseType": "Perpetual",
"inheritProfile":"true",
"concurrentProcesses": "10",
"concurrencyMode":"cloud",
"subscriptionPeriod": "0",
"features": [
            {
             "featureCode": "FEAT1",
             "featureAvailability": "on",
             "limit": "10"
            },
            {
             "featureCode": "EPOOL",
             "featureAvailability": "off"
            }
            ],
"applicationAgility": [
             {
              "name": "TEST2",
              "value": "udf2"
             }
             ],
"serverFunctions": [
                   {
                    "functionName": "LTCO",
                    "enabled": "on",
                    "parameterValue": "10"
                   }
                   ]
}

Example Output

{

"message": "Profile Updated Successfully"

}

GET Profiles

Accessible API Keys	WebAPI READ-ONLY, WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

productId	string	Returns profiles for this productid (optional). Default - If omitted, returns profiles for all products.
pageNumber	int	If >0 then returns the results on that page. If 0 or omitted then returns only the number of profiles (count) (optional).
pageSize	int	Number of records per page (default and max. value=10000) (optional).
getSfs	int	Get server functions (1=yes, 0 otherwise). Must be either 1 or 0 - default (if omitted) - 0.

Output

If pageNumber parameter is 0 or omitted then returns only the count of profiles.

Else, returns one or more sets of:

productId		string	Associated ProductID.
profileName		string	Name of the profile.
profileID		int	ID of the profile.
enabledForUse		string	Is the License enabled for use (true or false).
licenseType		string	The license type - Perpetual, SubscriptionPeriod or ExpirationDate.
clientsAllowed		int	Number of client activations allowed.
clientLeasePeriod		int	Client lease period in hours.
vmLeasePeriod		int	Virtual machine lease period in hours (0=unlimited).
clientOfflineLeasePeriod		int	Client offline lease period in hours.
acquiredByWebservice		string	Is the license codes acquired by GET NextLicenseCode webservice (true or false).
networkSeats		int	Number of network seats (LAN) (0-2147483647).
heartBeat		int	LAN daemon heartbeat (mins) (5-1440).
concurrentProcesses		int	Number of concurrent processes allowed (0=unlimited).
resellerId		int	ID of reseller to which profile is assigned (0=none).
concurrencyMode		string	Concurrency mode of the license code - off, cloud or network.
subscriptionPeriod		int	Subscription period in days.
subscriptionEndDate		datetime	Subscription end datetime.
maintenanceEndDate		datetime	Maintenance end datetime.
created		datetime	Profile created date.
modified		datetime	Profile last modified date.
features (for each feature)	featureCode	string	The feature code.
	featureAvailability	string	Availability of the feature - ON or OFF.
	featureType	string	The feature type - Normal, Floating, Element Pool, Consumption Tokens or SecureStore.
	featureDetails	string	MaximumActive/TotalActive=max seats/current seats checked out on floating feature. ElementLimit/ElementCount=max elements/current no. of elements checked out for element pool. TokenLimit/TokenCount=max tokens/current no. of tokens checked out for consumption tokens.
applicationAgility (for each AA)	name	string	Application Agility variable field name.
applicationAgility (for each AA)	value	string	The set value for the Application Agility field.
serverFunctions (for each server function)	functionName	string	Server function name.
	enabled	string	ON or OFF.
	parameterValue	int	The value of custom parameter.

Example Input URL format:

Input data from request URI

https://my.nalpeiron.com/api/v2/profiles?pagenumber=1&pageSize=1&getSfs=1

Example Output

[
 {
   "productId": "6453300110",
   "profileName": "TestProfile",
   "profileId": 12,
   "enabledForUse": "true",
   "licenseType": "perpetual",
   "clientsAllowed": 2,
   "clientLeasePeriod": 12,
   "vmLeasePeriod": 0,
   "clientOfflineLeasePeriod": 8760,
   "acquiredByWebservice": "true",
   "networkSeats": 0,
   "heartBeat": 0,
   "concurrentProcesses": 15,
   "resellerId": 0,
   "concurrencyMode": "off",
   "subscriptionPeriod": 0,
   "subscriptionEndDate": null,
   "maintenanceEndDate": "2022-04-30T00:00:00Z",
   "created": "2021-01-20T11:08:08.373Z",
   "modified": "2021-01-20T11:08:08.373Z",
   "features": [
               {
                "featureCode": "EPOOL",
                "featureAvailability": "ON",
                "featureType": "ElementPool",
                "featureDetails": [
                                  "elementLimit : 1000",
                                  "elementCount : 10"
                                  ]
               },
               {
                "featureCode": "FLOAT",
                "featureAvailability": "ON",
                "featureType": "Floating",
                "featureDetails": [
                                  "maximumActive : 100",
                                  "totalActive : 10"
                                  ]
               },
               {
                "featureCode": "FEAT5",
                "featureAvailability": "OFF",
                "featureType": "Normal",
                "featureDetails": []
               }
               ],
  "applicationAgility": [
               {
                "name": "TEST1",
                "value": "6"
               },
               {
                "name": "TEST2",
                "value": "test"
               }
               ],
  "serverFunctions": [
                     {
                      "functionName": "LTCO",
                      "enabled": "ON",
                      "parameterValue": "20"
                     },
                     {
                      "functionName": "FeatureAvailability",
                      "enabled": "ON",
                      "parameterValue": ""
                     },
                     {
                      "functionName": "Otherfunc",
                      "enabled": "ON",
                      "parameterValue": "10"
                     }
                     ]
 }
]

GET ConsumerData

Accessible API Keys	WebAPI READ-ONLY, WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

productId*	string	Product ID in question.
computerId	string	Computer ID in question (optional).
justLast	string	Set to true or false according to whether or not only the most recent record should be returned. Only the most recent record - true. All records - false. Must be either true or false - default (if omitted) set to true.
type	string	Get consumer records for Trials, Activations or all. Must be either trials, activations or all. Default (if omitted) - all.
pageNumber	int	If >0 then returns the results on that page. If 0 or omitted then returns only the number of consumer records (count) (optional).
pageSize	int	Number of records per page (default and max. value=10000) (optional).
startDate	datetime	Gets the records created from the specified start date (optional).
endDate	datetime	Gets the records created until the specified end date (optional).

Output -

If pageNumber parameter is 0 or omitted then returns only the count of consumer records.

Else, returns one or more sets of:

productId	string	ID of the product.
computerId	string	ID of the computer associated with the activity.
licenseCode	string	Associated license code.
firstName	string	Consumer First name.
lastName	string	Consumer Last name.
company	string	Associated company name.
email	string	Consumer email.
clientInfo	JSON	Json metadata containing the consumer record.
created	datetime	Consumer record created date.

Example Input URL format:

Input data from request URI

https://my.nalpeiron.com/api/v2/consumerdata?productId=6872450105&justLast=true&type=activations&pageNumber=1&pageSize=2&startDate=2018-11-01&endDate=2019-03-30

Example Output

[
 {
  "productId": "6872450105",
  "computerId": "oLh+T3o+A39g5Sz/8Ug8",
  "licenseCode": "276439600252847932",
  "firstName": "Susanna",
  "lastName": "Baines",
  "company": "HeelToe Productions",
  "email": "susanna.baines@heeltoemedia.com",
  "clientInfo": "{\"firstname\":\"Susanna\",\"lastname\":\"Baines\",\"company\":\"HeelToe Productions\",\"sector\":\"Creative Media Production\",\"annual_revenue\":\"$3M\",\"email\":\"susanna.baines@heeltoemedia.com\",\"telephone\":\"+1 888 800 8818\"}",
  "created": "2018-11-16T06:12:44.883Z"
 },
 {
  "productId": "6872450105",
  "computerId": "P5oSK0sA6aH1lCpfSTgV",
  "licenseCode": "298537600274878402",
  "firstName": "Mark Vincent",
  "lastName": "Danston",
  "company": "Ultrabrake Racing LLC",
  "email": "m.danston@ultrabrake.com",
  "clientInfo": "{\"firstname\":\"Mark Vincent\",\"middlename\":\"Dave\",\"lastname\":\"Danston\",\"company\":\"Ultrabrake Racing LLC\",\"email\":\"m.danston@ultrabrake.com\",\"country\":\"UnitedStates\"}",
  "created": "2019-02-14T06:55:21.857Z"
 }
]

POST ConsumerData

Create consumer record and make it searchable on optional fields firstname, lastname, company and email.

Accessible API Keys	WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

productId*	string	Product ID to create the consumer record.
computerId*	string	Associated computer ID to create the consumer record.
clientInfo*	JSON	Json metadata containing the consumer record.
licenseCode	string	license code (should be supplied for license code activations, should be omitted or set as "" for trials).

Output

"ConsumerData Created Successfully" or error message.

Example Input:

Input data from request body.

Data - raw:

{
 "productId": "6872450105",
 "computerId": "BLXRrZJJEei4K7qPrJSL",
 "licenseCode": "3274861020157066211",
 "clientInfo": {"firstname":"John","lastname":"Doe","company":"SuperStyle LLC","email":"john@supersytle.com","country":"United Kingdom"}
}

Example Output

{

"message": "ConsumerData Created Successfully"

}

GET Trial

Checks the trial status (including if activated with license code) for a given product and computer.

Accessible API Keys	WebAPI READ-ONLY, WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

productId*	string	Product ID in question.
computerId*	string	Computer ID in question.

Output

In trial, or other status message indicating that trial does not exist, has expired or has been activated.

Example Input URL format:

Input data from request URI

https://my.nalpeiron.com/api/v2/trial?productId=6872450105&computerId=BLXRrZJ5T9imK7qPrJSL

Example Output

{

"message": "In Trial"

}

DELETE Trial

Resets an existing trial for a given user, product and computer.

Accessible API Keys	WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

productId*	string	Product ID in question.
computerId*	string	Computer ID in question.

Output

"Trial Deleted Successfully" or error message (indicating that trial does not exist or has been activated).

Example Input URL format:

Input data from request URI

https://my.nalpeiron.com/api/v2/trial?productId=6872450105&computerId=BLXRrZJ5T9imK7qPrJSL

Example Output

{

"message": "Trial Deleted Successfully"

}

GET Trials

Accessible API Keys	WebAPI READ-ONLY, WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

productId	string	Returns trial status for this productid (optional). Default - If omitted, returns trials for all products.
pageNumber	int	If >0 then returns the results on that page. If 0 or omitted then returns only the number of records (count) (optional).
pageSize	int	Number of records per page (default and max. value=10000) (optional).
computerId	string	Selects only records for this computerID (optional). Default - If omitted, returns trials for all computer IDs.
expiresBefore	datetime	Selects only trials that expires before this date (optional).
expiresAfter	datetime	Selects only trials that expires after this date (optional).
expiresWithinDays	int	Selects only trials that expires within this number of days in the future (optional).
trialStatus	string	Must be either 'inTrial' or 'expired' (optional). Default - if omitted, returns all records.
converted	string	Selects only trials that are converted (activated) ('true') or not ('false') (optional). Must be either true or false. Default (if omitted) - selects all.
createdBefore	datetime	Selects only trials created before this date (optional).
createdAfter	datetime	Selects only trials created after this date (optional).
createdWithinDays	int	Selects only trials created within this number of days in the past (optional).

Output -

If pageNumber parameter is 0 or omitted then returns only the count of records.

Else, returns one or more sets of:

productId	string	ProductID of the trial.
computerId	string	ComputerID associated with the trial.
trialPeriod	int	The trial period in days.
created	datetime	Trial created datetime.
modified	datetime	Trial modified datetime.
leaseEndDate	datetime	Lease end datetime.
expires	datetime	Number of activations allowed.
trialStatus	string	Status of the trial.
converted	string	Is the trial converted (activated) 'true' or not 'false'.
licenseCode	string	Associated LicenseCode if the trial has been converted (activated).

Example Input URL format:

Input data from request URI

https://my.nalpeiron.com/api/v2/trials?pageNumber=1&pageSize=2&converted=true&expiresAfter=2019-04-15&expiresBefore=2020-05-25

Example Output

[
{
"productId": "3117400101",
"computerId": "MauY67890Gh34567890",
"trialPeriod": "30",
"created": "2019-06-06T09:33:58.173Z",
"modified": "2019-06-06T09:33:58.173Z",
"leaseEndDate": "2019-06-21T09:33:58.173Z",
"expires": "2019-07-06T09:33:58.173Z",
"trialStatus": "Trial Expired",
"converted": "true",
"licenseCode": "3274861020157066211"
},
{
"productId": "6503300100",
"computerId": "YtUAc6Xx7auMoc+t7H4+",
"trialPeriod": "10",
"created": "2020-04-21T17:39:53.95Z",
"modified": "2020-04-21T19:57:04.603Z",
"leaseEndDate": "2020-04-21T21:57:04.603Z",
"expires": "2020-05-01T17:39:53.95Z",
"trialStatus": "Trial Expired",
"converted": "true",
"licenseCode": "358161020157066281"
}
]

POST OfflineActivation

Accessible API Keys	WebAPI READ-WRITE, WebAPI Offline

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

productId*	string	Product ID in question.
activationCertificate*	string	Activation certificate request acquired from the client.

Output

Activation certificate to be applied to the client to unlock or error message.
Example Input:

Input data from request body.

Data - raw:

{
 "productId": "6872450105",
 "activationCertificate":"d0801330b069c8412918609af803a1d8d1f2e8d66237ea7c8bb313828ff2f37f6b17262459281ef2787484d734f647cf8b5e01457a9c2061ac9b157346ba0717325e892de847de6e7e88035e11c14f43fd72e2d14ee867358b86631c6d0be6ca0b5cd35d0231439f1b6e81d27074d25dfdc2bf0b3b33c8dd49f0d73a84f12e68ee8b18b812c05f4b33abff642822b61fa48b665d4eb7a058bedbea03e83d5c90ada652bda357be27d261d27ab2c5e7a3f76bbb644f556d21c37610edb972613947c47d4f8b69b04d92eda6224726a3d762224caf8836c1b4c1aa37a71c3ef1d2d36eb5015086cf29d383fca491adfe59a738cbad688f06e82458ae2891ae58dd6d16d7b4275947acb9520a515af8a5ca4fbd7822ff85cfde6466fb61da22156c3793e44b8ee38feee15bdb50e5cf89c59faf44d069d8b661c1b6a3c5b0242ec808f085faf99c0aae813893c145e7353256535ad413f16c8219f8db0497d1e608bcb5d3a57ed7b83cbf711cca4b3417afcf22cbe5e0ddb16ca34672de6be20e0febd00b4d333bf3e9c1ccb37704119c4cea7768a4bf1f6748c6f6579492c64cfd9732746a0e43ce134f621026c72598365f0492705445cb8d324b292a3ac01aeae0637efdb5e7b2c0b6d553e6f7a47af10c1beec3c1e435a6c0e838cbebb8b2b311001c115c540ed327268f9f7fb7865daf1eb589d60f869cdd7683a649e77568e179adbb8c0c7b5d93563773d7e97f30ab5bf7d9cab9b46b82a4c931e1523916d342de7db176edb92e0d43fb276eb551e80a1a9f72cea3be38cbf0d1391a7cf059aca09d4275765c525d5fade0b24773e9f424a4b9ce021e5bc9116741375446098969526a0eaf00b18b2060bf3f7e471322577a01aef6c2919ee9ab374ca704a900384f0361a7e19eddfebc1c37ae085906e8f5071a05553aedcf25e087a4ffd81e7af559ee49296d552cdf9e92226a2e1cd28706000817d2744be42b29b29bc410a6d36d8a10a5e7304e74a1d39f3db867ba850907ade4f71eb27c967bcd763ca2cff979a4569a27576037a4015e3dbcd6b0814814cb36da9e39a4f1985050ce65f38a70b7226289e2ec3f6fb1126844169fc095ec8c2f8b70c427a2ff3c7a9a2ecc0e2aaf2dcddb3f852ad472ed6df4535b99a5fd9ee120ac327faa158e8c379be450824cee0d1f43b0d31d38369e75966062ebe55534f1714f0f3ea7729a000f29fa31844128a907d662d40b59823cc22da3e9c3b2c36c8ca1f85c52001dd09e896246dcbb8978807f909fb29b529103c19a46c246020bf830cdf02dfe6ad2ad6b3b231031907494158f40f863f7833598bc5ff5fd5b011a3d7effb52106bcfa420d904104d6f57e18205d5d0733ec0316ad1a7bc33301272fe414bc1c3682bd1e3832fd691d3d24c25875c6b2825fe41f9d965ca9b6d524ced4f5de3f5a0e6304ea12425fd86932dae150adebf9d78e633b8ba4a72ce4e5a60a03a22a9357e7eea4b636265ff5d1334499e32ec8cb54a52d7cda109fa72ae7cf3d6e91f9a806f4643531ff0623ad38km4t5G2c5ee407f112eb432189bcd875d6fa287eb02db3c6863398688071e053d731379296c361de1e58e756521be877c6b6a2ffb2373caa5c733043c63bc068dadde0ea60ef5f19061d8e44fcfa13ff3a0dad3f281969b1e8f8ee044d9e4be45a3d1557ec0a12ed7a7f4fb743ebea3baa526598c35856f784894d23893fccc13698ab19ca7e487317bd4148dbca03076510e21577ac1d801dabed67863975d7f57507c8fd8044862547695cc9341afad22be43bb8f9607a99a42cd684d71d0fc2cbeb6d33745dfb4d2ab5ab8fcce2eb02476e65415ff2cabd8f21e13bc26e08ba636df83742b2492a3326e95f582e92e73d4a296bc3e5b5f73a1d1f1471619d132a2ca95fef59fb406da006b26e0fa5f7f409134f78ff0cae3fd3a87739982b006f163dec1d4fb62955dc62fede76127aa46f143f6ca8c8e6cb93cd226679df5f5145c5855d44dea009eb1dae0d22491769df930c469018cf70ea9e4a4e2649919ac187595bcfd76d0c84ab66ab4c097057f2876a407a685a5fc96525df451c862cf36bfe187875a40401fe8e3a0795eaf8d5878776784d3c97c3b2b5e85e0b3204ff6d56f7cb8909c4ee7e557e9ccf12c5bd27cf358a181be2d147585cd367e958b987e9d81c603a290bda468782fd21883ae6a2925a4b7ef582a70e1689912edb225502e51f960661b2d76fdf5df547ee6e9cf376daf405d4c5901057332366ceab9f813476bc0992a27d02f3a5044cd08a90d7df3f5f998a2ada8e751ff969b0a811d4ee1fff41cde159634c674b988fc7342f51fe815c50b72276d5ab408161104f9c0df44530ed2a2a61ea4dad1e00d9ab00a657cd7501a1799f7dcff1407c64ae2f09baf5adf6a29022641dc63c6cc354fcba0cc952b13b5c74343d975ce462bfe7123fac4b81ea5072016f91851c32dbd3a5ee2a1b98e9e297cb3cfe995950391a6500e624ac45216bd9b60f611aeb299c1f93a895868b86b9531ad51ed224171c3179b7f03d17ed771d237f6972b69634bdb054683ec62dbcc7f01a891dec2688645f5579e5317d1fbeada42ebf9c8b7e716d28e2013a1d12dd3498f68f6a30859436f0278072865961bf095fa4fb61e07f05a4359572d0f4a869112f65378f874deacaf692fe8e5eab876ebb48848345000663db358a6b972ea26c0cac265704639d41bdf4555b9c3cbbd9638af411c5cbbd688076de48e7a01a1219512504fc53c9bddc57443c5d85987ec4fa2003950f552a742c34264814233ba5b90d5bf410aab91add557476802e3530c3d18dc1f0fec6d5992c73c28d0328eb5a89cd7c75a2acace1244825b2d15b11791c4e6639f80e2fcd8eefb0f0503e819865caf1c8576773dcbb2e970bb8489bfa8c1c288efe07fc253e7d1298a3355f21ca29e05c53e89ac8707a099a2d3b51bdc06f086081fc909e91770033bc4bfac93d6ccf613718933ef7a2b71420ec40b64ffbb8119ffabd2ba5cae4514de8b288aac6f5a8fdde47c2cdd97e8c65936ba72c5e94e5e2f0892c8aff0422115ad43f122e9e185628aadebf56ddc0c20c88ec0f84423a16d6d153b339a0f1f15d38ec6a11d715c8011b08eaec4f0f83cd5ba2fd4476d6b8a77a7cfab0bfc51d6081b2aae0a2db0d58b853feb60dc9cff20029dd7cf5f1544158553f689d05ab687d029965ef99b7aeecd412a34aa8b58339de7ef43131b57a2873165df9d892c341d560d16ec39ae174de93799c89ca56fb8b1fe0966bcd0edc19df9675a2de9a0c8aad9985d294e49ecd672fb06fe2801b1397c4792373d8cbd675376da1970d09daae223720d3dba9a0746c3b0f249b5d28280d00def1264a53e27fe07739e3ba0ba2d88f9eafc551be494d4669c97b5cd5105bb6e926350e9d5919af390cab846dedec824e0ed5d161259c0a4d577e8993a21cc6ab57ee270aa492dafecfaa2277dd6a0aa97f279658af1c76734c323cc3d9a1e040c3d75ee9e6372462fbad63ab19fdfde7a2c1ea75564486c648d3e916bba4338860aa986459c1c4b84fc957bb59e5f23fd2d0c6080ababe2d251a48eeaf636384f8132b38d7e2deab320f0aca997b86a771410ade0f2931c6a6c2bf69e55478cdf068f51bceb53b2d34e52c78be6a27d71cbca048014e06776e79ae1c5f18de26da0031b948af85309d0d5ffd48e26bb1883b46802222c07c8cd69ff32abcb7b75595fd8a08b97a3a9e625625b485a41834bb4f9d28b711e06b1ce04e5204b7afe771a89a3062cc5f4b1896da888aee3393eeab5445cec608e1d620e3781a4db963fbc5780eed44be32888e1b7da7f9d7b1cb9a37defadc82e28abe97312cc2649fe072d5436abe85d2b5f021df944cbe80f716d922242cfbee71b1894173cde44039c51213d9a826676a7052056a531a3de1b62399ce411b661611b44a0c59b98eef54ffb26d268ea56f6ec3a21c30cfc972288314068b9e7e8cf69cd2bd0bcbab765b06a66f092a3ddd8e489dde41aabf67b1b8e4da9cd5dc240b51d8edce9c5c7ac86a07fc4be91c106993760a8e515dde97868a083342cda4076bb2e5441baa87ca9c2278a25bc1f7ca8fe0de9c8a30578906cf83101eb6e2acb5f74023dd61b6207cc463b7ba9b778756ff5cf0e9874c71f305896ace744a05e5c0c3616b3d11b5d81c63331a99bd97679910c9dca76c20031e69afb26d701f9c14f7145a3f9504ee456747bcef2b5b78c84308be52b4dbd2c9806ae27970c0c4ddf84ae7b9aecfbba6d95fff02fdf539c46f603c85f65d4cbbc99153ae790d16906f00afc6dcad990a1e86cf2c1f38fca5a99cc7ff04cec78a39b9e86b27da8227d20d0dd47eb25db6ec06dfbcfee1abbf8de1d7554d795d96913c49a4cf8abf11d92eaa3d1b21fbda2e459eeaedfbef043da9984bc3a38affdcfb2b91d466efae92c9cba12a4a33657c79858ba94621cccb05494fad522de01c0e88f184df15e50a6882340d993a64f44ea59c3a9cacd349e4241bda1ae2cf97476cd198f9a688ee5dd4e1fdcf0d165a8000b0715c84887666251b41f9d9af4441d36b01c75edc2aa6f919d5055aa8b3634f86c2c8807bcb0fd0338f276e817d1b8674c8596434117f0257227b6552fb957fe6fbc0d82e80eaa23c3b2f5402c36a1a709752ba6d71abc55eb7a30150b4fac96ecc8d5c23cab516cb463197b44fd272df80c33b84b2ef5518ec7306bb4289c1deca507cf234a7888de6930b8f718d6eb1c215edccbbd125887e12fe7bdf8bc88fe2e665e361597a8e6af8a3649bf4fe4085e344258616d5ef4d4bea5de4db33ea52fe11b7ed9dea75e4a21c3e3a12930d4ff03c751ac3644499c71a077625b95d84a1b1a03d3b95afef3485704e3ec4e0e052176d5f91cfa4b09bdad6521799f99a1466173baf951c8e00b3ead4b6a11d99d92639d4f68209e2b680d79518654c3211180d5eb9115531e88147a0de3d289debaf7f536003fb42b9050c5f779fcff577614221066e61224c6b140a1d88cd6180354fb3c6d9426e115a56b15984a871966b46fa7e8a793b0f9c39c2d2c9a26bcc518356d7c541e03fe785bc1a4c0120df3c50ed3085c930d67ac4910560b6fa4db37b95e3f78edce901c78ac5a73d028481f13536ae8873ada92e6fecd70277d3ede0349e751f358d0324a056e4ec83110b3902667dd2a3aa662b4966a55c1a810fadce23229fa4af4904309920ca2ccc133deca2f9a4edced1149906804d45432d481a752636ca46cd8aac96835381bc4126a124f4aed7965da298be62d7d8f44a3abeb63f06469bd8eef0a94df0eb6d2d351b56594f014336b4cfd7d78b44f1e17dc1211ee4bdc017af956e5d8ce7f772efd1a7981cdc2a5378fc737a4672deab400f4100517ef285893550ec9cb3a1e442ad43735cd973d51d01f86ebf5772172c56e18b4e41b328c80843f960d4b5c6e6a1f51b2e07d1e794ab8240ec1ebada1488916847a31b548746705a8c204b54b14c2b496e14eb74a90374fc5a96ea26f56f3e6eec5b82ea2923aca0031cbfb0ae26ac0e870fae413681736a46908082e32313da8933f35bef39c7c31e25ec5c8e146b9b8555d5267fa8b3e3f236346437bff3c64ec285a0f952394a176577166dec25e7a3f355a38a9209ab23aee709a0daa70449be48e6c1815745538d9114ecab1434a20a583a58af73abb5df20e53ce6104bfb3deb0500c30cf855b471fe736ad48465515b9c2388b45a7f5ecc8a7635c2f7a168acfa474d28e17d8be6832744aceceeb941205f65f6e7a879246623b5abe1737af7ce2792b4b44cec125154328b9544e1a797fbfeb02ce34599ce23754951708c41b28184bf29b2afd8ca843002e0abfa42d82dbe81e34e1853c463e0ceff5c46b0195d730ace2ca3cbee95e4b14f332b39dc24237b0d9fc59d3e41ee792e507ca616e1bd4231d9ef7d32129eee83ade80f4d9eb7bddfe305ef42a767f1e22415a712a6bc90a78de1af688e07c3d788a7a4303d016cda2cdd411f543c8a679790f1f9fed40f4a03b7f9df76fc39afca5cbea5bb83a7ea1dd9d5649eb6225f5e0feb14471b9fee74f0b5f387571fd7a660537e8718da75fd6b05cffa524da30ce1299d0b30ef6b46d4fcd26c9a37219752d5108684ea8d2634f57b0f2072afcf3d63a28ffbec3b5f7de117d47d59f61f5a92f222f6bd7ace041f1e2fed2d0708aab532bf2170a49bfaf3848825ff4e19cf63ad3a54b39978af98dc673b4b0c902534dc69b26108c838df316566edc967e2a2e8d998e7fda0ac01b30d228b3bf4c8edbc4aa3a506a0dc7567683ff64e859a7ba426faec4c3830b2b8bf274227ee1429faceb4846cfb62f04087fbdda209d6d986f1a79954b2d5b64e33f220c22df4022879ded1a7a73902ebaefc52fdc78c2f46d30be68194f51df706209ef0e17d936d1c90fc17666d45ddc527dbc45d2c0108d17c1089dffe41092266710074ed0bc359c90591172fa22ec944232accf0cf475559033869285499b52ae9b53bf17f4dd07b3c7a568ab7bf5cb98e8dc1c9caec6ac20f1bc27fc7e35f449c9388bffd15e46234e6bb730b35934bc267c2e0d14a19f768d08ab4a74efa512a7b69a9bb0d345918d06f0d2d6f825866c90c4ab98c7ac1ddcc191a46f147c8134254619715db8c6482e0e4419dda9f8a22b58acef865f71ec1b46c1c46e5c4936bd4bc8500b9f620b45d3eec8c1c1da0f12b1715c7a7783367941ff8169cb5af0969f2b07ee9f5338e265fde27da93de9f9342ae0a91d87ba4d3d6f97d8c4460e6f7005ef5944fb23f9aae407ac860fc8e5f6c69a8494515ed086e812f1a3302e95ffcffae3088c2bce23e2f2b298b86a14cae49333677c7a0c1550e66a5b65021a22d312a66df71fa80bb32436aa74bc0c71920743ac0a458b6cf441c744bf5bead7356d095bd3cef77a88f52193248180224683ed324277e8e0e7599dd7b8510fdbd63f9094474dc5466e1e9639169a65746f0eea7973c75299b3ad3e47296f58e0c26fcb4a4c0b359c793397c876e40a42c8c1f561f03fef0cf2b3173cd7b783da9392e8b6a5e4b2a3f9107d5a9e3148c9cca5c74a7494478fffc9fad7ccea1a13dd3fb945573ad54a31759839d64dcdb39bb481c00e9ab92d13e83fe09748c4c5bf515d3a91446040136b0d8041f3875b07b522b87198f5c47fae3784b53c1ea0978ecf2a53ea90ca4befa5579960666f30758576673927b838ab2d685940efc65bb0216929fb4c662ca385970cec4c76659f10ce4cfe0e51799adb76c2ec36d440fe045576da670b54895f8401e1b85ec5d5bea99ffc520eb0f816c85313531ae60e16596da88d6774c6b54325b817199507f936a3de7996057e066b622e32d3fd24c6e2e0974c53817eaf66d25f45a37603c76fa1dc22a21e08a97a6b77a56f2be460c25b9b3ef88d5fcee9c80f8990fbf03600585caaa104c28e7175704da9de8c7983a654ae56e761f4775f5c6aa59af2b25713b419d3e2ace1dcb1be65efdb51f8fad856cf08b980794d786c7d7badcba55817c7185946b1496648fd9a335797116445638abc34dbe8c4dd2d84d9faccfa65ffd6a3cab162807852f6f5d8d3e8eac02b914d842da8175e7001bae138ccd2632debd9dacd0c7ab6c25adac2376b5348d510915009c7dcd1428aa84bc937a732f849b71b5bd1a6b42a112406e6bd419544e99ff4257f442a63d4068572ca9f5503bbe1b27d5ebe801f9f923921d5c8d930325c7fab5da411796a7c993b43a2ca4ede90322a1221c493e4016bb8ba7bee23c3a1d1ef0358de21ec11378b1586536ae5e036d5170df1a8b018efde335e092dd2a9a65945b9089e7e7c381e4e82cb2a0bc0788934bec76eeb3c092e55649dc87a2d82add660026d3c80819df5b5a4b1d9ea7800787c5025e93342413e148b898115aafc0006149e189425d4b803d3817282753535ad39b2066f0bafee98efc48c188a9a3b919a590848b0e3854ce450b410bddca3228cc6a3a4fe07274cd75c3170c0c870e9ad0032f84cf3984a0fbffeab6cf30bc310495778242c116d1c16505e3f54a0b1db20580b7d23fb84736372e914f243b72b56aa11e91a1f60650ac8d3140d480bb12dfbad03ef4dd1c8198f6d57f297edf56b42ab46791033dac5db8d772762f9f95d433a1c6223997fc305cf2f3be2a11ba67140d5d4fad18d6ef0ac3456dbf7f42ec18e1aed4b973d780fe5adbfad6c09652b38d290a42fd26826b01cec46e357a2eb1dc7f69edc1d62cbfe725938f151ce1952849305946de3c0f65fbe63c504ab1c547b04d9b92e1295e76e4cecd9583af3357aa215714cad7cbeb5548ef0ed58ff07e5f6325c8d2826b61df03ca3ac2a58e54ec26805527491c81d1826b432e05a6d7ac3336985ab8cd21beca625b894d859d91267fc51445b677d64830310722b570db05b0618914601d0ac57f4d141845234f6381fdef3f655c6557e0d3bf848bb35186a4b2e6eff5e815be694245282487897eba411eff540206ade7ad01ee86757c9291966f284c6668e541d741832415ca9eaae8536ea90427369a8eea31f7b39a6d626aa9f06c3bf7851fdaa44f49bfeb4ddd45bdc784f8b31d4b0d960b9e374346e0f73b32329ddc3451d6c45f5b11e2186ad5a064cb72fad0b978909cf3a4ac98fe0ba57818674486362ec83b46992c8cc51c031ed2353d68a8fd02560e56a37ef536b9baa0e2ddddb25cee8e247898d377fa936c1fe0697381f54327d56f156345895cac9a1c674a3fe2dafb48672c6879b6a5c0a11afca5351c32fcf02fb87b054bf21703244bf475b5a32946defa594e51e8206fbea92a6147b9f1a579ae1d442bf72f76605a6df5441218776b6241711568f7d1312c7ddbdab87e9c7bf59c5f0ff48aa9aba8ee3deca33930eafc2a3a7eff5a0c36efe8a178ab2f5206ab0891b37bf12e75dad904d8c92794f90f7fed2ee3d2e550ba566ecd7769a7cda67c736ec2cbef6c23d4bda50ff075a34f5961c1a9a2e7d87ae902bf00a05acd3cdd7036e8d8e2df9545a070b497168697405f99648cfa8b2c6a929d55f0935a9b3742f70db38e3a9d98a4e882590e206d312ae0c90c05159c287fb7b865dd44382b87691381d835e27c78a527a37ad729a3914b482f890194c11d5810e866d5ed1b47912af72cd3d58fcc094c0d777d3664b28ec37eb8cc9373ae9253b3594e79ad243c307bd6060efdf14e0b4a42734222a6d3017e4ba2d5b7ca37bd65c92283cd7bd18e108a1ba485baee76183f7df7e8f905b8ddb35eb42271ea3096d571bd86135c5e0983524c5d5f9771267aab1bd9902a1e385cb1f2873b8f626e45353ca625555ee214963dc1491bbfc54b2e7533b58f00543008e0414643fac416c069c401afdb64751ee2e9f49412e63af2a9d360bb446fe5f150ee63a37e28a9348374b0eda8ed407681b2c15e337aO425a52505242545b515d"
}

Example Output

"8595e2ecc3e0fad7002bfc0b99051c2a5a3b0a8699f9cc864c7c33e9103b368c5cb7532655379ee549f1518330e2590328c95a6ae186d7205257901d40dc60557b49ed60952033e2e2594961a0df7a676d2586baf866fd80d7028228b3e2a96ce696399a36b7667599496cc34d44bd2294617c41d3831293562cf39e26331f36148c30e581b637c0b467f56f85ac22be7448f2038df14b89b35406d3889f646bda7f43ec421704c4862999d8b728127f923ab8117b1c75eca9cc42d8e67b95de30ed473d5ee3af6d7668032720b23de8232f060d4c0bd0797b41ee4e34f9ce38dfe8b1ee74131e221b0a73f5942e60f67a4e3645e4a2efd6a719b1a31526e0f874b91dcd832199fbd864b37646b45c3619cb3a855c5ea66ab8ec1527c8d49b0c512421d2599b0a62e3d312e3ecd4a10b13cdeb8dfb94b61fbcfb80c8dc0b99ffcb49b0c9c754ec043d08a613330259bb7b71efff6b6ad7a3078054140a40217c6055ccfd145b7f4e853d05f08f41355227b00ad6857ba2ed5188cfd3bba53f786302c516710726cade45106878ead39867283dd4d52b7824a5d8c771ae2bab9bffab754b553fd12d0f34d162c650cad2569b60a74f47b5697f4587e05d851c7a551c22a5543064ee1638ceeaf29f6564cfa83bedb62e1d14d71c2448a1bba9003c6b5ef306eed08eca9cd7316a53bfdad442210219a860b8c73c158f86f766cdf351c7d133d8fb30ce3c75f98ce4d6c48e54b8964f82d1a4d58d684ee2dc10e86f1c2d1273d83c5c4bcbe2e924e42148248559637c03846e658b698280e2901bfa0b5acf88238be440d0972379ca5ec1c07959eda26c4f2348b4e146e9fd2f2373d19440040729635cbda6dc726e9b51f320bf7052a8667699133f7bc6b4b713acef580104959c2423d26d6cd4d4f11abf0b3cf56c8947f03243181db8235759615ac89e061372cc3db58659009e1eec127916aee0320ecb7c652518f0492b5c2c82e678ffd1ccd9a7c69acc2961a6d90e0554deb081196bd84bb2f016e8c5b0607917099ab98f645a774013d0cc96827bc395c6b7af121f3749d4b292bd1e2070fa5017ef2423042dd5a3612fa551356d87fff58daf2d7373fcb80472562dff58227b4e462883ea86e07acbca8409f6fbed448c0666d01ef522fcb3cdfa661347183383abdfd637ea442a14676f47373b250d1d1adeadb5fe399fc8bfbba9dbb8955139da64e81b9a8558952ab110f6c249dac626786691abc2a6e22e823f1e75897c09410207892fe4156786764688bd2d4ff3cdf37451f0e39df8c6d36ea19cf7aee69fdd44013613718ac3d833d059cf37c309b1687fafdbbf313038313032383939353836393233373432"

POST OfflineDeActivation

Accessible API Keys	WebAPI READ-WRITE, WebAPI Offline

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

productId*	string	Product ID in question.
deActivationCertificate*	string	De-activation certificate acquired from the client.

Output

"OK" or error description.

Example Input:

Input data from request body.

Data - raw:

{
 "productId": "6872450105",
 "deActivationCertificate":"d0801330b069c8412918609af803a1d8d1f2e8d66237ea7c8bb313828ff2f37f6b17262459281ef2787484d734f647cf8b5e01457a9c2061ac9b157346ba0717325e892de847de6e7e88035e11c14f43fd72e2d14ee867358b86631c6d0be6ca0b5cd35d0231439f1b6e81d27074d25dfdc2bf0b3b33c8dd49f0d73a84f12e68ee8b18b812c05f4b33abff642822b61fa48b665d4eb7a058bedbea03e83d5c90ada652bda357be27d261d27ab2c5e7a3f76bbb644f556d21c37610edb972613947c47d4f8b69b04d92eda6224726a3d762224caf8836c1b4c1aa37a71c3ef1d2d36eb5015086cf29d383fca491adfe59a738cbad688f06e82458ae2891ae58dd6d16d7b4275947acb9520a515af8a5ca4fbd7822ff85cfde6466fb61da22156c3793e44b8ee38feee15bdb50e5cf89c59faf44d069d8b661c1b6a3c5b0242ec808f085faf99c0aae813893c145e7353256535ad413f16c8219f8db0497d1e608bcb5d3a57ed7b83cbf711cca4b3417afcf22cbe5e0ddb16ca34672de6be20e0febd00b4d333bf3e9c1ccb37704119c4cea7768a4bf1f6748c6f6579492c64cfd9732746a0e43ce134f621026c72598365f0492705445cb8d324b292a3ac01aeae0637efdb5e7b2c0b6d553e6f7a47af10c1beec3c1e435a6c0e838cbebb8b2b311001c115c540ed327268f9f7fb7865daf1eb589d60f869cdd7683a649e77568e179adbb8c0c7b5d93563773d7e97f30ab5bf7d9cab9b46b82a4c931e1523916d342de7db176edb92e0d43fb276eb551e80a1a9f72cea3be38cbf0d1391a7cf059aca09d4275765c525d5fade0b24773e9f424a4b9ce021e5bc9116741375446098969526a0eaf00b18b2060bf3f7e471322577a01aef6c2919ee9ab374ca704a900384f0361a7e19eddfebc1c37ae085906e8f5071a05553aedcf25e087a4ffd81e7af559ee49296d552cdf9e92226a2e1cd28706000817d2744be42b29b29bc410a6d36d8a10a5e7304e74a1d39f3db867ba850907ade4f71eb27c967bcd763ca2cff979a4569a27576037a4015e3dbcd6b0814814cb36da9e39a4f1985050ce65f38a70b7226289e2ec3f6fb1126844169fc095ec8c2f8b70c427a2ff3c7a9a2ecc0e2aaf2dcddb3f852ad472ed6df4535b99a5fd9ee120ac327faa158e8c379be450824cee0d1f43b0d31d38369e75966062ebe55534f1714f0f3ea7729a000f29fa31844128a907d662d40b59823cc22da3e9c3b2c36c8ca1f85c52001dd09e896246dcbb8978807f909fb29b529103c19a46c246020bf830cdf02dfe6ad2ad6b3b231031907494158f40f863f7833598bc5ff5fd5b011a3d7effb52106bcfa420d904104d6f57e18205d5d0733ec0316ad1a7bc33301272fe414bc1c3682bd1e3832fd691d3d24c25875c6b2825fe41f9d965ca9b6d524ced4f5de3f5a0e6304ea12425fd86932dae150adebf9d78e633b8ba4a72ce4e5a60a03a22a9357e7eea4b636265ff5d1334499e32ec8cb54a52d7cda109fa72ae7cf3d6e91f9a806f4643531ff0623ad38km4t5G2c5ee407f112eb432189bcd875d6fa287eb02db3c6863398688071e053d731379296c361de1e58e756521be877c6b6a2ffb2373caa5c733043c63bc068dadde0ea60ef5f19061d8e44fcfa13ff3a0dad3f281969b1e8f8ee044d9e4be45a3d1557ec0a12ed7a7f4fb743ebea3baa526598c35856f784894d23893fccc13698ab19ca7e487317bd4148dbca03076510e21577ac1d801dabed67863975d7f57507c8fd8044862547695cc9341afad22be43bb8f9607a99a42cd684d71d0fc2cbeb6d33745dfb4d2ab5ab8fcce2eb02476e65415ff2cabd8f21e13bc26e08ba636df83742b2492a3326e95f582e92e73d4a296bc3e5b5f73a1d1f1471619d132a2ca95fef59fb406da006b26e0fa5f7f409134f78ff0cae3fd3a87739982b006f163dec1d4fb62955dc62fede76127aa46f143f6ca8c8e6cb93cd226679df5f5145c5855d44dea009eb1dae0d22491769df930c469018cf70ea9e4a4e2649919ac187595bcfd76d0c84ab66ab4c097057f2876a407a685a5fc96525df451c862cf36bfe187875a40401fe8e3a0795eaf8d5878776784d3c97c3b2b5e85e0b3204ff6d56f7cb8909c4ee7e557e9ccf12c5bd27cf358a181be2d147585cd367e958b987e9d81c603a290bda468782fd21883ae6a2925a4b7ef582a70e1689912edb225502e51f960661b2d76fdf5df547ee6e9cf376daf405d4c5901057332366ceab9f813476bc0992a27d02f3a5044cd08a90d7df3f5f998a2ada8e751ff969b0a811d4ee1fff41cde159634c674b988fc7342f51fe815c50b72276d5ab408161104f9c0df44530ed2a2a61ea4dad1e00d9ab00a657cd7501a1799f7dcff1407c64ae2f09baf5adf6a29022641dc63c6cc354fcba0cc952b13b5c74343d975ce462bfe7123fac4b81ea5072016f91851c32dbd3a5ee2a1b98e9e297cb3cfe995950391a6500e624ac45216bd9b60f611aeb299c1f93a895868b86b9531ad51ed224171c3179b7f03d17ed771d237f6972b69634bdb054683ec62dbcc7f01a891dec2688645f5579e5317d1fbeada42ebf9c8b7e716d28e2013a1d12dd3498f68f6a30859436f0278072865961bf095fa4fb61e07f05a4359572d0f4a869112f65378f874deacaf692fe8e5eab876ebb48848345000663db358a6b972ea26c0cac265704639d41bdf4555b9c3cbbd9638af411c5cbbd688076de48e7a01a1219512504fc53c9bddc57443c5d85987ec4fa2003950f552a742c34264814233ba5b90d5bf410aab91add557476802e3530c3d18dc1f0fec6d5992c73c28d0328eb5a89cd7c75a2acace1244825b2d15b11791c4e6639f80e2fcd8eefb0f0503e819865caf1c8576773dcbb2e970bb8489bfa8c1c288efe07fc253e7d1298a3355f21ca29e05c53e89ac8707a099a2d3b51bdc06f086081fc909e91770033bc4bfac93d6ccf613718933ef7a2b71420ec40b64ffbb8119ffabd2ba5cae4514de8b288aac6f5a8fdde47c2cdd97e8c65936ba72c5e94e5e2f0892c8aff0422115ad43f122e9e185628aadebf56ddc0c20c88ec0f84423a16d6d153b339a0f1f15d38ec6a11d715c8011b08eaec4f0f83cd5ba2fd4476d6b8a77a7cfab0bfc51d6081b2aae0a2db0d58b853feb60dc9cff20029dd7cf5f1544158553f689d05ab687d029965ef99b7aeecd412a34aa8b58339de7ef43131b57a2873165df9d892c341d560d16ec39ae174de93799c89ca56fb8b1fe0966bcd0edc19df9675a2de9a0c8aad9985d294e49ecd672fb06fe2801b1397c4792373d8cbd675376da1970d09daae223720d3dba9a0746c3b0f249b5d28280d00def1264a53e27fe07739e3ba0ba2d88f9eafc551be494d4669c97b5cd5105bb6e926350e9d5919af390cab846dedec824e0ed5d161259c0a4d577e8993a21cc6ab57ee270aa492dafecfaa2277dd6a0aa97f279658af1c76734c323cc3d9a1e040c3d75ee9e6372462fbad63ab19fdfde7a2c1ea75564486c648d3e916bba4338860aa986459c1c4b84fc957bb59e5f23fd2d0c6080ababe2d251a48eeaf636384f8132b38d7e2deab320f0aca997b86a771410ade0f2931c6a6c2bf69e55478cdf068f51bceb53b2d34e52c78be6a27d71cbca048014e06776e79ae1c5f18de26da0031b948af85309d0d5ffd48e26bb1883b46802222c07c8cd69ff32abcb7b75595fd8a08b97a3a9e625625b485a41834bb4f9d28b711e06b1ce04e5204b7afe771a89a3062cc5f4b1896da888aee3393eeab5445cec608e1d620e3781a4db963fbc5780eed44be32888e1b7da7f9d7b1cb9a37defadc82e28abe97312cc2649fe072d5436abe85d2b5f021df944cbe80f716d922242cfbee71b1894173cde44039c51213d9a826676a7052056a531a3de1b62399ce411b661611b44a0c59b98eef54ffb26d268ea56f6ec3a21c30cfc972288314068b9e7e8cf69cd2bd0bcbab765b06a66f092a3ddd8e489dde41aabf67b1b8e4da9cd5dc240b51d8edce9c5c7ac86a07fc4be91c106993760a8e515dde97868a083342cda4076bb2e5441baa87ca9c2278a25bc1f7ca8fe0de9c8a30578906cf83101eb6e2acb5f74023dd61b6207cc463b7ba9b778756ff5cf0e9874c71f305896ace744a05e5c0c3616b3d11b5d81c63331a99bd97679910c9dca76c20031e69afb26d701f9c14f7145a3f9504ee456747bcef2b5b78c84308be52b4dbd2c9806ae27970c0c4ddf84ae7b9aecfbba6d95fff02fdf539c46f603c85f65d4cbbc99153ae790d16906f00afc6dcad990a1e86cf2c1f38fca5a99cc7ff04cec78a39b9e86b27da8227d20d0dd47eb25db6ec06dfbcfee1abbf8de1d7554d795d96913c49a4cf8abf11d92eaa3d1b21fbda2e459eeaedfbef043da9984bc3a38affdcfb2b91d466efae92c9cba12a4a33657c79858ba94621cccb05494fad522de01c0e88f184df15e50a6882340d993a64f44ea59c3a9cacd349e4241bda1ae2cf97476cd198f9a688ee5dd4e1fdcf0d165a8000b0715c84887666251b41f9d9af4441d36b01c75edc2aa6f919d5055aa8b3634f86c2c8807bcb0fd0338f276e817d1b8674c8596434117f0257227b6552fb957fe6fbc0d82e80eaa23c3b2f5402c36a1a709752ba6d71abc55eb7a30150b4fac96ecc8d5c23cab516cb463197b44fd272df80c33b84b2ef5518ec7306bb4289c1deca507cf234a7888de6930b8f718d6eb1c215edccbbd125887e12fe7bdf8bc88fe2e665e361597a8e6af8a3649bf4fe4085e344258616d5ef4d4bea5de4db33ea52fe11b7ed9dea75e4a21c3e3a12930d4ff03c751ac3644499c71a077625b95d84a1b1a03d3b95afef3485704e3ec4e0e052176d5f91cfa4b09bdad6521799f99a1466173baf951c8e00b3ead4b6a11d99d92639d4f68209e2b680d79518654c3211180d5eb9115531e88147a0de3d289debaf7f536003fb42b9050c5f779fcff577614221066e61224c6b140a1d88cd6180354fb3c6d9426e115a56b15984a871966b46fa7e8a793b0f9c39c2d2c9a26bcc518356d7c541e03fe785bc1a4c0120df3c50ed3085c930d67ac4910560b6fa4db37b95e3f78edce901c78ac5a73d028481f13536ae8873ada92e6fecd70277d3ede0349e751f358d0324a056e4ec83110b3902667dd2a3aa662b4966a55c1a810fadce23229fa4af4904309920ca2ccc133deca2f9a4edced1149906804d45432d481a752636ca46cd8aac96835381bc4126a124f4aed7965da298be62d7d8f44a3abeb63f06469bd8eef0a94df0eb6d2d351b56594f014336b4cfd7d78b44f1e17dc1211ee4bdc017af956e5d8ce7f772efd1a7981cdc2a5378fc737a4672deab400f4100517ef285893550ec9cb3a1e442ad43735cd973d51d01f86ebf5772172c56e18b4e41b328c80843f960d4b5c6e6a1f51b2e07d1e794ab8240ec1ebada1488916847a31b548746705a8c204b54b14c2b496e14eb74a90374fc5a96ea26f56f3e6eec5b82ea2923aca0031cbfb0ae26ac0e870fae413681736a46908082e32313da8933f35bef39c7c31e25ec5c8e146b9b8555d5267fa8b3e3f236346437bff3c64ec285a0f952394a176577166dec25e7a3f355a38a9209ab23aee709a0daa70449be48e6c1815745538d9114ecab1434a20a583a58af73abb5df20e53ce6104bfb3deb0500c30cf855b471fe736ad48465515b9c2388b45a7f5ecc8a7635c2f7a168acfa474d28e17d8be6832744aceceeb941205f65f6e7a879246623b5abe1737af7ce2792b4b44cec125154328b9544e1a797fbfeb02ce34599ce23754951708c41b28184bf29b2afd8ca843002e0abfa42d82dbe81e34e1853c463e0ceff5c46b0195d730ace2ca3cbee95e4b14f332b39dc24237b0d9fc59d3e41ee792e507ca616e1bd4231d9ef7d32129eee83ade80f4d9eb7bddfe305ef42a767f1e22415a712a6bc90a78de1af688e07c3d788a7a4303d016cda2cdd411f543c8a679790f1f9fed40f4a03b7f9df76fc39afca5cbea5bb83a7ea1dd9d5649eb6225f5e0feb14471b9fee74f0b5f387571fd7a660537e8718da75fd6b05cffa524da30ce1299d0b30ef6b46d4fcd26c9a37219752d5108684ea8d2634f57b0f2072afcf3d63a28ffbec3b5f7de117d47d59f61f5a92f222f6bd7ace041f1e2fed2d0708aab532bf2170a49bfaf3848825ff4e19cf63ad3a54b39978af98dc673b4b0c902534dc69b26108c838df316566edc967e2a2e8d998e7fda0ac01b30d228b3bf4c8edbc4aa3a506a0dc7567683ff64e859a7ba426faec4c3830b2b8bf274227ee1429faceb4846cfb62f04087fbdda209d6d986f1a79954b2d5b64e33f220c22df4022879ded1a7a73902ebaefc52fdc78c2f46d30be68194f51df706209ef0e17d936d1c90fc17666d45ddc527dbc45d2c0108d17c1089dffe41092266710074ed0bc359c90591172fa22ec944232accf0cf475559033869285499b52ae9b53bf17f4dd07b3c7a568ab7bf5cb98e8dc1c9caec6ac20f1bc27fc7e35f449c9388bffd15e46234e6bb730b35934bc267c2e0d14a19f768d08ab4a74efa512a7b69a9bb0d345918d06f0d2d6f825866c90c4ab98c7ac1ddcc191a46f147c8134254619715db8c6482e0e4419dda9f8a22b58acef865f71ec1b46c1c46e5c4936bd4bc8500b9f620b45d3eec8c1c1da0f12b1715c7a7783367941ff8169cb5af0969f2b07ee9f5338e265fde27da93de9f9342ae0a91d87ba4d3d6f97d8c4460e6f7005ef5944fb23f9aae407ac860fc8e5f6c69a8494515ed086e812f1a3302e95ffcffae3088c2bce23e2f2b298b86a14cae49333677c7a0c1550e66a5b65021a22d312a66df71fa80bb32436aa74bc0c71920743ac0a458b6cf441c744bf5bead7356d095bd3cef77a88f52193248180224683ed324277e8e0e7599dd7b8510fdbd63f9094474dc5466e1e9639169a65746f0eea7973c75299b3ad3e47296f58e0c26fcb4a4c0b359c793397c876e40a42c8c1f561f03fef0cf2b3173cd7b783da9392e8b6a5e4b2a3f9107d5a9e3148c9cca5c74a7494478fffc9fad7ccea1a13dd3fb945573ad54a31759839d64dcdb39bb481c00e9ab92d13e83fe09748c4c5bf515d3a91446040136b0d8041f3875b07b522b87198f5c47fae3784b53c1ea0978ecf2a53ea90ca4befa5579960666f30758576673927b838ab2d685940efc65bb0216929fb4c662ca385970cec4c76659f10ce4cfe0e51799adb76c2ec36d440fe045576da670b54895f8401e1b85ec5d5bea99ffc520eb0f816c85313531ae60e16596da88d6774c6b54325b817199507f936a3de7996057e066b622e32d3fd24c6e2e0974c53817eaf66d25f45a37603c76fa1dc22a21e08a97a6b77a56f2be460c25b9b3ef88d5fcee9c80f8990fbf03600585caaa104c28e7175704da9de8c7983a654ae56e761f4775f5c6aa59af2b25713b419d3e2ace1dcb1be65efdb51f8fad856cf08b980794d786c7d7badcba55817c7185946b1496648fd9a335797116445638abc34dbe8c4dd2d84d9faccfa65ffd6a3cab162807852f6f5d8d3e8eac02b914d842da8175e7001bae138ccd2632debd9dacd0c7ab6c25adac2376b5348d510915009c7dcd1428aa84bc937a732f849b71b5bd1a6b42a112406e6bd419544e99ff4257f442a63d4068572ca9f5503bbe1b27d5ebe801f9f923921d5c8d930325c7fab5da411796a7c993b43a2ca4ede90322a1221c493e4016bb8ba7bee23c3a1d1ef0358de21ec11378b1586536ae5e036d5170df1a8b018efde335e092dd2a9a65945b9089e7e7c381e4e82cb2a0bc0788934bec76eeb3c092e55649dc87a2d82add660026d3c80819df5b5a4b1d9ea7800787c5025e93342413e148b898115aafc0006149e189425d4b803d3817282753535ad39b2066f0bafee98efc48c188a9a3b919a590848b0e3854ce450b410bddca3228cc6a3a4fe07274cd75c3170c0c870e9ad0032f84cf3984a0fbffeab6cf30bc310495778242c116d1c16505e3f54a0b1db20580b7d23fb84736372e914f243b72b56aa11e91a1f60650ac8d3140d480bb12dfbad03ef4dd1c8198f6d57f297edf56b42ab46791033dac5db8d772762f9f95d433a1c6223997fc305cf2f3be2a11ba67140d5d4fad18d6ef0ac3456dbf7f42ec18e1aed4b973d780fe5adbfad6c09652b38d290a42fd26826b01cec46e357a2eb1dc7f69edc1d62cbfe725938f151ce1952849305946de3c0f65fbe63c504ab1c547b04d9b92e1295e76e4cecd9583af3357aa215714cad7cbeb5548ef0ed58ff07e5f6325c8d2826b61df03ca3ac2a58e54ec26805527491c81d1826b432e05a6d7ac3336985ab8cd21beca625b894d859d91267fc51445b677d64830310722b570db05b0618914601d0ac57f4d141845234f6381fdef3f655c6557e0d3bf848bb35186a4b2e6eff5e815be694245282487897eba411eff540206ade7ad01ee86757c9291966f284c6668e541d741832415ca9eaae8536ea90427369a8eea31f7b39a6d626aa9f06c3bf7851fdaa44f49bfeb4ddd45bdc784f8b31d4b0d960b9e374346e0f73b32329ddc3451d6c45f5b11e2186ad5a064cb72fad0b978909cf3a4ac98fe0ba57818674486362ec83b46992c8cc51c031ed2353d68a8fd02560e56a37ef536b9baa0e2ddddb25cee8e247898d377fa936c1fe0697381f54327d56f156345895cac9a1c674a3fe2dafb48672c6879b6a5c0a11afca5351c32fcf02fb87b054bf21703244bf475b5a32946defa594e51e8206fbea92a6147b9f1a579ae1d442bf72f76605a6df5441218776b6241711568f7d1312c7ddbdab87e9c7bf59c5f0ff48aa9aba8ee3deca33930eafc2a3a7eff5a0c36efe8a178ab2f5206ab0891b37bf12e75dad904d8c92794f90f7fed2ee3d2e550ba566ecd7769a7cda67c736ec2cbef6c23d4bda50ff075a34f5961c1a9a2e7d87ae902bf00a05acd3cdd7036e8d8e2df9545a070b497168697405f99648cfa8b2c6a929d55f0935a9b3742f70db38e3a9d98a4e882590e206d312ae0c90c05159c287fb7b865dd44382b87691381d835e27c78a527a37ad729a3914b482f890194c11d5810e866d5ed1b47912af72cd3d58fcc094c0d777d3664b28ec37eb8cc9373ae9253b3594e79ad243c307bd6060efdf14e0b4a42734222a6d3017e4ba2d5b7ca37bd65c92283cd7bd18e108a1ba485baee76183f7df7e8f905b8ddb35eb42271ea3096d571bd86135c5e0983524c5d5f9771267aab1bd9902a1e385cb1f2873b8f626e45353ca625555ee214963dc1491bbfc54b2e7533b58f00543008e0414643fac416c069c401afdb64751ee2e9f49412e63af2a9d360bb446fe5f150ee63a37e28a9348374b0eda8ed407681b2c15e337aO425a52505242545b515d"
}

Example Output

{

"message": "OK"

}

GET SystemDetails

Accessible API Keys	WebAPI READ-ONLY, WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

productId*	string	Product ID in question.
computerId*	string	20 digit client computerID.

Output

computerId	string	ComputerID in question.
operatingSystem	string	Client OS.
bitage	int	Client OS Bitage.
screenResX	int	Client screen resolution X.
screenResY	int	Client screen resolution Y.
processor	string	Client Processor.
cores	int	Number of client cores.
memory	int	Client System Memory.
osLanguage	string	Client OS Language.
appLanguage	string	Client Application Language.
type	string	Client System form type - Desktop/Laptop.
licenseStatus	string	Passed Client License Status.
version	string	Passed Client App Version.
build	string	Passed Client App Build.
edition	string	Passed Client App Edition.
computerName	string	Client Computer Name.
vmPlatform	string	VM Platform.

Example Input URL format:

Input data from request URI

https://my.nalpeiron.com/api/v2/systemdetails?productId=6872450105&computerId=kQe0MRH12bYgemkYW2bc

Example Output

{
  "computerId": "kQe0MRH12bYgemkYW2bc",
  "operatingSystem": "Microsoft Windows 10 Home Edition 16299, 64-bit",
  "bitage": "64",
  "screenResX": "1920",
  "screenResY": "1080",
  "processor": "GenuineIntel:Intel(R) Core(TM) i7-4500U CPU @ 1.80GHz",
  "cores": "4",
  "memory": "8090",
  "osLanguage": "en-GB",
  "appLanguage": "en-GB",
  "type": "DESKTOP",
  "licenseStatus": "Activated",
  "version": "2",
  "build": "2",
  "edition": "ENT",
  "computerName": "Work_DESKTOP",
  "vmPlatform": "Physical"
}

GET Company

Accessible API Keys	WebAPI READ-ONLY, WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

companyId*	int	Company ID in question.
productId	string	Product ID in question (optional). Omit for global company.

Output

company	string	Name of the Company.
companyData	JSON	Json metadata containing the company information.
firstName	string	First Name.
email	string	Company email.
search1	string	Searchable field 1.
search2	string	Searchable field 2.
search3	string	Searchable field 3.
created	datetime	Company created date.
productId	string	Corresponding ProductID of the company. ProductID is "0" if the company is global.

Example Input URL format:

Input data from request URI

https://my.nalpeiron.com/api/v2/company?companyId=2

Example Output

{
 "company": "MyCompany LLC",
 "companyData": "{\"firstname\":\"Eva\",\"annual_revenue\":\"$3M\",\"country\":\"UK\",\"custom_data\":\"custom_data1\",\"telephone\":\"+44 8888008818\"}",
 "firstName": "Eva",
 "email": "eva@mycompany.com",
 "search1": "My reference 1",
 "search2": "My reference 2",
 "search3": "My reference 3",
 "created": "2020-01-15T16:47:22.55Z",
 "productId": "6872450105"
}

POST Company

Accessible API Keys	WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

company*	string	Name of the Company. NOTE: Special characters like ' " \ < and > are not allowed.
productId*	string	Product ID in question. NOTE: a productid is required for security purposes even if company is set to 'global' (see below).
global	int	Set to '1' for the company to be global i.e. accessible to all products. Omit otherwise.
companyData	JSON	Json metadata containing the company information. NOTE: Only the special character _ is allowed in custom field names. (currently _ is being used as a replacement for space in the Zentitle UI). Only special characters like _ @ . ! , ; : $ / ' & are allowed in custom field values.
search1	string	Searchable field 1. NOTE: Special characters like ' " \ < and > are not allowed.
search2	string	Searchable field 2. NOTE: Special characters like ' " \ < and > are not allowed.
search3	string	Searchable field 3. NOTE: Special characters like ' " \ < and > are not allowed.
reseller	string	Name of reseller to which the company is to be assigned. Omit for none. Default - none.

Output

"Company Details Created Successfully. The new CompanyID is : <new_company_Id>" or error message.

Example Input:

Input data from request body.

Data - raw:

{
 "company":"SuperStyle LLC",
 "productId":"6872450105",
 "companyData": {"firstname":"Kevin","lastname":"Charles","company":"SuperStyle LLC","email":"kevin@supersytle.com","country":"United Kingdom"},
 "search1":"refernce 1"
}

Example Output

{

"message": "Company Details Created Successfully. The new CompanyID is : 3"

}

PUT Company

Accessible API Keys	WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

companyId*	int	ID of the Company in question.
productId*	string	Product ID in question. NOTE: a productid is required for security purposes even if company is set to 'global' (see below).
global	int	Set to '1' for the company to be global i.e. accessible to all products. Omit otherwise.
companyData	JSON	Json metadata containing the company information. NOTE: If this parameter is omitted, all the original custom fields and values before this call will stay the same and not be updated. If this parameter is supplied with data, all the original fields and values before this call will be replaced with the new data supplied in this input. If you want the original fields and values before this call to be retained, you will need to do a GET Company call first and include the companyData field values in this PUT Company call along with the new fields and values if any. NOTE: Only the special character _ is allowed in custom field names. (currently _ is being used as a replacement for space in the Zentitle UI). Only special characters like _ @ . ! , ; : $ / ' & are allowed in custom field values.
company	string	New unique company name. NOTE: Special characters like ' " \ < and > are not allowed.
search1	string	Searchable field 1. NOTE: Special characters like ' " \ < and > are not allowed.
search2	string	Searchable field 2. NOTE: Special characters like ' " \ < and > are not allowed.
search3	string	Searchable field 3. NOTE: Special characters like ' " \ < and > are not allowed.
reseller	string	Name of reseller to which the company is to be assigned.

Output

"Company Details Updated Successfully" or error message.
For the fields that are not included (omitted), the original field values will stay the same as before the call.

Example Input:

Input data from request body.

Data - raw:

{
 "companyId":"3",
 "productId":"6872450105",
 "company":"SuperStyle Retail LLC",
 "companyData": {"firstname":"John","lastname":"Doe","company":"SuperStyle Retail LLC","email":"john@supersytle.com","country":"UK","telephone":"+44 8898889988"},
 "search2":"refernce 2",
 "search3":"refernce 3"
}

Example Output

{

"message": "Company Details Updated Successfully"

}

DELETE Company

Accessible API Keys	WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

companyId*	int	ID of the Company in question.

Output

"Company Details Deleted Successfully" or error message.

Example Input URL format:

Input data from request URI

https://my.nalpeiron.com/api/v2/company?companyId=5

Example Output

{

"message": "Company Details Deleted Successfully"

}

GET CompanyID

Accessible API Keys	WebAPI READ-ONLY, WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

company*	string	Company name in question.
productId	string	Product ID in question (optional). Omit for global company.

Output

companyId	int	ID of the Company.
company	string	Name of the Company.
productId	string	Corresponding ProductID of the Company. ProductID is "0" if the company is global.
productName	string	Corresponding Product Name of the Company. Product name is empty if the company is global.

Example Input URL format:

Input data from request URI

https://my.nalpeiron.com/api/v2/companyID?company=My%20Company

Example Output

{
 "companyId": "4",
 "company": "My Company",
 "productId": "6872450105",
 "productName": "Product Test 01"
}

GET CompaniesProducts

Gets all Company IDs and associated product IDs.

Accessible API Keys	WebAPI READ-ONLY, WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

None

Output -

one or more sets of:

companyId	int	ID of the Company.
company	string	Name of the Company.
productId	string	Corresponding ProductID of the Company. ProductID is "0" if the company is global.
productName	string	Corresponding Product Name of the Company. Product name is empty if the company is global.

Example Output

[
 {
 "companyId": "4",
 "company": "My Company",
 "productId": "6872450105",
 "productName": "Product Test 01"
 },
 {
  "companyId": "5",
  "company": "ABC ltd",
  "productId": "6872450106",
  "productName": "Product Test 02"
 },
 {
 "companyId": "6",
 "company": "BigCorp",
 "productId": "0",
 "productName": ""
 }
]

GET Group

Accessible API Keys	WebAPI READ-ONLY, WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

groupId**	int	ID of the group in question.
groupName**	string	Name of the group in question.

**Either groupId or groupName must be supplied, not both.

Output

groupId		int	ID of group.
type		string	Group type - Master or Standard.
masterGroupId		int	ID of master group.
groupName		string	Name of group.
description		string	Group description.
created		datetime	Date when group was created.
modified		datetime	Date when group was last modified.
companyId		int	ID of company to which group is assigned (0=none).
groupLicenses (for each groupLicense)	groupId	int	ID of group to which license code is assigned.
	productId	string	Product ID of license code.
	licenseCode	string	Assigned license code.
	created	datetime	Creation date of license code assignment to group.
groupUsers (for each groupUser)	groupUserId	int	ID of group user.
	groupId	int	ID of group.
	userName	string	Username of user.
	firstName	string	User first name.
	lastName	string	User last name.
	email	string	User email address.
	telephone	string	User telephone number.
	additionalData	JSON	Additional metadata.
	created	datetime	Creation date of group user.
	modified	datetime	Last modified date of group user.
subGroups (for each subGroup)	groupId	int	ID of subgroup.
subGroups (for each subGroup)	groupName	string	Name of subgroup.

Example Input URL format:

Input data from request URI

https://my.nalpeiron.com/api/v2/group?groupId=9

Example Output

{
 "groupId": 9,
 "type": "Master",
 "masterGroupId": 0,
 "groupName": "TestGroup",
 "description": "test group",
 "created": "2018-08-31T09:40:48.043Z",
 "modified": "2018-08-31T09:40:48.043Z",
 "companyId": 3,
 "groupLicenses": [
                  {
                  "groupId": 9,
                  "productId": "6872450105",
                  "licenseCode": "278371835707856940",
                  "created": "2018-10-24T06:01:24.91Z"
                  }
                  ],
 "groupUsers": [
               {
               "groupUserId": 7,
               "groupId": 9,
               "userName": "test1",
               "firstName": "John",
               "lastName": "Smith",
               "email": "john@test1.com",
               "telephone": "+1 8888989988",
               "additionalData": "{\"EUPMaster\":\"true\"}",
               "created": "2020-10-21T18:15:43.193Z",
               "modified": "2020-10-21T18:15:43.193Z"
               },
               {
               "groupUserId": 8,
               "groupId": 9,
               "userName": "testgroupuser8",
               "firstName": "Sam",
               "lastName": "Rivers",
               "email": "sam@test4.com",
               "telephone": "+1 8888989989",
               "additionalData": "{\"EUPMaster\":\"true\",\"description\":\"settomaster\"}",
               "created": "2020-10-22T08:52:23.28Z",
               "modified": "2020-12-18T15:52:32.71Z"
               }
               ],
"subGroups": [
             {
            "groupId": 10,
            "groupName": "Subgroup1"
             },
             {
             "groupId": 11,
             "groupName": "GroupTest"
             }
             ]
 }

POST Group

Accessible API Keys	WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

groupName*	string	Name of group.
type*	string	Group type - Master or Standard. Must be either master or standard.
description	string	Description of group.
masterGroupId	int	ID of master group to which the group is to be assigned (optional). Omit to not assign to any master group (set to 0) - default - 0.
companyId	int	ID of the company to which the group is to be assigned (optional). Omit to not assign to any company (set to 0) - default - 0.

Output

"Group Created Successfully. The new Group ID is : <new_groupid>" or error message.

Example Input:

Input data from request body.

Data - raw:

{
"groupName": "NewGroup17",
"type": "standard",
"description": "NewGroup17 Created to test",
"companyId": "2"
}

Example Output

{

"message": "Group Created Successfully. The new Group ID is : 12"

}

PUT Group

Accessible API Keys	WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

groupId*	int	ID of group in question.
groupName	string	New unique name of group.
type	string	Group type - Master or Standard. Must be either master or standard.
description	string	Description of group.
masterGroupId	int	ID of master group to which the group is to be assigned.
companyId	int	ID of the company to which the group is to be assigned.

Output

"Group Updated Successfully" or error message.
For the fields that are not included (omitted), the original field values will stay the same as before the call.

Example Input:

Input data from request body.

Data - raw:

{
"groupId": "12",
"type": "master",
"description": "NewGroup17 updated to master group"
}

Example Output

{

"message": "Group Updated Successfully"

}

DELETE Group

Accessible API Keys	WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

groupId**	int	ID of the group in question.
groupName**	string	Name of the group in question.

**Either groupid or groupname must be supplied, not both.

Output

"Group Deleted Successfully" or error message.

Example Input URL format:

Input data from request URI

https://my.nalpeiron.com/api/v2/group?groupId=10

Example Output

{

"message": "Group Deleted Successfully"

}

GET Groups

Accessible API Keys	WebAPI READ-ONLY, WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

pageNumber	int	If >0 then returns the results on that page. If 0 or omitted then returns only the number of records (count) (optional).
pageSize	int	Number of records per page (default and max. value=10000) (optional).

Output :

If pageNumber parameter is 0 or omitted then returns only the count of records.

Else, returns one or more sets of:

groupId		int	ID of group.
type		string	Group type - Master or Standard.
masterGroupId		int	ID of master group.
groupName		string	Name of group.
description		string	Group description.
created		datetime	Date when group was created.
modified		datetime	Date when group was last modified.
companyId		int	ID of company to which group is assigned (0=none).
groupLicenses (for each groupLicense)	groupId	int	ID of group to which license code is assigned.
	productId	string	Product ID of license code.
	licenseCode	string	Assigned license code.
	created	datetime	Creation date of license code assignment to group.
groupUsers (for each groupUser)	groupUserId	int	ID of group user.
	groupId	int	ID of group.
	userName	string	Username of user.
	firstName	string	User first name.
	lastName	string	User last name.
	email	string	User email address.
	telephone	string	User telephone number.
	additionalData	JSON	Additional metadata.
	created	datetime	Creation date of group user.
	modified	datetime	Last modified date of group user.
subGroups (for each subGroup)	groupId	int	ID of subgroup.
subGroups (for each subGroup)	groupName	string	Name of subgroup.

Example Input URL format:

Input data from request URI

https://my.nalpeiron.com/api/v2/groups?pageNumber=1&pageSize=2

Example Output

[
{
"groupId": 9,
"type": "Master",
"masterGroupId": 0,
"groupName": "TestGroup",
"description": "test group",
"created": "2018-08-31T09:40:48.043Z",
"modified": "2018-08-31T09:40:48.043Z",
"companyId": 3,
"groupLicenses": [
{
"groupId": 9,
"productId": "6872450105",
"licenseCode": "278371835707856940",
"created": "2018-10-24T06:01:24.91Z"
}
],
"groupUsers": [
{
"groupUserId": 7,
"groupId": 9,
"userName": "test1",
"firstName": "John",
"lastName": "Smith",
"email": "john@test1.com",
"telephone": "+1 8888989988",
"additionalData": "{\"EUPMaster\":\"true\"}",
"created": "2020-10-21T18:15:43.193Z",
"modified": "2020-10-21T18:15:43.193Z"
},
{
"groupUserId": 8,
"groupId": 9,
"userName": "testgroupuser8",
"firstName": "Sam",
"lastName": "Rivers",
"email": "sam@test4.com",
"telephone": "+1 8888989989",
"additionalData": "{\"EUPMaster\":\"true\",\"description\":\"settomaster\"}",
"created": "2020-10-22T08:52:23.28Z",
"modified": "2020-12-18T15:52:32.71Z"
}
],
"subGroups": [
{
"groupId": 15,
"groupName": "Subgroup1"
},
{
"groupId": 16,
"groupName": "GroupTest"
}
]
},
{
"groupId": 10,
"type": "Master",
"masterGroupId": 0,
"groupName": "TestGroup1",
"description": "test group1",
"created": "2018-08-31T09:40:48.043Z",
"modified": "2018-08-31T09:40:48.043Z",
"companyId": 4,
"groupLicenses": [
{
"groupId": 10,
"productId": "7272450105",
"licenseCode": "272371835707856940",
"created": "2018-10-24T06:01:24.91Z"
}
],
"groupUsers": [
{
"groupUserId": 17,
"groupId": 10,
"userName": "test1",
"firstName": "John",
"lastName": "Smith",
"email": "john@test1.com",
"telephone": "+1 8888989988",
"additionalData": "{\"EUPMaster\":\"true\"}",
"created": "2020-10-21T18:15:43.193Z",
"modified": "2020-10-21T18:15:43.193Z"
},
{
"groupUserId": 18,
"groupId": 10,
"userName": "testgroupuser8",
"firstName": "Sam",
"lastName": "Rivers",
"email": "sam@test4.com",
"telephone": "+1 8888989989",
"additionalData": "{\"EUPMaster\":\"true\",\"description\":\"settomaster\"}",
"created": "2020-10-22T08:52:23.28Z",
"modified": "2020-12-18T15:52:32.71Z"
}
],
"subGroups": [
{
"groupId": 18,
"groupName": "Subgroup2"
},
{
"groupId": 11,
"groupName": "GroupTest2"
}
]
}
]

GET GroupUser

Accessible API Keys	WebAPI READ-ONLY, WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

groupUserId**	int	ID of group user in question.
userName**	string	Name of group user in question.

**Either groupUserId or userName must be supplied, not both.

Output

groupUserId	int	ID of the group user.
groupId	int	ID of group.
userName	string	Username of user.
firstName	string	User first name.
lastName	string	User last name.
email	string	User email address.
telephone	string	User telephone number.
additionalData	JSON	Json metadata containing additional data.
created	datetime	Creation date of group user.
modified	datetime	Last modification date of group user.

Example Input URL format:

Input data from request URI

https://my.nalpeiron.com/api/v2/groupuser?groupUserId=7

Example Output

{
 "groupUserId": 7,
 "groupId": 9,
 "userName": "testgroupuser7",
 "firstName": "John",
 "lastName": "Smith",
 "email": "john@test.com",
 "telephone": "+44 9988998899",
 "additionalData": "{\"EUPMaster\":\"true\",\"description\":\"settomaster\"}",
 "created": "2020-10-22T08:52:23.28Z",
 "modified": "2020-12-18T15:52:32.71Z"
}

POST GroupUser

Accessible API Keys	WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

groupId*	int	ID of group to which group user is to be assigned.
userName*	string	Username of user.
password*	string	Password of user.
firstName	string	User first name.
lastName	string	User last name.
email	string	User email address.
telephone	string	User telephone number.
additionalData	JSON	Json metadata containing additional data. Current options: {"EUPMaster":true}. This gives the user master privileges even if group is not a master group.

Output

"Group User Created Successfully. The new Group User ID is : <new_groupuserid>" or error message.

Example Input:

Input data from request body.

Data - raw:

{
 "groupId":"9",
 "userName": "testuser31",
 "password": "testuserpassword",
 "firstName": "John",
 "email": "john@test31.com",
 "additionalData": {"EUPMaster":"true"}
}

Example Output

{

"message": "Group User Created Successfully. The new Group User ID is : 5"

}

PUT GroupUser

Accessible API Keys	WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

groupUserId*	int	ID of group user in question.
groupId*	int	ID of group to which user is to be assigned.
userName	string	New username of user.
firstName	string	User first name.
lastName	string	User last name.
email	string	User email address.
telephone	string	User telephone number.
additionalData	JSON	Json metadata containing additional data. Current options: {"EUPMaster":true}. This gives the user master privileges even if group is not a master group.

Output

"Group User Updated Successfully" or error message.
For the fields that are not included (omitted), the original field values will stay the same as before the call.

Example Input:

Input data from request body.

Data - raw:

{
 "groupUserId":"7",
 "groupId":"9",
 "userName": "test32",
 "firstName": "John",
 "lastName": "Smith",
 "additionalData": {"EUPMaster":"true","description":"settomaster","customdata":"data1"}
}

Example Output

{

"message": "Group User Updated Successfully"

}

DELETE GroupUser

Accessible API Keys	WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

groupUserId*	int	ID of the group user in question.

Output

"Group User Deleted Successfully" or error message.

Example Input URL format:

Input data from request URI

https://my.nalpeiron.com/api/v2/groupuser?groupUserId=10

Example Output

{

"message": "Group User Deleted Successfully"

}

PUT GroupUserPassword

Accessible API Keys	WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

userName*	string	Username of group user in question.
password*	string	New password.

Output

"Group User Password Updated Successfully" or error message.

Example Input:

Input data from request body.

Data - raw:

{
 "userName": "testuser21",
 "password": "test21PassWord"
}

Example Output

{

"message": "Group User Password Updated Successfully"

}

GET GroupLicenseCode

Accessible API Keys	WebAPI READ-ONLY, WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

productId*	string	Product ID of license code in question.
licenseCode*	string	License code in question.

Output

groupId	int	ID of group to which license code is assigned.
productId	string	Product ID of license code.
licenseCode	string	Assigned license code.
created	datetime	Creation date of license code assignment to group.

Example Input URL format:

Input data from request URI

https://my.nalpeiron.com/api/v2/grouplicensecode?productId=6872450105&licenseCode=27835001310249256

Example Output

{
 "groupId": 6,
 "productId": "6872450105",
 "licenseCode": "27835001310249256",
 "created": "2019-12-18T17:09:53.39"
}

POST GroupLicenseCode

Accessible API Keys	WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

groupId*	int	ID of group to which license code is to be assigned.
productId*	string	Product ID of license code to be assigned.
licenseCode*	string	license code to be assigned.
companyId	int	ID of the company to which the license code is to be assigned (optional). Omit to not assign to any company (set to 0) - default (if omitted) - 0.
profileId	int	ID of the profile to which the license code is to be assigned (optional). Omit to not assign to any profile (set to 0) - default (if omitted) - 0.

Output

"Group License Code Added Successfully" or error message.

Example Input:

Input data from request body.

Data - raw:

{
 "groupId":"7",
 "productId": "6872450105",
 "licenseCode": "27835001310249256",
 "companyId":"2",
 "profileId":"1"
}

Example Output

{

"message": "Group License Code Added Successfully"

}

DELETE GroupLicenseCode

Unassigns a license code from a group.

Accessible API Keys	WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

groupId*	int	ID of group from which license code will be unassigned.
productId*	string	Product ID of license code to be unassigned.
licenseCode*	string	License code to be unassigned.

Output

"Group License Code Deleted Successfully" or error message.

Example Input URL format:

Input data from request URI

https://my.nalpeiron.com/api/v2/grouplicensecode?groupId=7&productId=6872450105&licenseCode=27835001310249256

Example Output

{

"message": "Group License Code Deleted Successfully"

}

POST GroupUserLicense

Accessible API Keys	WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

groupName*	string	New unique name of group.
productId*	string	ID of product of license code to be assigned.
licenseCode*	string	License code to be assigned
userName*	string	New username of user.
password*	string	password of user.
firstName	string	User first name.
lastName	string	User last name.
email	string	User email address.
telephone	string	User telephone number.
additionalData	JSON	Json metadata containing additional data. Current options: {"EUPMaster":true}. This gives the user master privileges even if group is not a master group.

Output

"Group User License Created Successfully. The new Group ID is : <new_groupid> and new Group User ID is : <new_groupuserid>" or error message.

Example Input:

Input data from request body.

Data - raw:

{
 "groupName": "NewGroup1",
 "userName": "testuser1",
 "password": "test1Password",
 "productId": "6872450105",
 "licenseCode":"27835001310249256",
 "firstName": "John",
 "lastName": "Smith",
 "additionalData": {"EUPMaster":"true","description":"settomaster","customdata":"data1"}
}

Example Output

{

"message": "Group User License Created Successfully. The new Group ID is : 9 and new Group User ID is : 15"

}

GET LicenseNote

Accessible API Keys	WebAPI READ-ONLY, WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

productId*	string	Product ID of license code in question.
licenseCode*	string	License code to which the note belongs.

Output -

one or more sets of:

noteId	int	ID of license note.
type	string	License note type - general or system.
created	datetime	License note created date.
createdBy	string	Logged in user name or blank if created by webservices.
description	string	Text content of the note.

Example Input URL format:

Input data from request URI

https://my.nalpeiron.com/api/v2/licensenote?productId=6872450105&licenseCode=27835001310249256

Example Output

[
 {
  "noteId": 11,
  "type": "General",
  "created": "2019-01-05T21:41:28.72Z",
  "createdBy": "",
  "description": "Rest API general note"
 },
 {
  "noteId": 12,
  "type": "System",
  "created": "2019-01-07T13:46:16.257Z",
  "createdBy": "",
  "description": "note"
 }
]

POST LicenseNote

Accessible API Keys	WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

productId*	string	Product ID of license code.
licenseCode*	string	License code to which the note belongs.
type*	string	Must be either general or system.
description*	string	Text content of the note.

Output

"License Note Created Successfully. The new NoteID is : <new_noteid>" or error message.

Example Input:

Input data from request body.

Data - raw:

{
 "productId": "6872450105",
 "licenseCode":"27835001310249256",
 "description":"General note",
 "type":"general"
}

Example Output

{

"message": "License Note Created Successfully. The new NoteID is : 10"

}

PUT LicenseNote

Accessible API Keys	WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

productId*	string	Product ID of license code.
licenseCode*	string	License code to which the note belongs.
noteId*	int	ID of the license note.
type	string	Must be either general or system.
description	string	Text content of the note.

Output

"License Note Updated Successfully" or error message.

Example Input:

Input data from request body.

Data - raw:

{
 "productId": "6872450105",
 "licenseCode":"27835001310249256",
 "noteId":"10",
 "description":"General note updated",
 "type":"general"
}

Example Output

{

"message": "License Note Updated Successfully"

}

DELETE LicenseNote

Accessible API Keys	WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

productId*	string	Product ID of license code.
licenseCode*	string	License code to which the note belongs.
noteId	int	ID of the license note. If 0 or omitted deletes all notes corresponding to the specified license code.

Output

"License Note Deleted Successfully" or error message.

Example Input URL format:

Input data from request URI

https://my.nalpeiron.com/api/v2/licensenote?productId=6872450105&licenseCode=27835001310249256&noteid=10

Example Output

{

"message": "License Note Deleted Successfully"

}

GET AuthenticateUser

Accessible API Keys	WebAPI READ-ONLY, WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

userName*	string	Username to be authenticated.
password*	string	Password to be authenticated.

Output

"OK" or error message.

Example Input URL format:

Input data from request URI

https://my.nalpeiron.com/api/v2/authenticateuser?userName=testuser21&password=test21PassWord

Example Output

{

"message": "OK"

}

GET DataStreamer

Accessible API Keys	WebAPI DS

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

eventType*	string	The DataStreamer eventType. Must be either of : 'NSA', 'NSL', 'UI', 'WS', 'REST', 'DNSA', 'DAudit', 'Custom' or 'All'.
startDate*	datetime	Gets the records created from the specified start date.
endDate*	datetime	Gets the records created until the specified end date.
event	string	Gets the records for events that contain supplied event string. If omitted, it returns all events for the supplied eventType.
fail	string	Must be either 'true' or 'false' - If omitted it returns all events. If 'true' returns only those with '(Fail)' in the event name. If 'false' returns only those without '(Fail)' in the event name.
productId	string	Gets the records for the specified productID.
userId	string	Gets the records for the specified userID.
licenseCode	string	Gets the records for the specified licenseCode.

Output -

one or more sets of:

clientCreated	datetime	Client Created datetime of the DataStreamer record.
created	datetime	Created datetime of the DataStreamer record.
eventType	string	The event type of the DataStreamer record.
event	string	The event of the DataStreamer record.
payload	string	Payload json data.
ip	string	IP address related to the DataStreamer record.
processed	string	DataStreamer record processed (true) or not (false).
userId	string	UserID releated to the DataStreamer record.

Example Input URL format:

Input data from request URI

https://my.nalpeiron.com/api/v2/DataStreamer?eventType=REST&startDate=2021-06-16T00:00:00.083Z&endDate=2021-07-26T00:00:00.083Z&productId=6872450105&licenseCode=27835001310249256

Example Output

[
{
"clientCreated": "2021-06-25T18:49:20.844Z",
"created": "2021-06-25T18:49:21.083Z",
"eventType": "REST",
"event": "Post-DataStreamerV2Controller (Fail)",
"payload": {
           "data": "TestDSEvent",
           "licenseCode": "27835001310249256",
           "product": "APITest 0110",
           "payload": "data",
           "error": "Error: Incorrect Data. Creating DataStreamer Event Failed"
           },
"ip": "",
"processed": true,
"userId": "6bcde716-70d9-4fa4-8bbe-b95a2ca05208"
},
{
"clientCreated": "2021-07-16T12:59:05.51Z",
"created": "2021-07-16T12:59:06.106Z",
"eventType": "REST",
"event": "Post-DataStreamerV2Controller",
"payload": {
          "data": "abcdefgh12345",
          "profile": "testingProfile5",
          "companyId": 17,
          "licenseCode": "27835001310249256",
          "product": "APITest 0110"
          },
"ip": "",
"processed": true,
"userId": "172ca7c8-e57e-4094-b587-53f6c01deb6d"
}
]

POST DataStreamer

Accessible API Keys	WebAPI DS

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

event*	string	User-defined event name.
productId	string	Product ID to be associated with.
payload	string	User-defined json data.

Output

"DataStreamer Event Created Successfully" or error message.

Example Input:

Input data from request body.

Data - raw:

{
 "event": "TestDSEvent",
 "productId": "6872450105",
 "payload":
          {
           "data": "abcdefgh12345",
           "profile": "testingProfile5",
           "companyId":17,
           "features":
                    {
                    "featureCode": "FEAT2",
                    "featureAvailability": "on",
                    "limit": "1"
                    },
           "udfValues": [
                        {
                        "fieldName": "TEST1",
                        "defaultValue": "udf1"
                        },
                        {
                        "fieldName": "TEST2",
                        "defaultValue": "udf3"
                        }
                        ]
           }
}

Example Output

{

"message": "DataStreamer Event Created Successfully"

}

PUT ConsumptionTokens

Accessible API Keys	WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

productId*	string	Product ID of the ConsumptionToken feature to be updated.
licenseCode*	string	License code of the ConsumptionToken feature to be updated.
featureCode*	string	Feature code of the ConsumptionToken feature to be updated.
tokenMax**	int	ConsumptionToken TokenMax Limit for the feature to be updated. Must be between 0 and 2000000000. (can be set to 0).
checkedOutTokens**	int	Desired checkedOutTokens current value to be updated for the specified computerId.
computerId	string	Computer ID for which current checkedOutTokens value is to be updated. (Mandatory to update checkedOutTokens value).

**tokenMax and/or checkedOutTokens value is required for this API call.

Output

"ConsumptionToken data Updated Successfully" or error message.

Example Input:

Input data from request body.

Data - raw:

{
"productId": "6872450105",
"licenseCode":"27835001310249256",
"featureCode":"TOKEN",
"tokenMax":"200",
"computerId": "71zGPlu4Jwg3i2wFEW1X",
"checkedOutTokens":10
}

Example Output

{

"message": "ConsumptionToken data Updated Successfully"

}

POST APIKey

Accessible API Keys	WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

keyType*	string	The API key type to be created. Must be either of - 'SaaS', 'WebAPI READ-ONLY', 'WebAPI READ-WRITE', 'WebAPI Offline', 'WebAPI DS'.
description	string	Description of the API key.

Output

"API Key Created Successfully. The new API Key is : <new key>" or error message.

Example Input:

Input data from request body.

Data - raw:

{
"keyType" : "WebAPI READ-ONLY",
"description" : "Read-Only Web API key"
}

Example Output

{

"message": "API Key Created Successfully. The new API Key is : bO6Hz4q23clFabkH"

}

PUT APIKey

Accessible API Keys	WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

key*	string	The API Key to be updated.
keyType	string	The API key type to be updated. Omit to not update the existing keyType. If supplied, must be either of - 'SaaS', 'WebAPI READ-ONLY', 'WebAPI READ-WRITE', 'WebAPI Offline', 'WebAPI DS'.
description	string	Description of the API key. Omit to not update the existing description.

Output

"API Key Updated Successfully" or error message.

Example Input:

Input data from request body.

Data - raw:

{
"key": "bO6Hz4q23clFabkH",
"keyType" : "WebAPI READ-WRITE",
"description" : "Read-Write Web API key updated"
}

Example Output

{

"message": "API Key Updated Successfully"

}

DELETE APIKey

Accessible API Keys	WebAPI READ-WRITE

Inputs

Header:

Authorization: bearer	The format is <customerID>:<APIKey> for example - 1234:abcd12wV4D1Hxjf
Content-Type:	application/json

Data:

key*		string	The API Key to be deleted.

Output

"API Key Deleted Successfully" or error message.

Example Input URL format:

Input data from request URI

https://my.nalpeiron.com/api/v2/APIKey?key=lKfFOhfKK2FLXcVJ

Example Output

{

"message": "API Key Deleted Successfully"

}