クラウドRPA BizteX Connect でAPI のデータにアクセス

杉本和也
リードエンジニア

CData Connect AI を使ってAPI のデータのOData API エンドポイントを作成し、BizteX Connect からAPI のデータにアクセスする方法。

BizteX Connect は BizteX 社が提供する国産iPaaS です。ノーコードでkintone やChatwork などさまざまなクラウドサービスと連携したフローを作成し、業務の自動化・効率化を実現することができます。この記事では、CData Connect AI を経由して BizteX Connect からAPI のデータを取得し活用する方法を説明します。

CData Connect AI はAPI のデータへのクラウドベースのOData インターフェースを提供し、BizteX Connect からAPI のデータへのアクセスを実現します。

Connect AI を構成

BizteX Connect でAPI のデータを操作するには、Connect AI からAPI に接続し、コネクションにユーザーアクセスを提供してAPI のデータのOData エンドポイントを作成する必要があります。

API に接続したら、目的のテーブルのOData エンドポイントを作成します。

（オプション）新しいConnect AI ユーザーの追加

必要であれば、Connect AI 経由でAPI に接続するユーザーを作成します。

「Users」ページに移動し、 Invite Users をクリックします。
新しいユーザーのE メールアドレスを入力して、 Send をクリックしてユーザーを招待します。
「Users」ページからユーザーを確認および編集できます。

パーソナルアクセストークン（PAT）の追加

OAuth 認証をサポートしていないサービス、アプリケーション、プラットフォーム、またはフレームワークから接続する場合は、認証に使用するパーソナルアクセストークン（PAT）を作成できます。きめ細かなアクセス管理を行うために、サービスごとに個別のPAT を作成するのがベストプラクティスです。

Connect AI アプリの右上にあるユーザー名をクリックし、「User Profile」をクリックします。
「User Profile」ページで「Access Token」セクションにスクロールし、 Create PAT をクリックします。
PAT の名前を入力して Create をクリックします。
パーソナルアクセストークン（PAT）は作成時にしか表示されないため、必ずコピーして安全に保存してください。

Connect AI からAPI に接続

CData Connect AI では、簡単なクリック操作ベースのインターフェースでデータソースに接続できます。

Connect AI にログインし、 Add Connection をクリックします。
「Add Connection」パネルから「API」を選択します。
必要な認証プロパティを入力し、API に接続します。
To connect to your API, configure the following properties on the Global Settings page:
- In Authentication, select the Type and fill in the required properties
- In Headers, add the required HTTP headers for your API
- In Pagination, select the Type and fill in the required properties
After the configuring the global settings, navigate to the Tables to add tables. For each table you wish to add:
1. Click "+ Add"
2. Set the Name for the table
3. Set Request URL to the API endpoint you wish to work with
4. (Optional) In Parameters, add the required URL Parameters for your API endpoint
5. (Optional) In Headers, add the required HTTP headers for the API endpoint
6. In Table Data click " Configure"
7. Review the response from the API and click "Next"
8. Select which element to use as the Repeated Elements and which elements to use as Columns and click "Next"
9. Preview the tabular model of the API response and click "Confirm"
Create & Test をクリックします。
「Add API Connection」ページの「Permissions」タブに移動し、ユーザーベースのアクセス許可を更新します。

Connect AI にAPI OData エンドポイントを追加する

API に接続したら、目的のテーブルのOData エンドポイントを作成します。

OData ページに移動し、 Add をクリックして新しいOData エンドポイントを作成します。
API 接続（例：API1）を選択し、Next をクリックします。
使用するテーブルを選択し、「Confirm」をクリックします。

コネクションとOData エンドポイントを設定したら、BizteX Connect からAPI のデータに接続できます。

API のデータに接続したプロジェクト・シナリオの作成

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

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

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

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

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

起動イベントの設定

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

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

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

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

HTTP コネクタの構成

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

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

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

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

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