License API Collection

base url and authentication requirements license api base url all license api requests must use the license api domain https //api licensespring com do not use https //saas licensespring com for license api requests the saas domain is reserved for the management api required authentication keys the license api supports the following authentication methods apikey sharedkey both keys must be configured in the environment for shared key authentication workflows oauth authentication (optional) if using the oauth version of the license api, the following credentials are required client id client secret the oauth collection will obtain an access token using these values and automatically apply it to subsequent requests license api environment variables used by license api and license api – oauth collections variable description default product code product code associated with the license default license key license key used for activation/validation default hardware id hardware id for binding and validation default feature code feature identifier for license feature operations default username / default password used for user based licenses default customer account code customer account reference used by some endpoints default license id / default bundle code identifiers for specific license or bundle operations request required for offline flows must be set to activation or deactivation values can be set manually or retrieved through license api requests or the licensespring ui please populate fields based on your use case for each endpoint how the collections work license api collection purpose to interact with licensing endpoints using either api key/shared key authentication requirements most requests require default product code default license key default hardware id headers such as date and authorization are generated automatically license api oauth collection purpose to interact with license api endpoints using oauth 2 0 authentication usage set client id and client secret in the environment from opur vendor platform the collection obtains an access token automatically and uses it for all subsequent licensing requests manual variable adjustment (optional) if you want to test with a specific license key, hardware id, feature code, or bundle id, you may replace the corresponding environment variable manually for example open the licensespring platform ui copy the license key or product code you want to test paste it into the relevant environment variable (default license key, default product code, etc ) re run the desired request you may also temporarily place literal values directly into the request body every needed variable can be found and created through our vendor platform offline licensing notes some license api workflows require special handling offline activation offline deactivation v2 offline schema in these cases, the variable request must be set to activation or deactivation ensure the final json object in the body does not contain trailing commas when uncommenting optional parameters examples of available offline requests v1 used for activation/deactivation {{offline request file}} > used for key based license {{offline request file bundle}} > used for key based bundle licenses {{offline request file user} } > used for user based licenses {{offline request file user}} > can also be used for user based licenses if default product code points to bundle code, can be done inside environment by setting that variable examples of available offline requests v2 used for activation/deactivation {{offline request file v2}} > key based licenses also can be used for bundle if default product code set to bundle code,can be done inside environment by setting that variable {{offline request file v2 user}} > user based licenses also can be used for bundle if default product code set to bundle code, can be done inside environment by setting that variable data manipulation for manual data manipulation, the same principles apply as with the management api if any aspect is unclear, kindly consult our official docid 35hksz8vrz5kpu1h8ehqb documentation for each request please check your company settings and under preferences tab you will see some of the license api requests depends on the selected settings in order to work, so keep that in mind remember to review any comments associated with each request for instance, to enable the floating release functionality, you should edit the desired license, verify the floating cloud checkbox via the platform, and subsequently execute the request to ensure proper operation floating cloud checkbox selected floating release example comment verify floating cloud status on desired license via platform here's an example of how to perform this check using two different scenarios license based and user based license based verification for license based verification, use the following request body { "license key" "{{activate}}", "hardware id" "{{hardware id}}", "product" "{{product code}}" } user based verification for user based verification, utilize the following request body { "hardware id" "{{default hardware id}}", "product" "{{default product code}}", "username" "{{default username}}", "password" "{{default password}}", } note you can also use the same environment as on our management api with the provided data