Getting Started

Have a question? Let us know and we’ll get back to you

Getting started with PDFix SDK

PDFix SDK is a cross-platform PDF processing tool, that offers various ways of the integration. A Command-line interface PDFix CLI is a quick and easy way to add PDF processing functionality into various workflows without coding.

Developers can use the PDFix SDK with programming languages to take advandatage of the full control over the PDF documents.

Check the system requirements to avoid any problems with running PDFix SDK on your system.

Integration using the CLI

PDFix provides simple, fast and automated PDF processing through the command-line. PDFix CLI is the easiest way to integrate the PDFix SDK functionality into your solutions.

$ ./pdfix_app make-accessible -i test.pdf -o output.pdf --preflight

For more CLI options please check the PDFix SDK Command-line interface.

Integration using the SDK

c#

Import NuGet package PDFix.SDK

using PDFixSDK.Pdfix;

static void Main() {
   var pdfix = new Pdfix();                           // load the library
   var doc = pdfix.OpenDoc("Sample.pdf", "");         // open document
   // do your stuff
   doc.Close();                                       
}

Check the full github sample https://github.com/pdfix/pdfix_sdk_example_dotnet

c++


#include "Pdfix.h"

Pdfix_statics;                                        // static members

int main() {
   if (Pdfix_init(Pdfix_MODULE_NAME))) {              // load the library
      auto pdfix = GetPdfix();
      auto doc = pdfix->OpenDoc(L"Sample.pdf", L"");  // open document
      // do your stuff
      doc->Close();                                   
   }
}

Check the full github sample https://github.com/pdfix/pdfix_sdk_example_cpp

java

import net.pdfix.pdfixlib.*;

public static void main() {
   System.loadLibrary("pdfix");                       // load the library
   Pdfix pdfix = new Pdfix();   
   PdfDoc doc = pdfix.OpenDoc("Sample.pdf", "");      // open document
   // do your stuff
   doc.Close();
}

Check the full github sample https://github.com/pdfix/pdfix_sdk_example_java

python

Check the full github sample https://github.com/pdfix/pdfix_sdk_example_python

Prerequisites

Trial license limitations

  • Methods extracting text from the PDF content randomly replace characters with "*"
  • Rasterized images may contain logo watermark
  • Saved PDFs may have redacted parts of the content

License Management

PDFix SDK can be autorized using an activation key or using the name, key pair.

Standard License Activation

Software can be authorized using an activation key. After activating the software operates on the computer according to the license. Internet connection is necessary for occasional license updates. The activated license information is stored on computer under the current user account. A write permission is required in the following directories:

  • Windows: <user>\AppData\Local\.pdfixsdk
  • MacOS: <user>/Library/Application Support/.pdfixsdk
  • Linux: <user>/.pdfixsdk

Command line example:

$ ./pdfix_app license --activate XXXX-XXXX-XXXX-XXXX

Code example: c++, c#

Note to PHP users: Depending on the configuration the PHP may operate in a safe mode under a virtual user (e.g. www-data). In such a case the license should be activated separately with PHP.

Deactivating the standard license

When moving license to another computer the license should be deactivated.

Command line example:

$ ./pdfix_app license --deactivate

Code example: c++

Updating the standard license

The license is updated automatically when running the software. When an instant update is needed the following command should be executed:

Command line example:

$ ./pdfix_app license --update

Code example: c++

Account license authorization

Software can be authorized using a name and key. The name key pair should be used every time the PDFix SDK is used.

Command line example:

$ ./pdfix_app extract-data --input test.pdf --email your@email --key XXXXXXXXXXXXXX

Code example: c#

License Status

The current license status can be saved into JSON.

Command line example:

$ ./pdfix_app license --status 

Code example: c++

Satus output:

{
    "product": {
        "name": "PDFix SDK",
        "option": "Enterprise",
        "version": "6.4.0"
    },
    "status": {
        "authorized": "true"
    },
    "license": {
        "type": "standard",
        "active": "true",
        "key": "XXXX-XXXX-XXXX-XXXX",
        "max_activations": "5",
        "total_activations": "2",
        "days_remaining": "51",
        "expired": "false",
        "expiration_date": "2021-01-09",
        "days_since_last_check": "1",
        "pages": {
            "type": "2",
            "max_consumption": "300000",
            "total_consumption": "37024",
            "local_consumption": "5"
        },
        "enterprise": {
            "type": "1"
        }
    }
}

Support

In case of any questions please contact support.