Skip to content

Welcome to the Developer Portal for Qlik Cloud -

Learn more >

Get started

  • Portal introduction

    Understand what the developer portal is all about, what you can use the Qlik platform for, and more!

  • Get started with qlik-cli

    qlik-cli is a Command Line Interface (CLI) for automating administrative functions using commands and scripts in Qlik Cloud.

  • Build a simple web app

    Learn how to create a web app that integrates with your Qlik Sense SaaS tenant.

Featured APIs & tools

Explore some of the featured APIs and tools that'll help you be successful in leveraging the Qlik platform.



// opening an app and log the layout
(async () => {
  const enigma = require('enigma.js');
  const schema = require('enigma.js/schemas/12.612.0');
  const WebSocket = require('ws');

  const appId = '<app-id>';
  const tenant = '<your-tenant.qlikcloud.com>';
  const apiKey = '<your-api-key>';

  const url = `wss://${tenant}/app/${appId}`;

  const session = enigma.create({
    schema,
    createSocket: () => new WebSocket(url, {
      headers: { "Authorization": `Bearer ${apiKey}` }
    }),
  });

  const global = await session.open();
  const app = await global.openDoc(appId);
  const appLayout = await app.getAppLayout();

  console.log(appLayout);
})();
    

// the logged app layout

{
  "qTitle": "Hello world",
  "qFileName": "<app-id>",
  "qLastReloadTime": "2020-03-31T16:30:29.248Z",
  "qHasScript": true,
  "qStateNames": [],
  "qMeta": {},
  "qLocaleInfo": {
    <snip>
  },
  "qHasData": true,
  "qThumbnail": {},
  "description": "",
  "encrypted": true,
  "id": "96d275f8-af88-419b-8090-6f84382efcb8",
  "_resourcetype": "app",
  "published": false,
  "owner": "SOMEONE\in-your-org",
  "ownerId": "v42QFF876gzcEzVd_4p9M1zzcXvXl2hm",
  "createdDate": "2020-03-31T15:55:45.487Z",
  "modifiedDate": "2020-04-29T15:02:47.738Z",
  "hassectionaccess": false,
  "privileges": [
    <snip>
  ],
  "create": [
    <snip>
  ]
}

The enigma.js documentation  has a lot more awesome stuff for you to learn.