| Table of Contents |
|---|
Overview
What is Qlik Sense Desktop?
It is a Business Intelligence (BI) tool that utilizes an "associative engine" to index every possible relationship in the data set. This allows the user to immediately explore any eureka moments while analyzing the data at hand.
Qlik Sense API Integration Flow
This how-to assumes the user has already visited the Qlik website, downloaded and installed the Qlik Sense Desktop program.
Step 1: Creating the "App"
On the Qlik Sense Desktop Hub, click on “Create New App” in the top right-hand corner denote by the red circle in the illustration below.
Step 2: Creating the Data Connection
On the "Add data to <Insert App Title>" page, look for the connection option titled "REST". This will allow the user to connect the relevant APIs to your "App".
Step 3: Linking the API (1)
In the“Create a connection – REST” pop up window, execute the following sub-steps. (Illustration below step 3.3)
Step 3.1
Pasting the API URL link from https://api.canopy.cloud/apidoc
Step 3.2
Make sure the Method selected is “GET”
Step 3.3
Authentication Schema should reflect “Anonymous”
Step 4: Linking the API (2)
Scroll down to the next set of textboxes and options, then execute the following sub-steps. (Illustration below step 4.4)
Step 4.1
Query Parameters should reflect data filters such as “date”, “date from” or “date from”. Leave empty for ALL related historical data.
Step 4.2
Query Headers MUST include the following
| Name | Value |
|---|---|
| Authorization | Token token="<Insert Token Value>" |
| X-App-Switch-User | <Insert Parent ID> |
Step 4.2.1
Token value is taken from logging in via “Sessions.Json” at the top of the page, where Username and Password is required.
Step 4.3
Pagination should be “Custom”
Step 4.4
Please enter your connection name in this field. (I.e. “Get Holdings - <Parent ID>”)
Step 5: Finalizing Data Add
You will now find yourself back on the “Add data to <Insert App Title>” page. On this page, please ensure the “root” option checkbox is ticked. Then proceed to the bottom right of the page to click the green “Add Data” button.
Extras: How-To Charts
...
14 Dec 2017 | Canopy Pte. Ltd. |
Qlik Sense: How-to API |
...
Qlik Sense API Integration Flow
...
Step
...
On the Qlik Sense Desktop Hub, click on “Create New App” in the top right-hand corner denote by the red circle in the illustration below.
Step 2: Creating the Data Connections
On the “Add data to <Insert App Title>” page, look for the option titled “REST” which will allow you to connect the relevant APIs to your “App”.
Step 3: Linking the API (1)
In the “Create a connection – REST” pop up window, execute the following sub-steps. (Illustration below step 3.3)
Step 3.1
Pasting the API URL link from https://api.canopy.cloud/apidoc
Step 3.2
Make sure the Method selected is “GET”
Step 3.3
Authentication Schema should reflect “Anonymous”
Step 4: Linking the API (2)
Scroll down to the next set of textboxes and options, then execute the following sub-steps. (Illustration below step 4.4)
Step 4.1
Query Parameters should reflect data filters such as “date”, “date from” or “date from”. Leave empty for ALL related historical data.
Step 4.2
Query Headers MUST include the following
Name | Value |
Authorization | Token token=”<Insert Token Value>” |
X-App-Switch-User | <Insert Parent ID> |
Step 4.2.1
Token value is taken from logging in via “Sessions.Json” at the top of the page, where Username and Password is required.
Step 4.3
Pagination should be “Custom”
Step 4.4
Please enter your connection name in this field. (I.e. “Get Holdings - <Parent ID>”)
Step 5: Finalizing Data add
You will now find yourself back on the “Add data to <Insert App Title>” page. On this page, please ensure the “root” option checkbox is ticked. Then proceed to the bottom right of the page to click the green “Add Data” button.
Extras: How-to-get charts
...
6
After step 5, you will be redirected to a page with two or more circles, these represent the two tables. They most likely will be linked by a grey shaded area. If there is no link, you have to execute step 6.0.1. Otherwise, please proceed to step 6.1
Step 6.0.1
...
Select the two circular tables and click on the wand on the right-hand side of the page. If the program detects any obvious connections between the two tables, it will automatically make the link. Otherwise, you will be asked to specify what links you want to create.
Step 6.1
Once the connection has been made , click on the “save” button and then “Load data”
Step 6.2
After the program has finished loading click on the “Edit this Sheet” button.
Step 6.3
You will now be on the “Edit Dashboard” page and are free to create all sorts of crazy diagrams and graphs.
End
That's it! The user is now ready to generate beautiful and majestic charts and graphs. Well done you!
The following pictures are excerpts of the sample data that was included in the program.
