Licensing¶
id3 Face SDK uses software protection to protect id3’s intellectual property. To work, the id3 Face SDK libraries require a license key, which must be installed on the target system before starting your application.
The trial version of the SDK is a full version time-limited (60 days). A developer license is required to develop an application based on id3 Face SDK. A runtime license is required to deploy an application based on id3 Face SDK.
License types¶
The following licenses are available:
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.
Dongle license¶
For Windows applications, a license can be installed on a standard USB key.
Warning
A dongle license is linked to the serial number of the USB key, so once a license is installed on that particular dongle, it cannot be transferred to another dongle.
License modules¶
A license module gives access to some functionalities of the SDK as described below:
Module |
Description |
|---|---|
Face |
Main module |
FaceAttributes |
Provides access to the FaceAnalyser Class |
FaceEncoder |
Provides access to the FaceEncoder Class |
FaceGPU |
Provides access to the GPU. |
FaceMatcher |
Provides access to the FaceMatcher Class |
FacePAD |
Provides access to the FacePad Class |
ServerEdition |
Identifies the server edition (Windows, Linux, Mac) |
MobileEdition |
Identifies the mobile edition (Android, iOS) |
EdgeEdition |
Identifies the edge edition (Raspberry PI) |
Hint
In your application, call the FaceLicense.checkModule Method to find out whether a particular module is enabled in your license.
License activation¶
The activation of a license is required prior to use any module of this SDK.
License manager (Windows only)¶
On windows the graphical License Manager application may also be used to activate licenses. Please refer to the License Manager user’s guide for more details.
Please note that on windows, and windows only, you can lock your license on a USB device.
Command-line interface¶
A command-line activation software is available in the activation/cli-tool directory.
For example on linux x64:
cd activation/cli-tool/linux/x64
chmod +x id3LicenseActivationCLI
./id3LicenseActivationCLI --help
Several options are possible to activate a license. See License activation options for details.
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"
Programmatic activation¶
It is generally preferred to activate the license programmatically within your application. See License handling in the Overview section for details.
Note
On mobile devices, the License hardware code is linked to the application itself, so programmatic activation is the only way to activate a license in this case.
License activation options¶
The following license activation options are available:
Serial number: A unique key in the format
XXXX-XXXX-XXXX-XXXXallowing a single activation.Activation key: A unique key in the format
email-XXXXXXXX-XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXXallowing multiple activations on multiple devices.Credentials: Customer login/password and reference number of the product to be activated.
Important
An internet connection is required to complete the activation procedure.
Unless the Online option is enabled, once the license is activated, the internet is no longer required.
Note
During the activation process, the SDK license is linked to a unique hardware identifier. See License hardware code for details.
License hardware code¶
Each license is bound to a hardware identifier which 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 |
Warning
Any change on one of these items may invalidate exsiting licenses on the computer.
Important
On Android and iOS platforms, it is not possible, for reasons of confidentiality, to retrieve a truly unique hardware identifier. The side effect is that the hardware code is different (but fixed) for every application you develop, even on the same device.
The hardware code is in the form XXXXXXX-XXXXXXX-XXXXXXX-XXXXX00
The last two digits identify the platform:
01: Windows OS03: Linux OS05: Android06: Android package name07: iOS08: macOS09: Jetson Nano10: iOS Bundle ID11: Dongle (Windows only)
License manager¶
The id3 License Manager is a Windows application that helps you manage your license files. Before you can use id3 Software Development Kits (SDKs), you must have the correct license installed.
The purpose of this guide is to describe the use of id3 License Manager and how to activate a license.
Prerequisites
Microsoft Windows 7, 8 or 10,
An active Internet connection
License repositionning¶
License repositionning is possible under certain conditions.
Please contact our sales department or make a support request to obtain a license repositionning.
Important
Any request to reposition a license must be justified. The serial number of the license must be mentioned in the request.