はじめに

Qlik Senseでは、他のWebサイトやアプリケーション等とスムーズに連携を行うためのJSON形式でリクエストを扱うREST APIが提供されています。今回はGoogle Chrome拡張として提供されている「Postman」と呼ばれるWeb APIのテストクライアントを利用してQlik Sense APIの動きを試す手順をご紹介します。

ここでは、Qlik Sense Serverが導入されていることを前提に、サーバー側の操作を行うための「Qlik Sense Repository Service(QRS) API」を利用します。Qlik Sense APIの全体的な概要説明については以下をご参照ください。

image

また、Qlik Sense Enterpriseのインストール方法については、以下をご参照ください。

image

Postmanのインストール

では、Postmanのインストールから始めたいと思います。PostmanはWeb APIをテストするときに利用されるクライアントツールとなり、Qlik SenseのREST APIにリクエストを発行し、JSON形式でレスポンスを受け取るために利用することができます。

ここでは、Qlik Sense Enterpriseが導入されているサーバー上にChromeブラウザを導入し、そのブラウザ上でPostmanのインストール作業を行う形で進めます。まず、Chromeブラウザを起動します。

image

以下のURLを開き、「CHROMEに追加」をクリックします。

https://chrome.google.com/webstore/detail/postman-rest-client/fdmmgilgnpjigdojojpjoooidkmcomcm

image

「Add」をクリックします。

image

Postmanの拡張が追加されますので、Postmanのアイコンをクリックします。

image

Postmanが起動されます。

image

Qlik Sense Repository Service(QRS) APIへの処理要求の送信

Qlik Sense Enterpriseのバージョン情報などの表示

URLの欄に、以下を入力します。

  • https://<サーバーアドレス>:4242/qrs/about

image

「URL params」、「Headers」のボタンをクリックします。

image

以下の「URL Parameter Key」と「Header」を入力し、「Send」をクリックします。

URL  Parameter Key Value
xrfkey 0123456789abcdef
Header Value
x-qlik-xrfkey 0123456789abcdef
x-qlik-user X-Qlik-User: UserDirectory=<directory>; UserId=<userid>

例) X-Qlik-User: UserDirectory=demo; UserId=sense_system

image

初めて実行する場合には、以下の様に証明書の選択画面が表示されます。「QlikClient(<サーバーアドレス-CA>)」を選択して「OK」をクリックします。

image

以下の様な結果が表示されます。

image

補足:
上記の処理は、証明書を利用して4242番ポート(Qlik Sense Proxy Service API service port)に対して直接実行しましたが、Qlik Sense Proxy Serviceを経由してQRSに対してリクエストを送信することも可能です。その場合には、ポート番号を指定しない「https://<サーバーアドレス>/qrs/about」の形式のURLを利用します。

また、その場合にはQlik Sense Enterpriseシステムにログオンされている必要があるため、以下の様に認証ウインドウが表示され、認証情報の入力が必要となります。
image

Qlik Senseアプリの一覧表示

URLを以下の様に変更して、「Send」ボタンをクリックします。

  • https://<サーバーアドレス>:4242/qrs/app

image

以下の様にアプリの一覧が表示されます。

image

Qlik Senseタスクのリロード実行

ここでは、Qlik Sense Enterpriseで標準で提供されている「Reload License Monitor」タスクを実行し、「License Monitor」アプリのリロードを実行します。まず、タスクの一覧を表示します。URLを以下の様に変更して、「Send」ボタンをクリックします。

  • https://<サーバーアドレス>:4242/qrs/task

image

タスクの一覧が表示されますので、「Reload License Monitor」タスクのidをコピーします。

image

URLを以下の様に変更し、メソッドを「POST」に変更して「Send」ボタンをクリックします。(以下の<タスクID>の個所には前ステップでコピーしたアプリのidを貼り付けます。)

  • https://<サーバーアドレス>:4242/qrs/task/<タスクID>/start/synchronous

image

タスクの実行が完了すると、以下の様にGUIDが返されます。

image

まとめ

今回のエントリでは、Chrome拡張のPostmanを利用して、「Qlik Sense Repository Service(QRS) API」を通じて幾つかのリクエストを送信し、処理を実行する手順を確認しました。この様な手順で、Qlik SenseのAPIの利用方法や取得できるデータの内容などを確認・テストすることが出来ます。尚、QRS APIで実行できるその他の処理などについては、以下のヘルプサイトをご参照ください。

Qlik Sense Help: Qlik Sense Repository Service API

また、Postmanを使って「Qlik Sense Proxy Service(QPS) API」に対しても同様にリクエストを送信することが出来ます。QPS APIの詳細については以下のヘルプサイトをご参照ください。

Qlik Sense Help: Qlik Sense Proxy Service API