Qlik Proxy API

NodeJS package to interact with Qlik Sense Proxy API (QSEoW)

Installation

npm install qlik-proxy-api

Usage

import fs from "fs";
import https from "https";
import { QlikProxyApi } from "qlik-proxy-api";

const httpsAgentCert = new https.Agent({
  rejectUnauthorized: false, // if we want suppress certificate errors (like self-signed certificate error)
  cert: fs.readFileSync(`path/to/client.pem`),
  key: fs.readFileSync(`path/to/client_key.pem`),
});

// create new instance or qlik-proxy-api
let proxyApi = new QlikProxyApi.client({
  host: "my-qs-host",
  port: 4243, // optional. default is 4243
  httpsAgent: httpsAgentCert,
  authentication: {
    user_dir: "SOME_USER_DIR",
    user_name: "SOME_USER_ID",
  },
});

// at this point we can use proxyApi to call any method
let aliveResponse = await proxyApi.alive();

let ticketResponse = await proxyApi.ticketAdd({
  userId: "SOME_USER_ID",
  userDir: "SOME_USER_DIR",
});
console.log(ticketResponse.ticket); // id of the generated ticket

let vpSessions = await proxyApi.virtualProxySessionGetAll("some-vp");
console.log(vpSessions); // array or all active sessions for specified virtual proxy

Documentation

Source code and documentation can be found at the package repository

Code documentation can be found at this page