Embedding Qlik Sense in web applications
Introduction
Qlik Sense apps, sheets and visualizations can be embedded in for example:
- Portals
- Web applications
- Intranet and Extranet sites
There are different ways of embedding the Qlik Sense content:
- iFrame integration using the URL Integration APIs
- Div integration using the JavaScript libraries
-
Standard Qlik Sense charts and custom visualization extensions can be created programmatically without having to be built in the Qlik Sense UI first, using the qlik-visual web component
Which APIs should I use to embed Qlik Sense into my web application?
-
App Integration API or Single Integration API: Use the App Integration API or Single Integration API if you just need to embed a few apps, sheets, or objects into your app.
-
Capability APIs: Use the Capability APIs to embed Qlik Sense visualizations into your web app, create Qlik Sense visualizations on the fly, get data from fields, make selections, create objects, and more. The Capability APIs attempt to simplify the process of communicating with the Qlik Engine JSON API.
-
enigma.js: Use enigma.js if you are a developer comfortable with referencing the Qlik Sense Engine JSON API and you want as little between you and the Qlik Sense Engine as possible. Also, you do not require embedding Qlik Sense visualizations into your web app. A higher degree of skill is required than using either the Integration APIs or the Capability APIs.
Embed Qlik Sense content with Dev Hub
Dev Hub is a development toolbox that helps you getting started building solutions with Qlik Sense as well as understanding the APIs.
Mashup editor
The Mashup editor is an editor for JavaScript files, HTML files and QEXT files. It can be used to create mashups to display Qlik Sense data on your website. You can use the templates provided with Qlik Sense to get started building your first mashup.
Your Qlik Sense installation comes with a mashup example, which provides guidance for how to build your own mashup.
Single configurator
The Single configurator is a tool that provides an easy way of creating simple mashup pages without having to write any code at all. It creates 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.
Build mashups using the JavaScript libraries
Learn how to create and build a basic mashup, displaying content from a supplied app. Use the examples provided to learn at your own pace.
Getting started building mashups
Relevant APIs
Qlik Sense provides a number of JavaScript-based APIs for embedding Qlik Sense content:
- URL Integration APIs for iFrame integration
- JavaScript APIs for embedding objects in web pages, including the Backend API for communicating with the backend of Qlik Sense.
In addition to the above, you can also use the Qlik Engine JSON API, which is a WebSocket protocol that uses JSON to pass information between the Qlik associative engine and the clients.
API reference for Saas editions and QSEoK
Create and modify visualizations on the fly
Qlik visual is a custom element definition, <qlik-visual>, that uses the Visualization API and exposes it as a web component. It allows you to create and modify visualizations on the fly without making use of the Qlik Sense client.
Embed Qlik Sense content with URL integration APIs
The App Integration API provides parameters that can be used to create an URL that returns a complete HTML page containing the embedded app. This URL can be embedded in a web page, for example by including it in an iframe.
You can also integrate single Qlik Sense visualizations, sheets or snapshots into an iframe. You use the Single Integration API to define how the object should be integrated into your web site