Qlik Community

Qlik Design Blog

All about product and Qlik solutions: scripting, data modeling, visual design, extensions, best practices, etc.

Employee
Employee

Getting started with Qlik APIs

It’s been a while since I’ve posted about how a developer can get started with Qlik, so I figured it would be a good idea to review current tools and resources for developers new to Qlik.

A good place to start would be the Getting Started on the Qlik developer help page. There’s some links here to get you started building mashups, extensions, and widgets. There’s also information about creating connectors, building Windows applications, and automating administrative jobs. You can use the navigation on the left to explore. One thing that can be easily missed but may be really useful for someone new to Qlik Sense is the Concepts section, which will explain things like generic objects, hypercubes, list objects, and other concepts that are really essential to Qlik. Also, don’t miss out on the Videos you can find here.

Once you’ve checked out that stuff, you should check out Qlik Branch Knowledge over on the new Qlik Branch site. While you’re at it, join Qlik Branch on Slack so you can connect with other developers using Qlik, and check out the rest of https://developer.qlik.com.

When you feel like you’re ready to build something, Getting started building mashups with Dev Hub is a good place to jump in. I wouldn’t recommend trying to build production-level mashups in dev hub unless it’s simple, but it’s a good place to just get a feel for the Capability APIs. You can see how the Capability APIs are loaded and accessed, what a connection to a Qlik Sense app actually looks like and can embed a few objects or create a few cubes or lists and see what that code looks like. From there, you can check out the Capability API Reference  and try building a mashup without using the dev hub. Here’s a great quick reference for Connecting to the Capability APIs.

One thing you need to understand is that the Capability APIs simply provide the ability to embed visualizations and communicate with the Qlik Engine. But if you just want to communicate with the Qlik Engine and you don’t need to embed visualizations then using the Capability APIs is probably not the best choice. You should check out enigma.js, which is an open source library for communicating with the Qlik Engine. You may also want to check out other Qlik Open Source projects, such as picasso.js, a library for building visualizations that is optimized for use with Qlik.

Whether you’re using the Capability APIs or enigma.js (or even some other way) to communicate with the Qlik Engine, you’ll definitely want to keep the Qlik Engine Reference handy.

And what about if you’re interested in stuff like authentication and task automation? Then you’ll have to dive into the Qlik Sense Proxy Service (QPS) API or the Qlik Sense Repository Service (QRS) API. These are both REST APIs, so chances are they will feel a bit more familiar for you than the Qlik Engine API.

If you're a developer that's new to Qlik and have any questions, I'd be happy to address them in the comments below!

4 Comments
ajaykakkar93
Contributor

Very Helpful content if someone wants to start by understanding the basic about Qlik Api and what it offers.

0 Likes
304 Views
david7gauthier
New Contributor

Hi Francis,

Thank you for this great post.

I have a question about using the Qlik Sense API.
I would like to develop a Qlik Sense extension to market it and I would like to know if I have to be a Qlik partner or it is not necessary.


Thanks


David

0 Likes
304 Views
bmz
Valued Contributor

Hi David,

Are you asking if you need to be a partner to develop and market an extension yourself? If so, you don't need to be a partner to build extensions and promote them however you please.  If you want the extension listed on Qlik Market or accredited in the TED program (https://developer.qlik.com/ted‌), you do need to a partner.

Thanks.

304 Views
david7gauthier
New Contributor

Hi Brian,

Thank you.

It's very clear !


Thanks

0 Likes
304 Views