Licensing¶
A license key is required to use the id3 Face SDK. This section explains the different types of licenses, how they are tied to your hardware, and how to activate them.
Developer vs. Runtime Licenses¶
Developer License: Required to build an application using id3 Face SDK. This license is used during the development phase.
Runtime License: Required for each end-user device where your application using id3 Face SDK is deployed.
Trial License: A full-featured, 60-day trial license is available for evaluation purposes.
License Models¶
id3 Face SDK offers several license models to fit different needs.
License |
Description |
|---|---|
Perpetual license |
The perpetual license authorizes to use the product indefinitely with the payment of a single fee.
The license is bound to a device and never expires.
No internet connection required.
|
Temporary license |
The temporary license expires after a fixed number of days following its activation.
No internet connection required.
|
Online license |
The online license requires a regular internet connection to work.
A mechanism allows the software to run offline during a grace period (generally 30 days).
|
Note
Temporary licenses may be extended on request. Please contact our sales department for a license extension.
Hardware-Bound Licenses¶
Each license is locked to a specific device using a unique “Hardware Code”. This code is generated based on different attributes depending on the target platform.
Warning
Modifying the hardware or system properties used to generate the hardware code (e.g., changing the hostname) will invalidate the license.
Hardware Code by Platform¶
The hardware code is calculated according to the target platform.
Platform |
Hardware ID |
|---|---|
Windows OS |
|
Linux OS |
Host name + Machine ID |
Android |
|
iOS |
|
macOS |
Host name + machine ID |
Jetson Nano |
Host name + machine ID + serial number |
Important
Mobile Platform Specifics (Android/iOS): On mobile devices, for reasons of confidentiality, the hardware code is unique to each application, even on the same device. Therefore, the license must be activated from within your application’s code (programmatic activation).
Hardware Code Format¶
The hardware code is in the form XXXXXXX-XXXXXXX-XXXXXXX-XXXXX00. The last two digits identify the platform or locking method:
01: Windows OS03: Linux OS05: Android ID06: Android package name07: iOS08: macOS09: Jetson Nano10: iOS Bundle ID11: Dongle (Windows only)12: Smart card (or trusted element)13: Application or library name (Windows, Linux and macOS only)
Special Case: USB Dongle License (Windows)¶
For Windows applications, a license can be locked to the serial number of a standard USB flash drive instead of the computer’s hardware.
Warning
A dongle license is permanently tied to a single USB drive and cannot be transferred.
License Activation¶
An internet connection is required to activate a license. The activation process binds the license to your device’s Hardware-Bound Licenses.
Note
Unless you are using an Online License, the internet connection is only required for the initial activation.
Activation Credentials¶
To activate your license, you will need one of the following credentials. The Activation Key is the preferred and most flexible method.
Activation Key (Recommended) An activation key is a unique identifier linked to your account that looks like
XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX. It is the preferred method for activation because it is flexible, allowing multiple activations on different devices as needed for your project.Serial Number A serial number is a key in the format
XXXX-XXXX-XXXX-XXXX. It is less flexible as it only allows for a single activation. Once used, it cannot be used again.Credentials This method uses your customer login, password, and a product reference number to activate.
Note
Regardless of the activation method used, the final generated license file will always have a unique serial number associated with it. This serial number is important for identifying a specific license, for instance, when requesting technical support or a license repositioning.
Activation Methods¶
You can activate your license using one of the following methods.
1. License Manager GUI (Windows Only) The graphical id3 License Manager application helps you manage your license files on Windows. Before you can use id3 Software Development Kits (SDKs), you must have the correct license installed. Please refer to the License Manager user’s guide for more details.
Prerequisites: - Microsoft Windows 7, 8 or 10 - An active Internet connection
2. Command-Line Tool A command-line activation tool is available in the activation/cli-tool directory for all supported platforms.
For example on Linux x64:
cd activation/cli-tool/linux/x64
chmod +x id3LicenseActivationCLI
./id3LicenseActivationCLI --help
Several options are possible to activate a license.
Activation with a serial number:
id3LicenseActivationCLI.exe --activate .\data\id3Face.lic --serialkey="XXXX-XXXX-XXXX-XXXX"
Activation with an activation key:
id3LicenseActivationCLI.exe --activate .\data\id3Face.lic --activationkey="email-XXXXXXXX-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
Activation with credentials:
id3LicenseActivationCLI.exe --activate .\data\id3Face.lic --login="[email protected]" --password="myPassword" --reference="XXXXXXXX"
3. Programmatic Activation It is generally preferred to activate the license programmatically within your application. This is the recommended approach for most applications.
Important
Programmatic activation is the only way to activate a license on mobile devices (Android, iOS).
See License handling in the sdk_usage section for details and code examples.
Post-Activation Management¶
License Repositioning¶
License repositioning is possible under certain conditions. Please contact our sales department or make a support request to obtain a license repositioning.
Important
Any request to reposition a license must be justified. The serial number of the license must be mentioned in the request.