Skip to main content

Setting Up the API Key

Configure API key access so Catalog can connect to your Qlik Sense instance. You can create a dedicated Catalog user or add a key to an existing user.

Requirements​

  • Ability to use (or create) a user with access to needed spaces
  • Ability to create an API key for that user
  • The user must have at least the "Developer" role

1. Get a Qlik API Key​

Option A: Create a Catalog Qlik User​

You can invite onboarding@castordoc.com to your Qlik instance. The Catalog team will then create the API key using the Qlik UI.

  1. Invite a new user using onboarding@castordoc.com.
  2. Allocate a Professional license to this user.

Option B: Add a Key to an Existing User​

If you have an account with sufficient privileges, you can create an API key linked to your account.

  1. Go to your profile settings and click API Keys.
  2. Create an API key.
  3. Input the API key in the App with the following format:
{
    "apiKey": "*****",
    "baseUrl": "https://xxxx.xx.qlikcloud.com"
}

2. Add This User to the Wanted Spaces​

  • Add the user chosen above to each space you want to see in Catalog. The "Can Manage" right is required.
  • For lineage purposes, make sure to also add Apps that are used for data transformation. Catalog cannot compute lineage on what it cannot see.
  • Space access grants access to all space apps, except when using Section Access. For those apps, add the Catalog user one by one (or using a script).