English Qlik Sense Developers 2.1

Client side integration

Client side integration capabilities

The client side integration capabilities of Qlik Sensehelp you solve real business problems. Visualization extensions, mashups and single integration are all built upon open client side APIs.

Visualization extensions

Qlik Sense visualization extensions enable you to enhance the overall experience of a Qlik Sense app. They create new ways of visualizing data and enhance user input and interaction.

Visualization extensions can be integrated with other systems and visual libraries, new selection objects and productivity components can be added, and it can all be done using open standards such as HTML5, JavaScript and CSS.


In the context of web development, a mashup is a web page or web application that uses content from more than one source to create a single new service displayed in a single graphical interface.

The Capability APIs enables you to quickly integrate with your Qlik Sense objects to produce enriched results that were not necessarily the original reason for producing the source app in Qlik Sense. You can reuse Qlik Sense visualizations, including your custom extensions, and you can also make use of Qlik Sense data and calculations.

By using active content, your visualizations are updated when the state changes. You can also subscribe to data and change the state through the visualizations.

Single integration

You can integrate single Qlik Sense visualizations, sheets or snapshots into an iframe. The Single Integration API is used to define how the object should be integrated into your web site and the Single configurator tool provides an easy way of creating an URL that returns a complete HTML page of the object.

Client side APIs

Qlik Engine API

The Qlik Engine API is a WebSocket protocol that uses JSON to pass information between the Qlik engine and the clients.

It works on any platforms and with any programming language that includes a WebSocket library.

Extension API

The Extension API is a JavaScript API that provides public methods for building visualization extensions.

Capability APIs

Capability APIs are small, granular APIs with a specific purpose. Most of them can be used inside (visualization extensions) or outside (mashup scenarios) Qlik Sense.

Backend API

The Backend API is a JavaScript API that provides public methods for communicating with the Qlik engine. The methods can be called both from visualization extensions and mashups.

The Backend API is a wrapper around some of the Qlik Engine API methods, but with the difference that the Backend API is aware of the context.

Single Integration API

The Single Integration API provides parameters that can be used to create an URL that returns a complete HTML page containing, for example, an embedded Qlik Sense visualization. This URL can be embedded in a web page, for example, by including it in an iframe.