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

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

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

Connect AI を構成

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

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

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

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

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

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

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

   まず、Profile 接続プロパティにProcore プロファイルのディスク上の場所を設定します（例：C:\profiles\Procore.apip）。次に、ProfileSettings 接続プロパティにProcore の接続文字列を設定します（以下を参照）。

   Procore API プロファイル設定

   Procore に認証し、自分のデータに接続したり、他のユーザーが自分のデータに接続できるようにするには、OAuth 標準を使用できます。

   まず、Procore にOAuth アプリケーションを登録します。Developer Account にログインし、Create New App に移動することで登録できます。アプリを登録するために必要なすべてのステップに従います。まずSandbox Manifest の新しいバージョンを作成し、Production に昇格させてProduction Credentials を取得します。OAuth アプリケーションにはclient id とclient secret が割り当てられます。

   以下の接続プロパティを設定すると、接続の準備が整います：

   • AuthScheme：OAuth に設定します。
   • InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使用してOAuthAccessToken を取得するプロセスを管理できます。
   • OAuthClientId：アプリ設定で指定されているclient_id を設定します。
   • OAuthClientSecret：アプリ設定で指定されているclient_secret を設定します。
   • CallbackURL：アプリ設定で指定されているRedirect URI を設定します。
   
4. Create & Test をクリックします。
5. 「Add Procore Connection」ページの「Permissions」タブに移動し、ユーザーベースのアクセス許可を更新します。

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

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

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

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

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

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

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

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

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

   require_once 'APIEntities.php';
   try{
     $svc = new CDataAPI();
     $companies = new Companies();
     $companies->IsActive = 'true';
     $svc->AddToCompanies($companies);
     $svc->SetSaveChangesOptions(SaveChangesOptions::None);
     $svc->SaveChanges();
     $response = $svc->companies()->Execute();
     foreach($response->Result as $companies)
       echo $companies->Id."";
   } catch (Exception $e) {    //CData Connect AI からのエラーをキャッチ
     echo $e->getError(), "\n";
   }