Pdftools SDK license management

Learn how to manage the Pdftools SDK license keys. The information on this page applies to legacy and page-based licenses. The Pdftools SDK also includes the Toolbox add-on that can be used with the same license key.

Trial license

The Pdftools SDK and Pdftools SDK Shell Tool don't require a trial license key, but the Toolbox add-on requires it. You can use the same license key for Pdftools SDK, Pdftools Shell Tool, and the Toolbox add-on.

SDK	To try the SDK	Output files	Get a license key
Pdftools SDK	No trial license key is needed.	Watermarked results without a license key.	To remove the watermark from the output files, contact the sales team through the Contact page.
Pdftools SDK Shell Tool
Toolbox add-on	Obtain a license key to try the SDK.	Obtain a license key to use the SDK.	To try the SDK, contact sales team through the Contact page.

License key validation

License keys are validated using the Pdftools Licensing Service. The SDK connects to the Pdftools Licensing Service to provide information on usage and retrieve new licensing parameters after processing a document.

The Pdftools Licensing Service collects the following statistics and information:

• License number
• Pdftools SDK functions used and number of pages processed

For information on managing your license key with the Pdftools Licensing Service, see Pdftools Licensing Service.

Activate the Pdftools SDK license

Learn how to activate a license key for the Pdftools SDK. Review the appropriate link for your programming language:

• Initialize the SDK C
• Initialize the SDK Java
• Initialize the SDK .NET
• Initialize the SDK Python
• Initialize the SDK Other languages and frameworks

Activate the Toolbox add-on license

Learn how to activate a license key for the Toolbox add-on. Review the appropriate link for your programming language:

• Initialize the SDK C
• Initialize the SDK Java
• Initialize the SDK .NET

Use Pdftools SDK Shell Tool license

Learn how to use the Pdftools SDK Shell Tool license key:

• Use of license key

Default license configuration

By default, when the Pdftools SDK is initialized, it attempts to connect to the Pdftools Licensing Service directly. This requires an internet connection to the default licensing service URL:

https://licensing.pdf-tools.com/api/v1/licenses/

caution

By default, if the Pdftools SDK cannot connect to the licensing service URL, the SDK initialization fails.

Use the Licensing Gateway

Use the Licensing Gateway Service if the Pdftools SDK needs to operate without a direct connection to the Pdftools Licensing Service.

To configure the SDK to use the Licensing Gateway Service, set the LicensingService property of the Sdk class before calling Sdk.Initialize.

.NET

static void Main(string[] args)
{
    try
    {
        // Set the URL to the Licensing Gateway Service.
        Sdk.LicensingService = new Uri("http://my.gateway.com:9999");

        // Set and check license key. If the license key is not valid, an exception is thrown.
        Sdk.Initialize("$LicenseKey$");

Java

public static void main(String[] args)
{
    try
    {
        // Set the URL to the Licensing Gateway Service.
        Sdk.setLicensingService(new java.net.URI("http://my.gateway.com:9999"));

        // Set and check license key. If the license key is not valid, an exception is thrown.
        Sdk.initialize("$LicenseKey$");

note

More information about the LicensingService property is available in the SDK documentation for .NET and Java.

Check the license status

When the Pdftools SDK is successfully initialized, check your license status by accessing the LicenseInfoSnapshot property of the SDK class. This property provides the following information about the current license:

• IsValid: License validity.
• ExpirationDate: The date and time when the license expires.
• RemainingPages: The number of pages available to be processed, based on the license agreement.
• Overconsumption: The number of pages available to be processed, before the SDK stops functioning.

If the RemainingPages value reaches zero, the Pdftools SDK provides a limited number of Overconsumption pages. The Overconsumption pages give you time to update your license agreement without disrupting your business processes.

caution

If both the RemainingPages and Overconsumption values reach zero, the Pdftools SDK stops functioning until the licensing service is updated with new license information.

note

More information about the LicenseInfoSnapshot property is available in the SDK documentation for .NET and Java.