Extending Qlik NPrinting

Qlik NPrinting exposes a set of REST APIs that enables you to generate reports from other software, for example the QlikView user interface (so called On-Demand) or a custom developed software.

User settings

To use Qlik NPrinting APIs you need to connect with an user that must have the Windows NTLN authentication configured by adding the Domain account in the format <Domain>\<Username> in the user profile. By using APIs you will be able to do only what the user you used to connect is able to do. For example, in the list of apps you will see only the apps the connected user is authorized. If the user is not authorized to any app, you will get an error message or an empty list.

Required role

In the Roles administration page you have to set the On-Demand reports privileges:

  • Create: a role with this grant activated can request the creation of reports by using APIs.

APIs are always enabled for all users and roles. You cannot disable APIs.

APIs capabilities

Available APIs are a subset of the user interface features that allows the implementation of the On-Demand reporting. So, On-Demand addon uses APIs.

With Qlik NPrinting APIs you can:

  • Get the list of all available apps with descriptions.
  • Get the list of all available reports with descriptions.
  • Get the list of all available filters with descriptions.
  • Use the On-Demand feature.

Lists are filtered based on user's roles rights. For example, the list of apps contains only apps that the user is authorized to see.

Requests and response details

All API requests require the content-type application/x-www-form-urlencoded unless otherwise specified.

All responses will be in JSON format.

All endpoints also support the HTTP OPTIONS verb, and will respond with the correct CORS headers (cross-origin resource sharing) based on the Qlik NPrinting Server settings.

Date and time format

Qlik NPrinting APIs supports the ISO 8601 (RfC 3339) date and time format for requests and responses.

Detailed documentation for developers

Detailed Qlik NPrinting APIs documentation for developers is available.

See: Qlik NPrinting- APIs reference