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

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

杉本和也
リードエンジニア
最終更新日：2021-12-23

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

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

CData Connect Server は、PingOne のデータのクラウド to クラウドの仮想OData インターフェースを提供し、BizteX Connect からリアルタイムにPingOne のデータへ連携することができます。
BizteX Connect からPingOne にデータ連携。

PingOne の仮想OData API エンドポイントを作成

まずCData Connect Server でデータソースへの接続およびOData API エンドポイント作成を行います。

CData Connect Server にログインして、Databases をクリックします。
利用できるデータソースアイコンから"PingOne" を選択します。
PingOne に接続するために必要なプロパティを入力します。
PingOne に接続するには以下のプロパティを設定します。
- Region：自身のPingOne 組織のデータがホスティングされている地域。
- AuthScheme：PingOne に接続する際に使用する認証の種類。
- WorkerAppEnvironmentId （デフォルトのPingOne ドメインを使用する場合に必要）、またはAuthorizationServerURL のいずれかで、下で説明するように設定します。
WorkerAppEnvironmentId の設定

WorkerAppEnvironmentId は、Worker アプリケーションが存在するPingOne 環境のID です。このパラメータは、環境がデフォルトのPingOne ドメイン（auth.pingone）を利用している場合のみ使用されます。これは、ヘルプドキュメントのカスタムOAuth アプリケーションの作成で説明するように、PingOne への認証に使用するカスタムOAuth アプリケーションを作成した後に設定します。

はじめに、このプロパティの値を見つけます。
1. 自身のPingOne 組織のホームページからナビゲーションサイドバーに移動し、Environments をクリックします。
2. OAuth / Worker のカスタムアプリケーションを作成した環境（通常はAdministrators）を見つけ、Manage Environment をクリックします。環境のホームページが表示されます。
3. 環境のホームページのナビゲーションサイドバーで、Applications をクリックします。
4. リストから、OAuth またはWorker アプリケーションの詳細を見つけます。
5. Environment ID フィールドの値をコピーします。以下の例に似たものになるはずです：
  WorkerAppEnvironmentId='11e96fc7-aa4d-4a60-8196-9acf91424eca'
次に、WorkerAppEnvironmentId をEnvironment ID フィールドの値に設定します。

AuthorizationServerURL の設定

AuthorizationServerURL は、お使いのアプリケーションが配置されている環境のPingOne 認可サーバーのベースURL です。このプロパティは、PingOne プラットフォームAPI ドキュメントで説明されているように、環境にカスタムドメインを設定した場合にのみ使用されます。 Custom Domains を参照してください。

OAuth でのPingOne への認証

PingOne はOAuth とOAuthClient 認証の両方をサポートしています。上述の設定手順に加え、OAuth またはOAuthCliet 認証をサポートするために、さらに2つの手順を完了する必要があります。
- ヘルプドキュメントのカスタムOAuth アプリケーションの作成で説明するように、カスタムOAuth アプリケーションを作成して設定します。
- ドライバーがデータモデル内のエンティティにアクセスできるようにするには、ヘルプドキュメントのAdministrator Roles での説明のとおり、使用するアドミンユーザー / ワーカーアプリケーションに対して正しいロールを設定していることを確認してください。
- 以下のサブセクションで説明されているように、選択した認証スキームと認証フローに適切なプロパティを設定します。
OAuth（認可コードグラント）

AuthScheme をOAuth に設定します。

デスクトップアプリケーション

OAuth アクセストークンの取得およびリフレッシュ

以下を設定して、接続してください。
- InitiateOAuth：GETANDREFRESH。繰り返しOAuth の交換を行ったり、手動でOAuthAccessToken を設定する必要をなくすには、InitiateOAuth を使用します。
- OAuthClientId：カスタムOAuth アプリケーションを作成した際に取得したClient ID。
- OAuthClientSecret：カスタムOAuth アプリケーションを作成した際に取得したClient Secret。
- CallbackURL：カスタムOAuth アプリケーションの登録時に定義したリダイレクトURI。例：https://localhost:3333
接続すると、本製品はデフォルトブラウザでPingOne のOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。ドライバーはこれでOAuth プロセスを完了します。
1. ドライバーはPingOne からアクセストークンを取得し、それを使ってデータをリクエストします。
2. OAuth 値はOAuthSettingsLocation で指定された場所に保存され、接続間で永続化されるようにします。
ドライバーはアクセストークンの期限が切れると自動的にリフレッシュします。

Web アプリケーションやヘッドレスマシン、クライアントクレデンシャルグラントを含むその他のOAuth メソッドについては、ヘルプドキュメントを参照してください。
Test Database をクリックします。
Permission -> Add をクリックして、新しいユーザーを追加し、適切な権限を指定します。
API タブをクリックして OData API エンドポイントが生成されていることを確認します。

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

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

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

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

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

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

起動イベントの設定

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

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

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

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

HTTP コネクタの構成

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

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

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

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

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