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

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

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

Connect AI を構成

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

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

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

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

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

Connect AI からHarvest に接続

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

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

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

   Harvest API プロファイル設定

   Harvest に認証するには、トークン認証またはOAuth 標準のいずれかを使用できます。自分のデータに接続するにはBasic 認証を使用します。他のユーザーが自分のデータに接続できるようにするにはOAuth を使用します。

   トークン認証の使用

   トークン認証を使用するには、ProfileSettings 接続プロパティでAPIKey にHarvest パーソナルアクセストークンを設定します。APIKey に加えて、ProfileSettings でAccountId を設定して接続します。

   OAuth 認証の使用

   まず、Harvest でOAuth2 アプリケーションを登録します。アプリケーションはHarvest ID の「Developers」セクションから作成できます。

   以下の接続プロパティを設定すると、接続できるようになります。

   • ProfileSettings：ProfileSettings でAccountId を設定します。
   • AuthScheme：OAuth に設定します。
   • OAuthClientId：アプリ設定で指定したclient ID に設定します。
   • OAuthClientSecret：アプリ設定で指定したclient secret に設定します。
   • CallbackURL：アプリ設定で指定したRedirect URI に設定します。
   • InitiateOAuth：GETANDREFRESH に設定します。InitiateOAuth を使用して、ドライバーがOAuthAccessToken を取得および更新する方法を管理できます。
   
4. Create & Test をクリックします。
5. 「Add Harvest Connection」ページの「Permissions」タブに移動し、ユーザーベースのアクセス許可を更新します。

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

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

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

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

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 のオブジェクト指向インターフェースを使ってHarvest のデータにアクセスできます。以下のコードはInvoices テーブルのレコードを作成してリアルタイムデータを取得し、新しく作成したレコードを表示します。

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