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

こんにちは！リードエンジニアの杉本です。

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

API Server の設定

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

デプロイ

API Server は内蔵のJetty サーバー上で動作します。Windows をお使いの場合は、スタンドアロンサーバーとして起動するか、IIS に組み込んで使用することが可能です。また、お使いのJava サーブレットコンテナにAPI Server のWAR ファイルを配置して実行することもできます。具体的なセットアップ方法については、こちらのヘルプドキュメントをご覧ください。

Zuora への接続

Salesforce Connect から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 プロパティの設定

• 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 サービスの選択

DataQuery

制限

• フィルタ適用後の、テーブルごとの入力レコードの最大数： 1,000,000
• 出力レコードの最大数： 100,000
• テナントごとの、実行用に送信される同時クエリの最大数： 5
• テナントごとの、同時クエリの制限に達した後に実行用に送信され、キューに追加されるクエリの最大数： 10
• 1時間単位での、各クエリの最大処理時間： 1
• GB 単位での、各クエリに割り当てられるメモリの最大サイズ： 2
• Index Join を使用する際のインデックスの最大値。言い換えれば、Index Join を使用する際にWHERE 句で使われる一意の値に基づいた、左のテーブルから返されるレコードの最大数： 20.000

AQuADataExport

制限

• 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 の設定方法 記事を参考にしてください。

プロジェクト・シナリオの作成

API Server 側の準備が完了したら、早速BizteX Connect 側でプロジェクト・シナリオの作成を開始します。

1. まずはプロジェクトとシナリオ（フロー）を作成します。シナリオ（フロー）はプロジェクト単位でまとめて管理できるようです。

2. 「新規プロジェクト作成」をクリック

3. 任意の名称でプロジェクトを作成します。

4. その後「＋新規シナリオ作成」をクリックして、kintone データ連携シナリオの作成を進めていきます。

起動イベントの設定

シナリオの作成で一番最初に設定することが、起動イベントの構成です。BizteX Connect ではさまざまな起動イベントが存在しますが、今回は検証用途として「手動」実行にしてみました。

1. 「アプリ選択」の一覧から「一般」を選択し

2. 「ボタンを押して実行」を選択します。

3. それぞれのイベントでは出力データが変数として格納されます。内容を確認して「完了して次へ」をクリックしましょう。

HTTP コネクタの構成

今回のシナリオでは、Zuora のデータを取得して BizteX Connect で扱えるようにします。

1. API Server へのアクセスには「HTTP コネクタ」が利用できるので、アプリの一覧から選択します。

2. アクションは「HTTP リクエスト」を指定します。

3. 続いて、データを取得するためのAPI リクエストを指定します。今回はデータを取得するのでGET リクエストです。対象のURL はAPI Server のAPI ドキュメントから取得してきて指定しましょう。

4. 基本設定が完了したら、オプションを指定します。ここで最低限必要になるオプションはAPI Server への認証情報の指定です。以下のようなJSON 形式でx-cdata-authtoken のプロパティにAPI Server で構成したユーザーのトークンを指定すれば接続が行えます。

5. すべての設定が完了したら出力結果を確認してみましょう。以下のようにBody の中の「value」オブジェクトの中に配列形式でデータが格納されていることが確認できます。正常にBizteX Connect からZuora のデータが取得できていますね。

6. あとはBizteX Connect の各種機能を活用して、さまざまなサービスとの連携を実現できます。

このように、CData API Server を経由することで、API 側の複雑な仕様を意識せずにAPI 連携をしたプロジェクトをBizteX Connect で開発できます。他にも多くのデータソースに対応するCData API Server の詳細をこちらからご覧ください。