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

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

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

Connect AI を構成

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

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

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

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

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 からOData に接続

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

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

   OData への接続

   OData に接続するには、Url を有効なOData サービスルートURI に設定する必要があります。 OData サービスにルートドキュメントがない場合、テーブルとして公開したい特定のエンティティをFeedURL に指定してください。

   OData への認証

   OData は、以下を経由する認証をサポートします。

   • HTTP
   • Kerberos
   • SharePoint Online
   • OAuth
   • Azure AD

   HTTP 認証スキーム

   HTTP で認証する場合は、次の表に従ってAuthScheme を設定します。

   Scheme	AuthScheme	その他の設定
   None	None	認証を必要としない場合に使用。
   Basic	Basic	User、Password
   NTLM	NTLM	User、Password
   Digest（サポートされている場合）	Digest	User、Password

   その他の認証方法の詳細は、ヘルプドキュメントの「接続の確立」セクションを参照してください。

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

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

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

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

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

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\ODataEntities.php
   	    

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

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

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

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

   require_once 'ODataEntities.php';
   try{
     $svc = new CDataAPI();
     $orders = new Orders();
     $orders->ShipCity = 'New York';
     $svc->AddToOrders($orders);
     $svc->SetSaveChangesOptions(SaveChangesOptions::None);
     $svc->SaveChanges();
     $response = $svc->orders()->Execute();
     foreach($response->Result as $orders)
       echo $orders->OrderName."";
   } catch (Exception $e) {    //CData Connect AI からのエラーをキャッチ
     echo $e->getError(), "\n";
   }