OData を介してTIBCO Spotfire でStripe のデータをビジュアライズ
OData は、クラウドベース、モバイル、およびその他のオンラインアプリケーション間のリアルタイム通信を可能にする主要なプロトコルです。CData API Server は、Stripe のADO.NET Provider for Stripe と組み合わせると、Stripe のデータ(またはその他の250+ のADO.NET Providers データ)をTIBCO Spotfire などのOData コンシューマに提供します。この記事では、API Server とSpotfire のOData の組み込みサポートを使用して、Stripe のデータにリアルタイムでアクセスする方法を説明します。
API Server の設定
以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなStripe OData サービスを作成していきましょう。
Stripe への接続
TIBCO Spotfire からStripe のデータを操作するには、まずStripe への接続を作成・設定します。
- API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
- 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「Stripe」を選択します。
- 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
CData コネクタの追加方法はこちら >> - それでは、Stripe への接続設定を行っていきましょう!
-
Stripeへの接続
それでは、Stripe への接続について説明していきましょう。Stripe では、本番API キーまたはOAuth のいずれかによる認証をサポートしています。
本番API キー
本番API キーで接続するには、以下の2つの設定パラメータを設定する必要があります。
- AuthScheme = APIKey
- LiveAPIKey = 本番API キーの値
本番API キーの値を取得するには、以下の手順で確認できます:
- Stripe ダッシュボードにログインします
- 開発者 → API キー → シークレットキー → 本番環境のキーを表示 に移動します
Stripe では、テストモードで作成されたシークレットキーを使用して、'StripeV2' データモデルのエンティティにはアクセスできませんのでご注意ください。ライブモードまたはサンドボックスモードで作成されたシークレットキーをご利用ください。 さらに、制限付きキーを使用して'StripeV2' データモデルのエンティティにアクセスすることも許可されていません。
OAuth については、ヘルプドキュメントの「接続の確立」をご確認ください。
- 接続情報の入力が完了したら、「保存およびテスト」をクリックします。
Stripeへの接続
それでは、Stripe への接続について説明していきましょう。Stripe では、本番API キーまたはOAuth のいずれかによる認証をサポートしています。
本番API キー
本番API キーで接続するには、以下の2つの設定パラメータを設定する必要があります。
- AuthScheme = APIKey
- LiveAPIKey = 本番API キーの値
本番API キーの値を取得するには、以下の手順で確認できます:
- Stripe ダッシュボードにログインします
- 開発者 → API キー → シークレットキー → 本番環境のキーを表示 に移動します
Stripe では、テストモードで作成されたシークレットキーを使用して、'StripeV2' データモデルのエンティティにはアクセスできませんのでご注意ください。ライブモードまたはサンドボックスモードで作成されたシークレットキーをご利用ください。 さらに、制限付きキーを使用して'StripeV2' データモデルのエンティティにアクセスすることも許可されていません。
OAuth については、ヘルプドキュメントの「接続の確立」をご確認ください。
API Server のユーザー設定
次に、API Server 経由でStripe にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。
- 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
-
次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
-
その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。
Stripe 用のAPI エンドポイントの作成
ユーザーを作成したら、Stripe のデータ用のAPI エンドポイントを作成していきます。
-
まず、「API」ページに移動し、
「 テーブルを追加」をクリックします。
-
アクセスしたい接続を選択し、次へをクリックします。
-
接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。
OData のエンドポイントを取得
以上でStripe への接続を設定してユーザーを作成し、API Server でStripe データのAPI を追加しました。これで、OData 形式のStripe データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。
外部Stripe のデータでデータビジュアライゼーションを作成する
- 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 エンドポイントを入力します。例:
- ダッシュボードに追加するテーブルとカラムを選択します。この例ではCustomers を使います。
- リアルタイムデータを使いたい場合は、「Keep Data Table External」オプションをクリックします。このオプションは、データの変更をリアルタイムでダッシュボードに反映します。
データをメモリにロードしてローカルで処理したい場合は、「Import Data Table」オプションをクリックします。このオプションは、オフラインでの使用、またはネットワーク接続が遅くダッシュボードとのやり取りが遅延する場合に適しています。
- テーブルを追加すると「Recommended Visualizations」ウィザードが表示されます。テーブルを選択すると、Spotfire はカラムのデータ型を使ってnumber、time、category カラムを検出します。この例ではNumbers セクションでDiscount を、Categories セクションでEmail を使用しています。

[Recommended Visualizations]ウィザードでいくつかビジュアライズを作成したら、ダッシュボードにその他の修正を加えることができ、例えばフィルタを適用できます。「Filter」ボタンをクリックすると、各クエリで使用可能なフィルタが「Filters」ペインに表示されます。