License API

26min
Provides a direct interface to the LicenseSpring API. The LicenseAPI class encapsulates API calls, input checks, authentication and signature verification. Typescript definitions are provided for the arguments and return types of the class methods.
To import the LicenseAPI class use:
JS
const { LicenseAPI } = require('@licensespring/node-sdk');
const { LicenseAPI } = require('@licensespring/node-sdk');
﻿
Creating an instance
JS
const licenseAPI = new LicenseAPI({
  apiKey: '12345678-4bfe-4e3a-8737-757004d6294c',
  sharedKey: 'eYuHrlajvIVTiSFIXpxpKhw78f4Ewy-00-12345678',
  appName: 'js-sdk-test-1',
  appVersion: '0.0.1',
  /** 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 licenseAPI = new LicenseAPI({
  apiKey: '12345678-4bfe-4e3a-8737-757004d6294c',
  sharedKey: 'eYuHrlajvIVTiSFIXpxpKhw78f4Ewy-00-12345678',
  appName: 'js-sdk-test-1',
  appVersion: '0.0.1',
  /** 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 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 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,
}
﻿
API methods
For type declarations see Type Declarations.
Hardware ID
Generates a Hardware ID. This value is required for various API method calls.
If the optional argument is not provided, it defaults to the value set in the configuration object provided when instantiating the LicensespringAPI object. If no value was provided in the config object, it defaults to 0 (the default Hardware ID method).
TypeScript
getHardwareID(algorithm?: HardwareIdAlgorithm): string
getHardwareID(algorithm?: HardwareIdAlgorithm): string
﻿
Check License
See: License Check﻿ 
TypeScript
checkLicense(payload: LicenseIdentificator, includeExpiredFeatures: boolean = false): Promise<LicenseResponse>
checkLicense(payload: LicenseIdentificator, includeExpiredFeatures: boolean = false): Promise<LicenseResponse>
﻿
Activate License Online
See: Activate License (Online Method)﻿ 
TypeScript
activateLicense(payload: LicenseActivationIdentificatorWithVariables): Promise<LicenseResponse>
activateLicense(payload: LicenseActivationIdentificatorWithVariables): Promise<LicenseResponse>
﻿
Deactivate License Online
See: Deactivate License (Online Method)﻿ 
TypeScript
deactivateLicense(payload: LicenseIdentificator): Promise<boolean>
deactivateLicense(payload: LicenseIdentificator): Promise<boolean>
﻿
Activate License Offline
See: Activate License (Offline Method)﻿ 
TypeScript
activateOffline(payload: LicenseActivationIdentificatorOfflineWithVariables): Promise<LicenseResponseOffline>
activateOffline(payload: LicenseActivationIdentificatorOfflineWithVariables): Promise<LicenseResponseOffline>
﻿
Deactivate License Offline
See: Deactivate License (Offline Method)﻿ 
TypeScript
deactivateOffline(payload: LicenseIdentificator): Promise<boolean>
deactivateOffline(payload: LicenseIdentificator): Promise<boolean>
﻿
Get Trial Key
See: Trial Key﻿ 
TypeScript
getTrialKey(payload: TrialKeyPayload): Promise<LicenseTrialResponse>
getTrialKey(payload: TrialKeyPayload): Promise<LicenseTrialResponse>
﻿
List Licenses for User
See: Licenses for User﻿ 
TypeScript
getUserLicenses(payload: GetUserLicensesPayload): Promise<LicenseResponse[]>
getUserLicenses(payload: GetUserLicensesPayload): Promise<LicenseResponse[]>
﻿
List License Users for Customer
See: List License Users for Customer﻿ 
TypeScript
getCustomerLicenseUsers(payload: GetCustomerLicensesPayload): Promise<CustomerLicenseUsersResponse>
getCustomerLicenseUsers(payload: GetCustomerLicensesPayload): Promise<CustomerLicenseUsersResponse>
﻿
Check License Feature
See: License Feature Check﻿﻿
TypeScript
checkLicenseFeature(payload: LicenseIdentificatorAndFeature): Promise<LicenseFeatureResponse>
checkLicenseFeature(payload: LicenseIdentificatorAndFeature): Promise<LicenseFeatureResponse>
﻿
Add License Consumption
See: Add Consumption﻿ 
TypeScript
addConsumption(payload: LicenseIdentificatorAddConsumptions): Promise<LicenseConsumptionsResponse>
addConsumption(payload: LicenseIdentificatorAddConsumptions): Promise<LicenseConsumptionsResponse>
﻿
Add License Feature Consumption
See: Add Feature Consumption﻿ 
TypeScript
addFeatureConsumption(payload: LicenseIdentificatorAddFeatureConsumptions): Promise<LicenseFeatureConsumptionResponse>
addFeatureConsumption(payload: LicenseIdentificatorAddFeatureConsumptions): Promise<LicenseFeatureConsumptionResponse>
﻿
Get Product Details
See: Get Product Details﻿ 
TypeScript
getProductDetails(payload: ProductDetailsPayload): Promise<ProductDetailsResponse>
getProductDetails(payload: ProductDetailsPayload): Promise<ProductDetailsResponse>
﻿
Get Device Variables
See: Get Device Variables﻿ 
TypeScript
getDeviceVariables(payload: LicenseIdentificator): Promise<DeviceVariable[]>
getDeviceVariables(payload: LicenseIdentificator): Promise<DeviceVariable[]>
﻿
Track Device Variables
See: Track Device Variables﻿ 
TypeScript
trackDeviceVariables(payload: LicenseIdentificatorWithVariables): Promise<DeviceVariable[]>
trackDeviceVariables(payload: LicenseIdentificatorWithVariables): Promise<DeviceVariable[]>
﻿
Borrow Floating License
See: Borrow Floating License﻿ 
TypeScript
floatingBorrow(payload: LicenseIdentificatorWithBorrowedUntil): Promise<LicenseBorrowResponse>
floatingBorrow(payload: LicenseIdentificatorWithBorrowedUntil): Promise<LicenseBorrowResponse>
﻿
Release Floating License
See: Release Floating License﻿ 
TypeScript
floatingRelease(payload: LicenseIdentificator): Promise<boolean>
floatingRelease(payload: LicenseIdentificator): Promise<boolean>
﻿
Release Floating Feature
See: Release Floating Feature﻿ 
TypeScript
featureRelease(payload: LicenseIdentificatorAndFeature): Promise<boolean>
featureRelease(payload: LicenseIdentificatorAndFeature): Promise<boolean>
﻿
Change Password
See: Change Password﻿ 
TypeScript
changePassword(payload: PasswordChangePayload): Promise<boolean>
changePassword(payload: PasswordChangePayload): Promise<boolean>
﻿
Get Product Versions
See: Get Product Versions﻿ 
TypeScript
getVersions(payload: LicenseIdentificator): Promise<VersionsResponse>
getVersions(payload: LicenseIdentificator): Promise<VersionsResponse>
﻿
Get Product Installation File
See: Get Installation File﻿ 
TypeScript
getInstallationFile(payload: LicenseIdentificatorWithInstallation): Promise<InstallationFileResponse>
getInstallationFile(payload: LicenseIdentificatorWithInstallation): Promise<InstallationFileResponse>
﻿
Get Single Sign-On URL
See: Single Sign-On URL﻿ 
TypeScript
getSSOUrl(payload: SSOURLParams): Promise<{ url: string }>
getSSOUrl(payload: SSOURLParams): Promise<{ url: string }>
﻿
Air-Gapped License Code
﻿https://docs.licensespring.com/license-entitlements/activation-types/air-gapped﻿
TypeScript
getAirGapActivationCode(initializationCode: string, licenseKey: string): string

verifyConfirmationCode(confirmationCode: string, licenseKey: string, policyId?: string): boolean

activateAirgappedLicense(activationPayload: OfflineActivation, licenseKey: string, policyId: string): LicenseResponse
getAirGapActivationCode(initializationCode: string, licenseKey: string): string

verifyConfirmationCode(confirmationCode: string, licenseKey: string, policyId?: string): boolean

activateAirgappedLicense(activationPayload: OfflineActivation, licenseKey: string, policyId: string): LicenseResponse
﻿
﻿
﻿
﻿
Updated 16 Jan 2025
Did this page help you?
Installation
License Manager