topic .NET SDK on Qlik Sense SaaS? in Integration, Extension & APIs

.NET SDK on Qlik Sense SaaS?

master_t — Thu, 26 Aug 2021 13:59:14 GMT

Hello everybody

I have an application that interacts with Qlik Sense Enterprise/Desktop and makes extensive use of the .NET SDK.

My question is: can che .NET SDK be used to connect to a Qlik Sense SaaS installation?

If so, how would I do that? And if not, are there plans to support it in the future? Or is there a valid alternative??

Thanks!

Re: .NET SDK on Qlik Sense SaaS?

Øystein_Kolsrud — Thu, 26 Aug 2021 14:40:59 GMT

You can use the .NET SDK with SaaS if you have an API key. You use this class to define your connection:

https://help.qlik.com/en-US/sense-developer/August2021/Subsystems/NetSDKAPIref/Content/Qlik.Sense.JsonRpc.QcsLocation.htm

A connection could look like this:

var location = QcsLocation.FromUri(uri); location.AsApiKey(apiKey); using (var app = location.App(appId)) { Console.WriteLine(app.GetAppProperties().Title); }

Re: .NET SDK on Qlik Sense SaaS?

master_t — Thu, 26 Aug 2021 14:12:43 GMT

Thank you, I will try it out!

Since we are on the topic, is there an equivalent of the Repository Service API? I'm assuming we can't use the QRS API directly, since there is no QMC... or can we?

Re: .NET SDK on Qlik Sense SaaS?

Øystein_Kolsrud — Thu, 26 Aug 2021 14:21:23 GMT

Yes you are right, the QRS is completely gone in SaaS. It's replaced by a set of REST APIs that each have a particular focus. You can read all about them here: https://qlik.dev/

Re: .NET SDK on Qlik Sense SaaS?

Øystein_Kolsrud — Thu, 26 Aug 2021 14:22:12 GMT

And more information regarding API keys can be found here:

https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/Admin/mc-generate-api-keys.htm

Re: .NET SDK on Qlik Sense SaaS?

Spartan27215 — Wed, 11 Jan 2023 22:02:18 GMT

Are there any examples on how to get started? I am using SaaS and have created an API key.

Re: .NET SDK on Qlik Sense SaaS?

Spartan27215 — Wed, 11 Jan 2023 22:59:22 GMT

var location = QcsLocation.FromUri(uri);
location.AsApiKey(apiKey);
using (var app = location.App(appId))
{
    Console.WriteLine(app.GetAppProperties().Title);
}

FromUri only returns an IQcsLocation Object which does not contain an App method, in fact, it has very few methods cannot for the life of me figure how this is helpful.

Assuming the URI would be https://myTennant.us.QlikCloud.com (or some similar)?

If I wanted to List my users, how would I do that,

How would I query the users for a space(not knowing the actual spaceId)

Add Users to a space(not knowing the actual spaceId....

Use any of the API's etc.

Re: .NET SDK on Qlik Sense SaaS?

Øystein_Kolsrud — Thu, 12 Jan 2023 08:29:21 GMT

Perhaps you imported the generic QcsLocation base class from Qlik.Sense.JsonRpc instead of the engine interface version from Qlik.Engine? That would explain why there is no "App" method available to you.

There are a couple of examples of how to connect and get started here:

https://github.com/AptkQlik/PublicExamples

And an example that focuses on hypercubes and data access can be found here:

https://github.com/kolsrud/qlik-dot-net-sdk-hypercube-usage

Re: .NET SDK on Qlik Sense SaaS?

Øystein_Kolsrud — Thu, 12 Jan 2023 15:12:53 GMT

But the .NET SDK only focuses on the engine API. The information you are looking for (user and space information) is not part of the engine domain. You probably want to utilize the REST APIs of QCS. The endpoints in question (for users and spaces) are these:

https://qlik.dev/apis/rest/users
https://qlik.dev/apis/rest/spaces

The following library can be used to call REST endpoints from .NET with authentication flow very similar to what you would use for the .NET SDK:

https://www.nuget.org/packages/QlikSenseRestClient/

Some examples to get started with that library can be found here:

https://github.com/kolsrud/qlik_rest_sdk/tree/master/Qlik.Sense.RestClient/Examples

Re: .NET SDK on Qlik Sense SaaS?

Spartan27215 — Thu, 12 Jan 2023 16:44:22 GMT

One thing that is not clear is what URL do I connect to. All the samples just use a mystery variable representing the URL. No information on how the URL should be formed.

One example uses a pem certificate during connection, where would that come from? I am only aware of an API key.

The examples are not very helpful they seem geared to local install not SaaS.

Re: .NET SDK on Qlik Sense SaaS?

Øystein_Kolsrud — Thu, 12 Jan 2023 20:06:49 GMT

The URL to use is the tenant URL. What this URL looks like will depend on how your tenant is configured, but typically it will look something like "https://<customName>.eu.qlikcloud.com" for a tenant in the EU.

The certificate example is an example for connecting to the client managed version of Qlik Sense. As you are using the SaaS version, you should only consider the examples starting with "Qcs".

Re: .NET SDK on Qlik Sense SaaS?

NadiaB — Thu, 12 Jan 2023 20:19:45 GMT

Hi @Spartan27215

I posted a basic sample in .net in the other post:

https://community.qlik.com/t5/Move-to-SaaS/How-to-bulk-add-users-when-using-Azure-AD-Idp/m-p/2025076#M303

Re: .NET SDK on Qlik Sense SaaS?

rob_geo4 — Thu, 07 Aug 2025 07:41:44 GMT

Hi, Can you please tell us that from which version onwards the support for this QCS connection is provided in the Engine SDK. Also I would like to know that, is it possible to create apps and do all other app operations like setting script, creating charts etc with this QcsLocation as well like other locations from Engine SDK. Actually when I checked I couldn't find any methods for creating app as available with other locations ?.
If not possible what is the alternative, only RestClientSDK ?.
FYI i'm using latest SDK version(16.10.0).
Thanks in advance

Re: .NET SDK on Qlik Sense SaaS?

Øystein_Kolsrud — Thu, 07 Aug 2025 08:09:34 GMT

Hi! Connections to QCS have been supported since v15.2.1 (November 2020) when the class "Qlik.Engine.QcsLocation" was introduced.

https://help.qlik.com/en-US/sense-developer/May2025/Subsystems/NetSDKAPIref/Content/ReleaseNotes.htm#anchor-26

And yes, it's possible to do all the operations you ask for, but perhaps you can post a new question here on Community with this question? I think it would be better to give a more elaborate answer in a dedicated thread as it is sort of off topic from the original question in this thread.

Re: .NET SDK on Qlik Sense SaaS?

rob_geo4 — Mon, 11 Aug 2025 05:34:42 GMT

Got it. Thanks for the reply. I'll consider creating a new thread as you suggested for the other one.