OData を介してTIBCO Spotfire でPostmark のデータをビジュアライズ
OData は、クラウドベース、モバイル、およびその他のオンラインアプリケーション間のリアルタイム通信を可能にする主要なプロトコルです。CData API Server は、Postmark のADO.NET Provider for API と組み合わせると、Postmark のデータ（またはその他の240+ のADO.NET Providers データ）をTIBCO Spotfire などのOData コンシューマに提供します。この記事では、API Server とSpotfire のOData の組み込みサポートを使用して、Postmark のデータにリアルタイムでアクセスする方法を説明します。
API Server の設定
以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなPostmark OData サービスを作成していきましょう。
Postmark への接続
TIBCO Spotfire からPostmark のデータを操作するには、まずPostmark への接続を作成・設定します。
- API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
- 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「Postmark」を選択します。
- 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >> - それでは、Postmark への接続設定を行っていきましょう！
-
API キー認証の設定
Postmark は、リクエストの認証にサーバー API トークンを使用します。各 Postmark サーバーは独自の API トークンを持ち、そのサーバーに関連付けられたメッセージ、バウンス、テンプレート、統計情報へのアクセスを制御します。
Server API Token を取得するには、Postmark アカウントにログインし、接続したいサーバーに移動します。サーバー設定の API Tokens に移動して、Server API token というラベルのトークンをコピーしてください。
以下の接続プロパティを設定して接続を確立してください：
- AuthScheme：APIKey に設定します。
- APIKey：Postmark の Server API Token に設定します。この値は、すべてのリクエストで X-Postmark-Server-Token ヘッダーとして送信されます。
接続文字列の例：
Profile=C:\profiles\Postmark.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your-server-api-token"
Postmark への接続
認証を設定すると、Postmark に接続して、OutboundMessages、Bounces、Templates などの利用可能なテーブルからデータをクエリできます。
- 接続情報の入力が完了したら、「保存およびテスト」をクリックします。
API キー認証の設定
Postmark は、リクエストの認証にサーバー API トークンを使用します。各 Postmark サーバーは独自の API トークンを持ち、そのサーバーに関連付けられたメッセージ、バウンス、テンプレート、統計情報へのアクセスを制御します。
Server API Token を取得するには、Postmark アカウントにログインし、接続したいサーバーに移動します。サーバー設定の API Tokens に移動して、Server API token というラベルのトークンをコピーしてください。
以下の接続プロパティを設定して接続を確立してください：
- AuthScheme：APIKey に設定します。
- APIKey：Postmark の Server API Token に設定します。この値は、すべてのリクエストで X-Postmark-Server-Token ヘッダーとして送信されます。
接続文字列の例：
Profile=C:\profiles\Postmark.apip;AuthScheme=APIKey;ProfileSettings="APIKey=your-server-api-token"
Postmark への接続
認証を設定すると、Postmark に接続して、OutboundMessages、Bounces、Templates などの利用可能なテーブルからデータをクエリできます。
API Server のユーザー設定
次に、API Server 経由でPostmark にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。
- 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
-
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
-
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。
Postmark 用のAPI エンドポイントの作成
ユーザーを作成したら、Postmark のデータ用のAPI エンドポイントを作成していきます。
-
まず、「API」ページに移動し、
「 テーブルを追加」をクリックします。
-
アクセスしたい接続を選択し、次へをクリックします。
-
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。
OData のエンドポイントを取得
以上でPostmark への接続を設定してユーザーを作成し、API Server でPostmark データのAPI を追加しました。これで、OData 形式のPostmark データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。
外部Postmark のデータでデータビジュアライゼーションを作成する
- Spotfire を開き、「Add Data Tables」->「OData」をクリックします。
- 「OData Connection」ダイアログで、以下の情報を入力します。
- Service URL：API Server のOData エンドポイントを入力します。例：
http://localhost:8032/api.rsc
- Authentication Method：Username とPassword を選択します。
- Username：API Server ユーザーのユーザー名を入力します。管理コンソールの「Security」タブでAPI ユーザーを作成できます。
- Password：API Server でユーザーの認証トークンを入力します。
- Service URL：API Server のOData エンドポイントを入力します。例：
- ダッシュボードに追加するテーブルとカラムを選択します。この例ではBounces を使います。
- リアルタイムデータを使いたい場合は、「Keep Data Table External」オプションをクリックします。このオプションは、データの変更をリアルタイムでダッシュボードに反映します。
データをメモリにロードしてローカルで処理したい場合は、「Import Data Table」オプションをクリックします。このオプションは、オフラインでの使用、またはネットワーク接続が遅くダッシュボードとのやり取りが遅延する場合に適しています。
- テーブルを追加すると「Recommended Visualizations」ウィザードが表示されます。テーブルを選択すると、Spotfire はカラムのデータ型を使ってnumber、time、category カラムを検出します。この例ではNumbers セクションで を、Categories セクションで を使用しています。
［Recommended Visualizations］ウィザードでいくつかビジュアライズを作成したら、ダッシュボードにその他の修正を加えることができ、例えばフィルタを適用できます。「Filter」ボタンをクリックすると、各クエリで使用可能なフィルタが「Filters」ペインに表示されます。