OData SDK for PHP を使ってUM SaaS Cloud のデータを取得

CData Connect AI はUM SaaS Cloud のデータをWeb サービスとして公開します。 この記事の手順を実行することで、UM SaaS Cloud のデータをPHP オブジェクトとして扱うことができるようになります。

CData Connect AI はUM SaaS Cloud のデータへのクラウドベースのOData インターフェースを提供し、ODataPHP SDK からUM SaaS Cloud のデータへのリアルタイム連携を実現します。

Connect AI を構成

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

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

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

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

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

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

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

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

Connect AI からUM SaaS Cloud に接続

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

1. Connect AI にログインし、 Add Connection をクリックします。
2. 「Add Connection」パネルから「UM SaaS Cloud」を選択します。
3. 必要な認証プロパティを入力し、UM SaaS Cloud に接続します。

   UM SaaS Cloud 接続プロパティの取得・設定方法

   デフォルトでは、CData 製品は本番環境に接続します。UMSaaSCloud sandbox アカウントを使用するには、UseSandbox をtrue に設定します。ユーザー / パスワード認証を使用している場合は、User にsandbox のユーザー名を設定してください。

   UM SaaS Cloud への認証

   UM SaaS Cloud は、Basic、OAuth、OAuthJWT（コンシューマーキー）など、複数の認証方式をサポートしています。ここではBasic 認証について説明します。認証情報の詳しい取得方法や他の認証方法については、ヘルプドキュメントの「はじめに」セクションを参照してください。

   Basic 認証

   Basic 認証は、セキュリティトークンとユーザー資格情報の使用に基づきます。Basic 認証を使用するには、AuthScheme をBasic に、User とPassword をログイン資格情報に設定し、SecurityToken を設定します。

   デフォルトではSecurityToken が必要ですが、UM SaaS Cloud で信頼できるIP アドレスの範囲を設定することで、オプションにすることができます。

4. Create & Test をクリックします。
5. 「Add UM SaaS Cloud Connection」ページの「Permissions」タブに移動し、ユーザーベースのアクセス許可を更新します。

Connect AI にUM SaaS Cloud OData エンドポイントを追加する

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

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

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

1. まずは、ODataPHP SDK を使用してCData Connect AI が公開したWeb サービスに接続するプロキシクラスを作成します。

   URI 部分を書き換えて、次のようなコマンドを実行してください。

   php C:\PHPLib\ODataphp\PHPDataSvcUtil.php /uri=https://your-server:8032/api.rsc/@your-personal-access-token/ /out=C:\PHPLib\ODataphp\UMSaaSCloudEntities.php
   	    

   このコマンドは、OData エンドポイントが返すメタデータからクラスを定義して、指定したフォルダにクラスの定義を出力します。

   CData Connect AI およびOData SDK for PHP は、どちらもフォームとWindows 認証をサポートします。CData Connect AI はOData エンドポイントへのアクセスが認可されたユーザーの認証に、パーソナルアクセストークンを使用します。パーソナルアクセストークンはHTTP Basic 認証の際に渡したり、OData URL に付加することで使用できます。

   認証済みのユーザーは、CData Connect AI の管理コンソールのUsers セクションで設定できます。

2. これで、PHP のオブジェクト指向インターフェースを使ってUM SaaS Cloud のデータにアクセスできます。以下のコードはAccount テーブルのレコードを作成してリアルタイムデータを取得し、新しく作成したレコードを表示します。

   require_once 'UMSaaSCloudEntities.php';
   try{
     $svc = new CDataAPI();
     $account = new Account();
     $account->Industry = 'Floppy Disks';
     $svc->AddToAccount($account);
     $svc->SetSaveChangesOptions(SaveChangesOptions::None);
     $svc->SaveChanges();
     $response = $svc->account()->Execute();
     foreach($response->Result as $account)
       echo $account->BillingState."";
   } catch (Exception $e) {    //CData Connect AI からのエラーをキャッチ
     echo $e->getError(), "\n";
   }