Qlik Sense .NET SDKを使用してQlik Sense SaaSのアプリにアクセスする

1. Qlik Sense .NET SDKを使用して
Qlik Sense SaaSのアプリに
アクセスする
2022/11/15
クリックテック・ジャパン株式会社

2. はじめに
今回のQlik Tipsでは、Webブラウザを使わず、「Qlik Sense .NET SDK」を使用し
て.NET(C#)アプリを開発することで、Qlik Sense SaaS上のアプリにアクセスして、その
テーブルやチャートのデータを取得する方法を紹介します。
また、Qlik Sense SaaSにアクセスする場合に必要なAPI KeyやJWT(JSON Web Tokens)を
使った認証や、Webプロキシーサーバーを介するネットワーク環境用のコード(C#)も紹介し
ます。
Qlik Sense .NET SDKは、当初はQlik Sense Enterprise for Windows向けのソフトウェア
開発キット(SDK)でしたが、Qlik Sense SaaSの登場とともにオンプレ版とSaaS版の両方を
サポートするように機能追加・改善されてきました。
Qlik Sense .NET SDKの公式サイト
https://help.qlik.com/en-US/sense-developer/August2022/Subsystems/NetSDKAPIref/Content/Home.htm
リリースノート
https://help.qlik.com/en-US/sense-
developer/August2022/Subsystems/NetSDKAPIref/Content/ReleaseNotes.htm
NuGetキャラリー
https://www.nuget.org/packages/QlikSense.NetSDK

3. Qlik Sense .NET SDKを利用して
Qlik Sense SaaSのアプリにアクセス

4. 開発する.NETアプリケーションの概要
分析アプリに外部からアクセスして、テーブルやチャートのデータを取得して表示
https://help.qlik.com/en-US/sense-developer/August2022/Subsystems/NetSDKAPI/Content/Sense_NetSDKAPI/Introduction/Net-Sdk-Intro.htm

5. .NETアプリケーションのプロジェクトを作成
Qlik Sense .NET SDKや.NET Framework 4.6.2～/.NET Core 3.1～を利用
https://help.qlik.com/en-US/sense-developer/August2022/Subsystems/NetSDKAPI/Content/Sense_NetSDKAPI/Introduction/Net-Sdk-Prerequisites-
Disclaimers.htm
最低限必要なライブラリ
・QlikSense.NetSDK 16.1.0
・Newtonsoft.Json 13.0.1
オプションで必要になるライブラリ
・JWT 9.0.3

6. アクセスするユーザーの認証用にAPIキーを準備する
1. テナント管理者でQlik Sense SaaS版にログインし、Management
Console(MC)で「Qlik Sense .NET SDK用ユーザー」に「Developer」権限
を付加
2. MCの設定ページでAPIキーを有効にし、有効期限なども設定
3. Qlik Sense SaaS版に「そのDeveloper権限のあるユーザー」でログイン
4. ユーザーの「プロファイル設定」ページにアクセスし、管理  APIキー  新
規キーの作成 でAPIキーを作成したら、その文字列を大切に保管

7. 認証情報のセット – テナントのURLとAPIキーの場合

8. 特定のアプリ内のチャート一覧を取得

9. 特定のテーブルチャート内の全データを取得

10. Webプロキシーサーバーを利用する場合
Webプロキシーサーバーは、WebSocketをサポートしている必要あり

11. JWT認証でアクセスしてみる

12. はじめに
通常、Qlik Sense SaaSでは、OpenID Connect(OIDC)をサポートする外部IdP(Identity
Provider,認証システム)を利用して、ログイン処理や、ユーザー情報の取得・管理を行います。
ただし、Qlik Sense .NET SDKやマッシュアップのような、Qlik Sense SaaS APIを利用す
るケースでは、OpenID ConnectのIdPを利用せずに、送信するJWTデータとその中のユー
ザー情報を利用して認証を行うことが可能です。
なお、JWT認証を利用するには、
 JWTのために、OpenSSLで予め公開鍵(証明書)と秘密鍵を生成
 Qlik Sense SaaSの管理コンソールの「IDプロバイダー」で「JWT」の設定を追加
 プログラミング言語とライブラリを使って、JWTデータ(ユーザーはIdPサブジェクトの値
で識別)を生成
 Qlik Sense SaaS APIを利用する際にJWTデータをセット
 必要に応じて、JWT認証で利用するユーザーに指名ライセンスやアクセス権限を付与
ことが求められます。
重要
初めて何かアプリにアクセスしようと
した際に、
管理コンソールにユーザー情報が追加

13. JWT用の証明書・秘密鍵の生成と、IDプロバイダーの
作成
参考: qlik.dev >> Home >> Tutorials >> Create Signed Tokens for JWT Authorization
https://qlik.dev/tutorials/create-signed-tokens-for-jwt-authorization
OpenSSLコマンドを利用して、公開鍵(.cer)と秘密鍵(.pem)と、JWTデータ署名用のPKCS#12形式(.pfx)を生
成
$>openssl genrsa -out privatekey.pem 4096
$>openssl req -new -x509 -key privatekey.pem -out publickey.cer -days 1825
$>openssl pkcs12 -inkey privatekey.pem -in publickey.cer -export -nodes -out cert.pfx -passout
pass: 証明書(必須!!) - 作成した公開鍵のPEM文字列
発行者(必須!!) - JWTを発行したアプリを識別する値
キーID(必須!!) - JWTデータに付属させるアプリ識別用
の値
発行者とキーIDは、.NET用JWTライブラリなどから
JWTデータを生成する際に指定して、一致させる必要が
あります!!

14. JWTデータの生成 – .NET用JWTライブラリを利用
今回は「Jwt.Net, a JWT(JSON Web Token) implementation for .NET」を利用
 https://github.com/jwt-dotnet/jwt
署名用の証明書
kid:キーID
jti:JWTのユニーク値
iss:発行者
iat:発行時間
exp:失効時間
nbf:有効開始時間
sub:IdPサブジェクト
subType:user
name:名前
email:メールアドレス
email_verified:有効
groups:グループ情報
aud:固定値

15. 認証情報のセット – テナントのURLとJWTの場合
重要!! 初めてアプリにアクセスした際に、管理コンソールにユーザー情
報が追加される