OData SDK for PHP を使ってRebilly のデータを取得
CData Connect AI はRebilly のデータをWeb サービスとして公開します。 この記事の手順を実行することで、Rebilly のデータをPHP オブジェクトとして扱うことができるようになります。
CData Connect AI はRebilly のデータへのクラウドベースのOData インターフェースを提供し、ODataPHP SDK からRebilly のデータへのリアルタイム連携を実現します。
Connect AI を構成
ODataPHP SDK でRebilly のデータを操作するには、Connect AI からRebilly に接続し、コネクションにユーザーアクセスを提供してRebilly のデータのOData エンドポイントを作成する必要があります。
Rebilly に接続したら、目的のテーブルのOData エンドポイントを作成します。
パーソナルアクセストークンの追加
OAuth 認証をサポートしていないサービス、アプリケーション、プラットフォーム、またはフレームワークから接続する場合は、認証に使用するパーソナルアクセストークン(PAT)を作成できます。きめ細かなアクセス管理を行うために、サービスごとに個別のPAT を作成するのがベストプラクティスです。
- Connect AI アプリの右上にあるユーザー名をクリックし、「User Profile」をクリックします。
- 「User Profile」ページで「Access Token」セクションにスクロールし、 Create PAT をクリックします。
- PAT の名前を入力して Create をクリックします。
- パーソナルアクセストークンは作成時にしか表示されないため、必ずコピーして安全に保存してください。
Connect AI からRebilly に接続
CData Connect AI では、簡単なクリック操作ベースのインターフェースでデータソースに接続できます。
- Connect AI にログインし、 Add Connection をクリックします。
- 「Add Connection」パネルから「Rebilly」を選択します。
-
必要な認証プロパティを入力し、Rebilly に接続します。
まず、Profile 接続プロパティをディスク上の Rebilly プロファイルの場所に設定します(例:C:\profiles\Rebilly.apip)。次に、ProfileSettings 接続プロパティを Rebilly の接続文字列に設定します(以下を参照)。
Rebilly API プロファイル設定
Rebilly で Automations > Integrations > Custom Integrations > API Keys に移動し、タイプとして Secret を選択して API キーを生成します。
- Create & Test をクリックします。
- 「Add Rebilly Connection」ページの「Permissions」タブに移動し、ユーザーベースのアクセス許可を更新します。
Connect AI にRebilly OData エンドポイントを追加する
Rebilly に接続したら、目的のテーブルのOData エンドポイントを作成します。
- OData ページに移動し、 Add をクリックして新しいOData エンドポイントを作成します。
- Rebilly 接続(例:API1)を選択し、Next をクリックします。
- 使用するテーブルを選択し、「Confirm」をクリックします。
コネクションとOData エンドポイントを設定したら、ODataPHP SDK からRebilly のデータに接続できます。
-
まずは、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\APIEntities.phpこのコマンドは、OData エンドポイントが返すメタデータからクラスを定義して、指定したフォルダにクラスの定義を出力します。
CData Connect AI およびOData SDK for PHP は、どちらもフォームとWindows 認証をサポートします。CData Connect AI はOData エンドポイントへのアクセスが認可されたユーザーの認証に、パーソナルアクセストークンを使用します。パーソナルアクセストークンはHTTP Basic 認証の際に渡したり、OData URL に付加することで使用できます。
認証済みのユーザーは、CData Connect AI の管理コンソールのUsers セクションで設定できます。
-
これで、PHP のオブジェクト指向インターフェースを使ってRebilly のデータにアクセスできます。以下のコードはAttachments テーブルのレコードを作成してリアルタイムデータを取得し、新しく作成したレコードを表示します。
require_once 'APIEntities.php'; try{ $svc = new CDataAPI(); $attachments = new Attachments(); $attachments->RelatedType = 'customer'; $svc->AddToAttachments($attachments); $svc->SetSaveChangesOptions(SaveChangesOptions::None); $svc->SaveChanges(); $response = $svc->attachments()->Execute(); foreach($response->Result as $attachments) echo $attachments->Id."
"; } catch (Exception $e) { //CData Connect AI からのエラーをキャッチ echo $e->getError(), "\n"; }