License Control

The library provides flexible licensing options with the support of the following APIs

• licenseServer
• organizationID
• handshakeCode
• sessionPassword
• productKeys

licenseServer

Specifies the URL(s) for the main and stand-by License Tracking Server(s). This is only required when you host the License Tracking Server(s) yourself. If nothing is set, the Server(s) hosted by Dynamsoft will be used.

static licenseServer: string[] | string

Code Snippet

// You can specify only the main server
Dynamsoft.DBR.licenseServer = ["YOUR-OWN-MAIN-DLS"];

//or you can specify both
Dynamsoft.DBR.licenseServer = ["YOUR-OWN-MAIN-DLS", "YOUR-OWN-STANDBY-DLS"];

organizationID

When a license is purchased, it is registered to an Organization. This license is then hosted by a License Tracking Server which authorizes terminal devices and consumes the license. This API specifies which Organization you would like to acquire authorization from.

static organizationID: string

Code Snippet

Dynamsoft.DBR.organizationID = "YOUR-ORGANIZATION-ID";

handshakeCode

Licenses registered to the same Organization are grouped by Handshake Codes. When an Organization is specified by organizationID, the default Handshake Code will be used unless another Code is specified with this API.

Generally, the first Handshake Code ever created for an organization is the default one. However, you can always make another Code default in the customer portal.

static handshakeCode: string

Code Snippet

Dynamsoft.DBR.handshakeCode = "YOUR-HANDSHAKE-CODE";

sessionPassword

Specifies a password to protect the Handshake Code. If no Handshake Code is specified with the API handshakeCode, this password protects the default Handshake Code.

The password can be set for each Handshake Code when it was first created and can be changed later by editing the configuration of the Code.

static sessionPassword: string

Code Snippet

Dynamsoft.DBR.sessionPassword = "YOUR-SESSION-PASSWORD";

productKeys

A product key is an alphanumeric string used as an offline license. If such a key is specified in your program, you do not need to specify anything else for licensing purposes.

static productKeys: string

Code Snippet

Dynamsoft.DBR.productKeys = "YOUR-PRODUCT-KEYS";

For convenience, you can even set productKeys in the script tag.

<script src="/dist/dbr.js" data-productKeys="PRODUCT-KEYS"></script>