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

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

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

Connect AI を構成

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

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

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

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

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

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

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

   Zoho Books 接続プロパティの取得・設定方法

   以下の接続プロパティを使用して、取得されるZoho Books データを正確に絞り込むことができます。

   • Region：サーバーURL のトップレベルドメイン（TLD）。アカウントが米国以外のドメインにある場合は、リージョンを適宜変更してください。
   • OrganizationId（オプション）：接続先の特定のZoho Books 組織に関連付けられたID。
     • Organization Id の値が接続文字列で指定されていない場合、ドライバーは利用可能なすべての組織を自動的に取得し、最初のOrganization Id をデフォルトとして選択します。

   Zoho Books への認証

   Zoho Books はOAuth 認証標準を使用します。詳しくは、ヘルプドキュメントの「はじめに」セクションを参照してください。

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

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

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

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

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

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

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

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

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

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

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