Generate your first API key

Overview

In this tutorial you are going to learn how to generate an API key for your account in a Qlik Sense SaaS tenant.

  • Configure API key settings for your tenant in the management console.
  • Add the developer role to a user in the management console.
  • Generate an API key
  • Test the API key in Postman

Note Only a user with the Tenant Admin role may access the management console settings and add roles to users. If you aren't the Tenant Admin of your Qlik Sense SaaS tenant, please contact your Tenant Admin and direct them to this tutorial.

Configure API key settings

Note You must have the Tenant Admin role in the Qlik Sense SaaS management console to perform this section of the tutorial.

Inside the management console, click the Settings menu item on the left side of the screen.

a screenshot of the settings button in Qlik Sense
SaaS management console

Scroll down to the API keys section in the main part of the screen. Flip the switch to turn on API keys for the tenant, set the allowed maximum token age, and set the maximum number of active API keys a user may have in the tenant.

a screenshot of the API keys section of the
Settings in Qlik Sense SaaS management console

Another requirement for generating API keys is for a user to have the developer role. In the management console menu click Users to open the Users section and select 'edit roles' from the elipsis menu for the user you want to add the developer role to.

a screenshot of the selected user sub menu in the
Users panel in Qlik Sense SaaS management console

Check the box next to Developer to give the user developer privileges in your tenant. Save the change.

a screenshot of the edit roles modal for a user
entry in Qlik Sense SaaS management console

Now that API keys are turned on in the tenant and the user has the developer role, have the user log in to your tenant and click the avatar in the top right corner of the screen. Click the Settings menu option from the drop down.

a screenshot of the user menu
in Qlik Sense SaaS hub

Click the API keys menu item on the left side of the user settings screen. This action surfaces the API keys list for the user. Click the Generate new key button to create a new API key.

a screenshot of the API keys list
in the user's settings screen

Give the new API key a name and set the expiration time from the dropdown. Click the Save button to generate the API key.

a screenshot of the generate new key
configuration screen.

The generated API key appears. Copy it using any of the copy buttons and paste it somewhere safe.

Note The API key is only displayed once, when you create it. If you don't copy it, there is no way to see this specific key again. You have to generate a new key if you don't copy it.

a screenshot of the generated key in the generate new
key configuration screen.

Take the copy of the key and use it in Postman by setting an Authorization header to use a Bearer token. Paste the key in the textbox that appears once Bearer is selected. Add a URL for a REST endpoint on the tenant. In this example, the URL is pointing to https://<tenant hostname>/api/v1/users/me. Click the Send button to make the request to the API endpoint. If you entered the information into Postman correctly, the response below appears.

Note You can download and install Postman from here

a screenshot of Postman REST application testing
the generated Qlik Sense SaaS API key.

Next steps

So you have an API key, now what? You can have a look at the REST API reference on qlik.dev and try the APIs out in Postman, or install qlik-cli and add your API key and harness the power of Qlik from the command line.