Bubble で使えるZuora のデータ連携用のバックエンドAPI をノーコードで開発

杉本和也
杉本和也
リードエンジニア
ノーコードツールBubble から Zuora のデータに接続するためのバックエンドAPI Server をCData API Server で構築



CData API Server を使って、Bubble から Zuora に接続してデータを取得する方法を説明します。

API Server の設定

以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなZuora OData サービスを作成していきましょう。

Zuora への接続

Bubble からZuora のデータを操作するには、まずZuora への接続を作成・設定します。

  1. API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。 接続を追加
  2. 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「Zuora」を選択します。
  3. 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
    CData コネクタの追加方法はこちら >>
  4. それでは、Zuora への接続設定を行っていきましょう！ 接続設定

  5. 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回再試行可能で、その後失敗として返されます。
  6. 接続情報の入力が完了したら、「保存およびテスト」をクリックします。

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回再試行可能で、その後失敗として返されます。

API Server のユーザー設定

次に、API Server 経由でZuora にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。

  1. 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
  2. 次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
  3. その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。

Zuora 用のAPI エンドポイントの作成

ユーザーを作成したら、Zuora のデータ用のAPI エンドポイントを作成していきます。

  1. まず、「API」ページに移動し、 「 テーブルを追加」をクリックします。
  2. アクセスしたい接続を選択し、次へをクリックします。
  3. 接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。

OData のエンドポイントを取得

以上でZuora への接続を設定してユーザーを作成し、API Server でZuora データのAPI を追加しました。これで、OData 形式のZuora データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。

オンプレミスDB やファイルからのAPI Server 使用（オプション）

オンプレミスRDB やExcel/CSV などのファイルのデータを使用する場合には、API Server のCloug Gateway / SSH ポートフォワーディングが便利です。是非、Cloud Gatway の設定方法 記事を参考にしてください。

Zuora のデータに接続したアプリを作成

OData エンドポイントをAPI Server に追加したら、Zuora のデータへのライブ接続が可能なアプリをBubble で作成できます。

Bubble API Connector を設定

まずは、Bubble からCData API Server にアクセスするためのAPI Connector を設定します。

  1. アプリ内で、Plugins タブをクリックして Add plugins をクリックします。
  2. 「API Connector」を検索して「Install」をクリックします。 API Connector プラグインのインストール
  3. インストール後、「Add another API」ボタンをクリックしてAPI を設定します。
    • API に名前を設定します。
    • Authentication を「HTTP Basic Auth」に設定します。
    • Username をAPI Server のユーザーに設定します（user@mydomain.com）。
    • Password を上記のユーザーのPAT に設定します。
    • API Call を展開して、「GET」コマンドを選択してURL を先ほど設定したOData エンドポイントに設定します。
    API Call を設定
  4. 「Initialize call」ボタンをクリックしてレスポンスのデータ型を必要に応じて調整します。 call を初期化
  5. 必要な変更を加えた後、「SAVE」をクリックします。 データ型を保存

App UI の設定

API Connector を設定したら、Bubble アプリでZuora のデータを取得できます。本記事では、Excel ライクなテーブルを表示できるUI コンポーネントでデータをリクエストします。

  1. Plugin タブで、「Excel-like HandsonTable」をインストールします。 Excel-like HandsonTable プラグインを追加
  2. Design タブで、「Excel Table」をワークスペースに追加します。 Excel Table をアプリに追加
  3. Excel Table のData source で、「Get data from an external API」を選択します。
  4. Type of content を「API Call value」に設定します。
  5. Data source を"API Server - ＜API Call の値＞"（またはこれと同等な値）に設定します。 Excel Table をAPI Call にバインド
  6. 「Preview」をクリックしてZuora からデータが取得できたことを確認します。 アプリをプレビュー

この時点で、バックエンドAPI を設定する手間なくZuora のデータへのライブ接続を持つアプリケーションを開発できます。

クラウドアプリケーションからZuora のデータへのライブ接続

Bubble からZuora のリアルタイムデータに直接接続できるようになりました。これで、Zuora のデータを複製せずにより多くの接続とアプリを作成できます。

まとめと30日の無償評価版のご案内

このように Zuora 内のデータをBubble で利用することができるようになります。CData API Server は、30日の無償評価版があります。是非、お試しいただき、Bubble からのデータ参照を体感ください。

はじめる準備はできましたか？

詳細はこちら、または無料トライアルにお申し込みください：

CData API Server お問い合わせ

この記事の内容

関連記事