License Manager

29min
LicenseManager
Provides a high-level interface for managing licenses, including local licenses. The LicenseManager is required to work with local license files. Typescript definitions are provided for the arguments and return types of the class methods.
To import the LicenseManager class use:
JS
const { LicenseManager } = require('@licensespring/node-sdk');
const { LicenseManager } = require('@licensespring/node-sdk');
﻿
To create an instance:
JS
const licenseManager = new LicenseManager({
  apiKey: '12345678-4bfe-4e3a-8737-757004d6294c',
  sharedKey: 'eYuHrlajvIVTiSFIXpxpKhw78f4Ewy-00-12345678',
  appName: 'js-sdk-test-1',
  appVersion: '0.0.1',
  productCode: 'lkp',
  /** NOTE: the following properties are set to their default values by the SDK and can be overriden manually: */
  // apiPath: 'http://api.dev.licensespring.com/api/v4',
  // publicKey: '...',
});
const licenseManager = new LicenseManager({
  apiKey: '12345678-4bfe-4e3a-8737-757004d6294c',
  sharedKey: 'eYuHrlajvIVTiSFIXpxpKhw78f4Ewy-00-12345678',
  appName: 'js-sdk-test-1',
  appVersion: '0.0.1',
  productCode: 'lkp',
  /** NOTE: the following properties are set to their default values by the SDK and can be overriden manually: */
  // apiPath: 'http://api.dev.licensespring.com/api/v4',
  // publicKey: '...',
});
﻿
The constructor takes the a single argument of the following type:
TypeScript
{
  /** your Licensespring API key */
  apiKey: string,
  /** your Licensespring API Shared key **/
  sharedKey: string,
  /** custom name for your application */
  appName: string,
  /** custom version string for your application */
  appVersion: string,
  /** your product short code */
  productCode: string,
  /** your Air Gap Activation key (optional) */
  airGapKey?: string,
  /** override for License API url (default is https://api.licensespring.com/api/v4/) **/
  apiPath?: string,
  /** override for License API public key (default is pub key for api.licensespring.com) **/
  publicKey?: string,
  /** override for License File filename (default is "License") */
  filename?: string,
  /** override for License File path (default is current directory) */
  filePath?: string,
  /** override for License File encryption key */
  fileKey?: string,
  /** override for license grace period duration in hours (default is 24) */
  gracePeriod?: number,
  /** override for License File guard file (default is false) */
  isGuardFileEnabled?: boolean,
  /** override for Hardware ID calculation method (default is 0, for more info see "Hardware ID" section) */
  hardwareIDMethod?: number,
}
{
  /** your Licensespring API key */
  apiKey: string,
  /** your Licensespring API Shared key **/
  sharedKey: string,
  /** custom name for your application */
  appName: string,
  /** custom version string for your application */
  appVersion: string,
  /** your product short code */
  productCode: string,
  /** your Air Gap Activation key (optional) */
  airGapKey?: string,
  /** override for License API url (default is https://api.licensespring.com/api/v4/) **/
  apiPath?: string,
  /** override for License API public key (default is pub key for api.licensespring.com) **/
  publicKey?: string,
  /** override for License File filename (default is "License") */
  filename?: string,
  /** override for License File path (default is current directory) */
  filePath?: string,
  /** override for License File encryption key */
  fileKey?: string,
  /** override for license grace period duration in hours (default is 24) */
  gracePeriod?: number,
  /** override for License File guard file (default is false) */
  isGuardFileEnabled?: boolean,
  /** override for Hardware ID calculation method (default is 0, for more info see "Hardware ID" section) */
  hardwareIDMethod?: number,
}
﻿
Methods
Methods that take a Managed License identificator are the same as in License API, except that product and hardware_id do not have to be specified in the payload as they are provided by the License Manager object.
Check License
﻿https://docs.licensespring.com/license-api/check﻿
TypeScript
checkLicense(payload: Managed<LicenseIdentificator>): Promise<LicenseResponse>
checkLicense(payload: Managed<LicenseIdentificator>): Promise<LicenseResponse>
﻿
Activate License Online
﻿https://docs.licensespring.com/license-api/activation-deactivation/activation﻿
TypeScript
activateLicense(payload: Managed<LicenseIdentificatorWithVariables>): Promise<LicenseResponse>
activateLicense(payload: Managed<LicenseIdentificatorWithVariables>): Promise<LicenseResponse>
﻿
Deactivate License Online
﻿https://docs.licensespring.com/license-api/activation-deactivation/deactivation﻿
TypeScript
deactivateLicense(payload: Managed<LicenseIdentificator>): Promise<boolean>
deactivateLicense(payload: Managed<LicenseIdentificator>): Promise<boolean>
﻿
Activate License Offline
﻿https://docs.licensespring.com/license-api/activation-deactivation/offline-activation﻿
TypeScript
activateOffline(payload: Managed<LicenseIdentificatorOfflineWithVariables>): Promise<LicenseResponseOffline>
activateOffline(payload: Managed<LicenseIdentificatorOfflineWithVariables>): Promise<LicenseResponseOffline>
﻿
Deactivate License Offline
﻿https://docs.licensespring.com/license-api/activation-deactivation/offline-deactivation﻿
TypeScript
deactivateOffline(payload: Managed<LicenseIdentificator>): Promise<boolean>
deactivateOffline(payload: Managed<LicenseIdentificator>): Promise<boolean>
﻿
Get Trial Key
﻿https://docs.licensespring.com/license-api/trial-key﻿
TypeScript
getTrialKey(payload: Managed<TrialKeyPayload>): Promise<LicenseTrialResponse>
getTrialKey(payload: Managed<TrialKeyPayload>): Promise<LicenseTrialResponse>
﻿
List Licenses for User
﻿https://docs.licensespring.com/license-api/user-licenses﻿
TypeScript
getUserLicenses(payload: Managed<GetUserLicensesPayload>): Promise<LicenseResponse[]>
getUserLicenses(payload: Managed<GetUserLicensesPayload>): Promise<LicenseResponse[]>
﻿
List License Users for Customer
﻿https://docs.licensespring.com/license-api/customer-license-users﻿
TypeScript
getCustomerLicenseUsers(payload: Managed<GetCustomerLicensesPayload>): Promise<CustomerLicenseUsersResponse>
getCustomerLicenseUsers(payload: Managed<GetCustomerLicensesPayload>): Promise<CustomerLicenseUsersResponse>
﻿
Check License Feature
﻿https://docs.licensespring.com/license-api/license-feature-check﻿
TypeScript
checkLicenseFeature(payload: Managed<LicenseIdentificatorAndFeature>): Promise<LicenseFeatureResponse>
checkLicenseFeature(payload: Managed<LicenseIdentificatorAndFeature>): Promise<LicenseFeatureResponse>
﻿
Add License Consumption
﻿https://docs.licensespring.com/license-api/consumption/add﻿
TypeScript
addConsumption(payload: Managed<LicenseIdentificatorAddConsumptions>): Promise<LicenseConsumptionsResponse>
addConsumption(payload: Managed<LicenseIdentificatorAddConsumptions>): Promise<LicenseConsumptionsResponse>
﻿
Add Feature Consumption
﻿https://docs.licensespring.com/license-api/consumption/add-feature﻿
TypeScript
addFeatureConsumption(payload: Managed<LicenseIdentificatorAddFeatureConsumptions>): Promise<LicenseFeatureConsumptionResponse>
addFeatureConsumption(payload: Managed<LicenseIdentificatorAddFeatureConsumptions>): Promise<LicenseFeatureConsumptionResponse>
﻿
Get Product Details
﻿https://docs.licensespring.com/license-api/product-details﻿
TypeScript
getProductDetails(payload: Managed<ProductDetailsPayload>): Promise<ProductDetailsResponse>
getProductDetails(payload: Managed<ProductDetailsPayload>): Promise<ProductDetailsResponse>
﻿
Get Device Variables
﻿https://docs.licensespring.com/license-api/device-variables/get﻿
TypeScript
getDeviceVariables(payload: Managed<LicenseIdentificator>): Promise<DeviceVariable[]>
getDeviceVariables(payload: Managed<LicenseIdentificator>): Promise<DeviceVariable[]>
﻿
Track Device Variables
﻿https://docs.licensespring.com/license-api/device-variables/track﻿
TypeScript
trackDeviceVariables(payload: Managed<LicenseIdentificatorWithVariables>): Promise<DeviceVariable[]>
trackDeviceVariables(payload: Managed<LicenseIdentificatorWithVariables>): Promise<DeviceVariable[]>
﻿
Borrow Floating License
﻿https://docs.licensespring.com/license-api/floating/license/borrow﻿
TypeScript
floatingBorrow(payload: Managed<LicenseIdentificatorWithBorrowedUntil>): Promise<LicenseBorrowResponse>
floatingBorrow(payload: Managed<LicenseIdentificatorWithBorrowedUntil>): Promise<LicenseBorrowResponse>
﻿
Release Floating License
﻿https://docs.licensespring.com/license-api/floating/license/release﻿
TypeScript
floatingRelease(payload: Managed<LicenseIdentificator>): Promise<boolean>
floatingRelease(payload: Managed<LicenseIdentificator>): Promise<boolean>
﻿
Release Floating Feature
﻿https://docs.licensespring.com/license-api/floating/feature/release﻿
TypeScript
featureRelease(payload: Managed<LicenseIdentificatorAndFeature>): Promise<boolean>
featureRelease(payload: Managed<LicenseIdentificatorAndFeature>): Promise<boolean>
﻿
Change Password
﻿https://docs.licensespring.com/license-api/change-password﻿
TypeScript
changePassword(payload: PasswordChangePayload): Promise<boolean>
changePassword(payload: PasswordChangePayload): Promise<boolean>
﻿
Get Product Versions
﻿https://docs.licensespring.com/license-api/versions﻿
TypeScript
getVersions(payload: Managed<LicenseIdentificator>): Promise<VersionsResponse>
getVersions(payload: Managed<LicenseIdentificator>): Promise<VersionsResponse>
﻿
Get Product Installation File
﻿https://docs.licensespring.com/license-api/installation-file﻿
TypeScript
getInstallationFile(payload: Managed<LicenseIdentificatorWithInstallation>): Promise<InstallationFileResponse>
getInstallationFile(payload: Managed<LicenseIdentificatorWithInstallation>): Promise<InstallationFileResponse>
﻿
Get Single Sign-On URL
﻿https://docs.licensespring.com/license-api/sso-url﻿
TypeScript
getSSOUrl(payload: SSOURLParams): Promise<{ url: string }>
getSSOUrl(payload: SSOURLParams): Promise<{ url: string }>
﻿
Air-Gapped Licenses
﻿https://docs.licensespring.com/license-entitlements/activation-types/air-gapped﻿
TypeScript
getAirGapActivationCode(initializationCode: string, licenseKey: string)
getAirGapActivationCode(initializationCode: string, licenseKey: string)
﻿
Performs verifyConfirmationCode and activates Air-Gapped License:
TypeScript
activateAirGapLicense(confirmationCode: string, licenseKey: string, policyFilePath: string, policyID: string)
activateAirGapLicense(confirmationCode: string, licenseKey: string, policyFilePath: string, policyID: string)
﻿
License Utility Methods
Checks if License is enabled, active and not expired:
TypeScript
isValid(license: LicenseResponse): boolean
isValid(license: LicenseResponse): boolean
﻿
Returns days remaining in maintenance period:
TypeScript
maintenanceDaysRemaining(license: LicenseResponse): number
maintenanceDaysRemaining(license: LicenseResponse): number
﻿
Returns days remaining in license validity period:
TypeScript
daysRemaining(license: LicenseResponse): number
daysRemaining(license: LicenseResponse): number
﻿
License File
See License File﻿
TypeScript
loadLicense(): License

isLicenseFileCorrupted(): boolean

clearLocalStorage(): void
loadLicense(): License

isLicenseFileCorrupted(): boolean

clearLocalStorage(): void
﻿
﻿
﻿
Updated 13 Dec 2024
Did this page help you?
License API
License File
License Manager

LicenseManager

Methods

Check License

Activate License Online

Deactivate License Online

Activate License Offline

Deactivate License Offline

Get Trial Key

List Licenses for User

List License Users for Customer

Check License Feature

Add License Consumption

Add Feature Consumption

Get Product Details

Get Device Variables

Track Device Variables

Borrow Floating License

Release Floating License

Release Floating Feature

Change Password

Get Product Versions

Get Product Installation File

Get Single Sign-On URL

Air-Gapped Licenses

License Utility Methods

License File

﻿
