Documentation

>Online Documentation

>Locally Installed Documentation

>Getting Started Guides

>Sentinel LDK and Sentinel LDK-EMS User Interfaces

>Sentinel LDK APIs

Online Documentation

Most Sentinel LDK documentation can be found online at:

https://docs.sentinel.thalesgroup.com/ldk/home.htm

Locally Installed Documentation

Sentinel LDK documents can be found:

>where Sentinel LDK is installed, under:
%ProgramFiles(x86)%\Thales\Sentinel LDK\Docs\

>where Sentinel LDK-EMS is installed, under:
%ProgramFiles(x86)%\Thales\Sentinel LDK-EMS\EMSServer\webapps\ems\Docs\

Document	Description
Sentinel LDK Installation Guide	Details the prerequisites and procedures for installing Sentinel LDK Vendor Tools, Sentinel LDK-EMS Server (only for Sentinel LDK-EMS on-premises), launchers for Sentinel LDK-EMS, and the Run-time Environment.
Sentinel LDK Software Protection and Licensing Guide	Provides in-depth information about the logic of the applications and best practices for maximizing your software protection and licensing strategies. Describes a wide range of licensing strategies and models that you can implement, and can serve as the basis for elaboration and for creating new, tailor-made licensing models.
Sentinel LDK Software Protection and Licensing Tutorials	Familiarize you with the Sentinel LDK applications and their functionality. > The Demo Kit tutorial is for vendors that want to evaluate Sentinel LDK. > The Starter Kit tutorial is for vendors that have already purchased Sentinel LDK. Two versions of each tutorial are provided – one for working with Sentinel LDK-EMS as the back office system, and one for vendors who want to provide their own back office system and only use the Sentinel LDK APIs to handle licensing and protection.
Sentinel LDK High Availability for Cloud Licensing Configuration Guide	Describes how to set up "high availability" support to serve cloud-based licensing.
Sentinel LDK: Choosing and Integrating Hardware-, Software-, and Cloud Licensing	Provides a description of the differences and advantages of SL and cloud-based protection keys versus HL keys.
Sentinel LDK Quick Start Guides	Provide a short and simple demonstration of how you can easily protect your software using Sentinel HL keys. Separate Demo Kit and Starter Kit guides are provided.
Sentinel LDK-EMS Configuration Guide	Provides information on setting up and configuring Sentinel LDK-EMS to satisfy the requirements of your organization.
Sentinel LDK-EMS User Guide	Provides the Sentinel LDK-EMS user with detailed directions on how to set up license entities and how to handle entitlements, production, and support for Sentinel HL and SL keys. (This information is also provided in online help for the Sentinel LDK-EMS user interface.)
Sentinel LDK-EMS Web Services Guide	Provides the developer with an interface for integrating Sentinel LDK-EMS functionality into the vendor’s existing back-office systems.
Integrating Sentinel LDK-EMS Server Into Your Existing Back-Office Systems	Outlines the many ways that software vendors can maximize the potential of their existing back‐office systems, such as ERP, CRM, and business intelligence systems, through seamless integration with Sentinel LDK-EMS Server.

Getting Started Guides

Getting Started Guides for other operating systems can be found as follows:

Linux

The Getting Started Guide for Linux can be found in the Linux download or where Sentinel LDK is installed, under: %ProgramFiles(x86)%\Thales\Sentinel LDK\Additional Platforms\Linux\

macOS

The Getting Started Guide for macOS can be found in the Mac download or where Sentinel LDK is installed, under: %ProgramFiles(x86)%\Thales\Sentinel LDK\Additional Platforms\MacOS\

Android

The Getting Started Guide for Android can be found where Sentinel LDK is installed, under:
%ProgramFiles(x86)%\Thales\Sentinel LDK\Additional Platforms\Android\

Sentinel LDK and Sentinel LDK-EMS User Interfaces

The documentation described in the table that follows can be accessed from the user interface for the relevant Sentinel LDK component.

Reference Document	Description
Sentinel Admin Control Center	Documentation for the end user, describing the Admin Control Center and providing instructions for performing the various functions such as updating or attaching licenses.
Sentinel LDK-EMS	Provides the Sentinel LDK-EMS user with detailed directions on how to set up license entities and how to handle entitlements, production, and support for Sentinel HL and SL keys.
Sentinel LDK Data Encryption Utility (Separate versions for Windows and for Mac)	Provides the developer with a description of the Sentinel LDK Data Encryption utility (formerly DataHASP utility), used for protecting data files that are accessed by Sentinel LDK Envelope.
Sentinel LDK Envelope (Separate versions for Windows and for Mac)	Describes how to employ Sentinel LDK Envelope to automatically wrap your programs with a protective shield. The application provides advanced protection features to enhance the overall level of security of your software.
Sentinel LDK ToolBox	Describes how to work with the ToolBox user interface for the Licensing API, License Generation API, and Admin API. Using Sentinel LDK ToolBox, the developer can experiment with the individual functions that are available in each API and can generate programming code for insertion in the developer’s own program. Provides full documentation for each of the included APIs.

Sentinel LDK APIs

Documentation for the Sentinel LDK APIs described below can be found:

>On the Sentinel Product Documentation web site:

https://docs.sentinel.thalesgroup.com/ldk/home.htm

>where Sentinel LDK is installed, under:
%ProgramFiles(x86)%\Thales\Sentinel LDK\API\

Sentinel LDK API	Description
Licensing API Reference (formerly Run-time API)	Provides the developer with an interface to use the licensing and protection functionality available in the Sentinel LDK Run-time Environment.
Run-time Installer API	Provides the developer with an interface for integrating installation of the Run-time Environment into the installation of the vendor’s protected application.
Sentinel LDK-EMS Web Services	Provides the developer with an interface for integrating Sentinel LDK-EMS functionality into the vendor’s existing back-office systems. Locally-installed documentation is available from the index.html menu under: %ProgramFiles(x86)%\Thales\Sentinel LDK-EMS\EMSServer\webapps\ems\Docs\
License Generation API Reference	Provides access to the power and flexibility of Sentinel protection keys without the need to use Sentinel LDK-EMS. The developer can call functions in this API to generate and update licenses for Sentinel protection keys.
Admin API Reference	Provides the functionality available in Admin Control Center and Sentinel License Manager in the form of callable API functions.