データ可視化ソリューション「Reveal」から Stripe に接続する方法
CData API Server を使って、Reveal にStripe データをフィードして、ビジュアライズを実現できます。コネクターによりリアルタイムデータ連携が可能になり、リフレッシュ操作で最新のデータを取得可能になります。この記事では、Reveal からStripe のデータに接続しビジュアライズする方法を説明します。
API Server の設定
以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなStripe OData サービスを作成していきましょう。
Stripe への接続
Reveal から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 のエンドポイントを表示およびコピーできます。
ダッシュボードの作成
それでは実際に可視化を行っていきます。「Reveal」ではダッシュボードという単位でいくつかのグラフを配置して、構成していきます。
- Revealにログインし、「新規」→「ダッシュボード」をクリックします。
- データソースから「ODataフィード」を選択し
- API ServerのAPIエンドポイントURLを指定し、資格情報を入力します。 URLは「https://XXXXXXX/api.rsc/」といったように末尾が「api.rsc」で終わっているものを入力します。
- 資格情報は「汎用資格情報」を選択し、
- あらかじめ作成しておいたAPI Serverのユーザー名と認証トークンをそれぞれ指定します。
- 認証完了後、エンティティセットを選択する画面に移動するので、取得したい任意のエンティティセットを選択します。
- これでダッシュボードを作成する準備が整いました。あとは Reveal の機能を使って、Stripe・API Serverから取得したデータを可視化・分析することができます。
- 以下のようなグラフを作成することができました。
このように Stripe 内のデータをAPI を書くことなく Reveal 上で処理することができるようになります。
おわりに
これで、リアルタイムStripe のデータから簡単なダッシュボードが作成できました。Stripe （および150 を超えるほかのソース）からのOData フィードの作成方法の詳細については、API Server のページにアクセスしてください。30 日間無料トライアルをダウンロードしてOData API を使用するツールでStripe のデータをリアルタイムに活用しましょう。