Axios と CData Connect AI で Zuora に接続した Web アプリを構築
Axios は開発者が Web ブラウザや Node.js からサーバーに HTTP リクエストを送信できる JavaScript ライブラリです。CData Connect AI と組み合わせることで、Web アプリからライブZuora のデータにアクセスできます。この記事では、Zuora に接続し、Axios でライブZuora のデータにアクセスできる Web アプリを構築する方法を説明します。
Axios から Zuora に接続
Axios で Zuora を操作するには、Connect AI から Zuora に接続し、ユーザーにアクセス権を提供し、Zuora のデータ 用のワークスペースを作成する必要があります。
Connect AI から Zuora に接続
CData Connect AI はシンプルなポイントアンドクリックインターフェースでデータソースに接続できます。
- Connect AI にログインして「Sources」をクリック、次に「 Add Connection」をクリック
- 接続を追加パネルから「Zuora」を選択
-
Zuora に接続するために必要な認証プロパティを入力します。
Zuora はユーザー認証にOAuth 標準を使用しています。OAuth 認証ついて詳しくは、オンラインヘルプドキュメントを参照してください。
Tenant プロパティの設定
プロバイダへの有効な接続を作成するには、アカウントの設定と合致するテナント値を1つ選択する必要があります。以下は、利用可能なオプションのリストです。- USProduction:リクエストはhttps://rest.zuora.com に送信されます。
- USAPISandbox:リクエストはhttps://rest.apisandbox.zuora.com に送信されます。
- USPerformanceTest:リクエストはhttps://rest.pt1.zuora.com に送信されます。
- EUProduction:リクエストはhttps://rest.eu.zuora.com に送信されます。
- EUSandbox:リクエストはhttps://rest.sandbox.eu.zuora.com に送信されます。
デフォルトではUSProduction テナントを使用します。
Zuora サービスの選択
データクエリとAQuA API の2つのZuora サービスを使用します。デフォルトでは、ZuoraService はAQuADataExport に設定されています。DataQuery
データクエリ機能は、非同期の読み取り専用SQL クエリを実行することで、Zuora テナントからのデータのエクスポートを実現します。 このサービスは、素早く軽量なSQL クエリでの使用を推奨します。制限
- フィルタ適用後の、テーブルごとの入力レコードの最大数: 1,000,000
- 出力レコードの最大数: 100,000
- テナントごとの、実行用に送信される同時クエリの最大数: 5
- テナントごとの、同時クエリの制限に達した後に実行用に送信され、キューに追加されるクエリの最大数: 10
- 1時間単位での、各クエリの最大処理時間: 1
- GB 単位での、各クエリに割り当てられるメモリの最大サイズ: 2
- Index Join を使用する際のインデックスの最大値。言い換えれば、Index Join を使用する際にWHERE 句で使われる一意の値に基づいた、左のテーブルから返されるレコードの最大数: 20.000
AQuADataExport
AQuA API のエクスポートは、すべてのオブジェクト(テーブル)のすべてのレコードをエクスポートするように設計されています。AQuA のクエリジョブには以下の制限があります。制限
- AQuA のジョブ内のクエリが8時間以上実行されている場合、ジョブは自動的に停止されます。
- 停止されたAQuA のジョブは3回再試行可能で、その後失敗として返されます。
- 「Save & Test」をクリック
-
Zuora 接続の追加ページで「Permissions」タブに移動し、ユーザーベースのアクセス許可を設定します。
Personal Access Token の作成
REST API、OData API、または Virtual SQL Server を介して Connect AI に接続する場合、Personal Access Token(PAT)を使用して Connect AI への接続を認証します。アクセスの粒度を維持するために、サービスごとに個別の PAT を作成することをお勧めします。
- Connect AI アプリの右上にある歯車アイコン()をクリックして設定ページを開きます。
- 設定ページで「Access Tokens」セクションに移動し、「 Create PAT」をクリックします。
-
PAT に名前を付けて「Create」をクリックします。
- Personal Access Token は作成時にのみ表示されるため、必ずコピーして安全な場所に保存してください。
Axios 用に Zuora エンドポイントを設定
Zuora に接続したら、目的のテーブル用のワークスペースを作成します。
-
「Workspaces」ページに移動し、「 Add」をクリックして新しいワークスペースを作成します(または既存のワークスペースを選択)。
- 「 Add」をクリックしてワークスペースに新しいアセットを追加します。
-
Zuora 接続(例: Zuora1)を選択して「Next」をクリックします。
-
操作するテーブルを選択して「Confirm」をクリックします。
- ワークスペースの OData サービス URL をメモしておきます(例: https://cloud.cdata.com/api/odata/{workspace_name})。
接続、PAT、ワークスペースが設定できたので、Axios からZuora のデータに接続する準備が整いました。
Axios ワークフローで Zuora のデータに接続
OData プロトコルを使用して Axios から CData Connect AI への接続を確立するには、以下のステップに従います。
- Web アプリ用のプロジェクトディレクトリを作成します(例: ~/connect_cloud/)
- ターミナルを開き、プロジェクトディレクトリに移動して以下のコマンドで node プロジェクトを初期化します:
npm init -y
- 以下のコマンドでプロジェクトに Axios 依存関係をインストールします:
npm install axios
プロジェクトディレクトリに以下のコードを含む server.js ファイルを作成します。CData Connect AI のユーザー名(例: [email protected])と PAT(前提条件で作成した PAT)を指定します。また、SELECT * FROM Zuora1.SCHEMA.Invoices のようなデータクエリも指定する必要があります。
server.js コード
const axios = require('axios') const user = '[email protected]' const pat = '***********************************'; //API エンドポイント const url = 'https://cloud.cdata.com/api/odata/{workspace_name}'; //POST リクエストで送信するデータ const data = { "query":"SELECT * FROM {workspace_name}.SCHEMA.Invoices" }; axios.post(url, data, { auth: { username: user, password: pat } }) .then(response => { const rows = response.data.results[0].rows; const schema = response.data.results[0].schema; //カラム名の配列を作成 const columnNames = schema.map(col => col.columnName); //各行をループして、カラム名と値をログ出力 rows.forEach(row => { const rowObject = {}; row.forEach((value, index) => { const columnName = columnNames[index]; rowObject[columnName] = value; }); console.log(rowObject); }) }) .catch(error => { console.error('Error:', error); });- ターミナルで以下のコマンドを実行してサーバーを起動します:
node server.js
クエリ結果が表示されます:{ ID: 1, VALUE: -2 } { ID: 2, VALUE: 1 } { ID: 11, VALUE: null } { ID: 3, VALUE: 2 } { ID: 4, VALUE: 5 } ...
クラウドアプリケーションから Zuora のデータへの簡易アクセス
これで、Axios からライブZuora のデータへの直接接続が確立されました。Axios のようなクラウドアプリケーションから 100 以上の SaaS、ビッグデータ、NoSQL ソースへの簡易アクセスについての詳細は、Connect AI ページを参照してください。