topic Re: Connecting to QRS API via QPS in Integration, Extension & APIs

Connecting to QRS API via QPS

AG-gugelbisolutions — Fri, 18 Mar 2022 07:54:35 GMT

Hi there, I'm pretty new to the usage of APIs with Qlik Sense, especially to build a custom web app.

Reading this page I see there are basically two ways to connect to the QRS:

using urls like https://<QRS machine name>:4242/<path> provided that the client has a valid certificate issued by the Qlik Sense Server
using urls like https://<proxy machine name>/<path>

Given that I'm working with a single node Windows environment, I was able to start exploring the QRS API following the first way, but not the second. More precisely, these were my Postman settings:

(GET) https://<QSServerPrivateIPAddress>:4242/qrs/app/full?Xrfkey=iX83QmNlvu87yyAB
a client certificate (that Postman automatically adds to the request based on the address and port)
an established VPN connection
Two headers
- x-Qlik-Xrfkey
- X-Qlik-User

What should I do in order to follow the second way? I tried the next:

(GET) https://<QSServerPublicIPAddress>/qrs/app/full?Xrfkey=iX83QmNlvu87yyAB
no certificates matching the public address
no VPN connections
Two headers
- x-Qlik-Xrfkey
- X-Qlik-User

Re: Connecting to QRS API via QPS

Øystein_Kolsrud — Fri, 18 Mar 2022 07:46:33 GMT

Simple things first: When you want to access the api through the proxy, then you should not include the port number. The proxy will take care of guiding the request to the right port depending on the URL.

But the hard thing here is getting the authentication right. One of the main responsibilities of the proxy (or virtual proxy to be precise) is to provide an authentication method. The exact set of headers you need to access Qlik Sense through the proxy therefore depends on what type of authentication method is configured for the virtual proxy you are connecting to. So you should start by checking how the proxy is configured.

Postman might not support the authentication methods you need though. It seems that it for instance has limited port for Windows authentication (NTLM) which is quite common for Qlik Sense:

https://stackoverflow.com/questions/37341304/pass-ntlm-with-postman

Re: Connecting to QRS API via QPS

AG-gugelbisolutions — Fri, 18 Mar 2022 12:56:36 GMT

Thank you @Øystein_Kolsrud, I made a mistake while writing the post and I'm actually not using ports when trying to connect through the QPS.

At the moment I'm using the default virtual proxy with NTLM and I tried the following Postman configuration, with no success:

(GET) https://<QSServerPublicIPAddress>/qrs/app/full?Xrfkey=iX83QmNlvu87yyAB
no certificates matching the public address
no VPN connections
(in Postman) Authorization > Type : NTML
- Username, Password and Domain fields were fulfilled
Two headers
- x-Qlik-Xrfkey
- X-Qlik-User

Any help would be appreciated.

Thanks

Re: Connecting to QRS API via QPS

AG-gugelbisolutions — Fri, 18 Mar 2022 13:13:59 GMT

I made a step forwad: I realized I did not include the public IP address in the host whitelist and now, at least, I get the Qlik Sense Login Page, instead of the list of the apps.

I should probably perform a different call, perhaps /qps/ticket beforehand.

I'll let you know but, in the meanwhile, any suggestion is of help.

Re: Connecting to QRS API via QPS

AG-gugelbisolutions — Fri, 18 Mar 2022 13:40:22 GMT

Even with qps/ticket I get redirected to the login page.

Is this the intended behaviour?

Re: Connecting to QRS API via QPS

Øystein_Kolsrud — Fri, 18 Mar 2022 14:46:26 GMT

You'll get redirected there if the headers are not right. I'm afraid I don't know enough about Postman to know if it's possible to use it for NTLM authentication these days. I know I've tried that at some point and wasn't able to make it work, but that was a couple of years ago. Looking at that stackoverflow thread I posted about earlier it seems like it's possible, but that rather tricky.