Qlik Community

Qlik Sense Integration, Extensions, & APIs

Discussion board where members can learn more about Integration, Extensions and API’s for Qlik Sense.

Not applicable

Getting started with the REST API

Hi there,

I was trying to understand how to integrate a product with Qlik,

doing stuff like listing apps, finding app configurations, data values etc. I think that most of the Engine API does that, the getting started page doesn't really explain how to connect, but the main Engine API page shows that I should connect to a Qlik Sense Proxy Service.

But, the proxy service says that it's a REST api and the engine api says you need a websocket connection here.

So if I have to make some API calls to the Qlik cloud sense, which one of those API should I use? How do I authenticate?

Can someone please explain briefly what the steps should be?

Thanks

6 Replies
Employee
Employee

Re: Getting started with the REST API

The proxy has a REST api for doing operations on the proxy it self. The engine API, on the other hand, is based on JSON RPC through websockets. You might also want to have a look at the Repository API (also REST based) which you can use for instance to list apps on the server. The end point for listing apps can be found here: App: Get hub list ‒ Qlik Sense

Based on your question, it sounds like you want to investigate the contents of apps as well. In that case you have to go through the engine API. How to connect depends on your environment, but one possibility is to use the .Net SDK which has been designed to access the engine API through C#. It's available for download from NuGet: https://www.nuget.org/packages/QlikSense.NetSDK/

You can find more information about the .Net SDK at the following page: https://help.qlik.com/en-US/sense-developer/3.0/Subsystems/NetSDKAPI/Content/Introduction/Net-Sdk-In...

Information focusing on how to connect to the engine through the .Net SDK can be found here: https://help.qlik.com/en-US/sense-developer/3.0/Subsystems/NetSDKAPI/Content/CodeExamples/Sample%20c...

Not applicable

Re: Getting started with the REST API

I don't use windows nor C# to develop.

I wanted to find a way to connect from server to server, the api you listed just shows the path, not the host to connect to,

is it possible to use the Engine API with Qlik Sense Cloud? In that case, are there any examples that shows how to connect and how to authenticate to start using the Engine API?

Employee
Employee

Re: Getting started with the REST API

Qlik Cloud currently does not expose any APIs.

The Engine API is just a our defined protocol with json messages sent over websockets so it's not language specific.

There are a few community implementations of the Engine API is various languages, this is one implementation in JS for the browser and Node https://github.com/mindspank/qsocks

This is a Go imeplementation (or a start at least) GitHub - mattbaird/glik: go (golang) client api for the Qlik Sense family of products

You can find the full Engine API documentation here: Qlik Engine API ‒ Qlik Sense

Not applicable

Re: Getting started with the REST API

Imagine I use that qsocks library,

which host should I connect to if Qlick Cloud sense doesn't expose any API endpoint?

It would work just with an in-house installation of qlik?

Employee
Employee

Re: Getting started with the REST API

Ye, either a in-house installation or you could download Qlik Sense Desktop (it's free) which is windows only right now so you would have to run it inside a VM.

If you can't get the Desktop implementation to work drop me a pm and I'll see if we can't grant you early access to a API playground that we are working on right now.

Not applicable

Re: Getting started with the REST API

Oh ok now I get it,

no problem I'll go with the desktop version first to see what I can extract from the API.

Thanks a lot

Community Browser