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 (On-Demand), or software that is developed by a third party.
A Qlik NPrinting administrator can configure the API user with Windows NTLM authentication. This is done by adding the Domain account in the format <Domain>\<Username> in the user profile. The Qlik NPrinting users can only perform the actions that are defined in their profiles. For example, in the list of apps you will see only the apps for which the connected user is authorized. If the user is not authorized to any app, you will get an error message or an empty list.
The API user can also be set up with JWT authentication. However, JWT authentication only works with Qlik NPrinting and is not supported for the Qlik Sense On-Demand reporting control.
For more information on:
Using JWT authentication with NPrinting, see JWT authentication.
Using JWT as an API authentication method, see How to configure and call APIs with JWT authentication.
Using Qlik Sense On-Demand reporting control, see On-Demand reporting control.
Set the privileges for On-Demand reports in the Roles administration page:
- Create: user can request the creation of reports using APIs.
APIs are always enabled for all users and roles. You cannot disable APIs.
The Enable On-Demand check box must be selected to run a report using APIs.
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.