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

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

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

Connect AI を構成

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

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

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

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

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 CRM に接続

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

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

   Zoho CRM への接続

   それでは、Zoho CRM に接続していきましょう。データに接続するには、以下の接続パラメータを設定します。

   • Region：Zoho CRM サーバーURL のドメインに関連付けられたリージョン
   • Schema：Zoho CRM のバージョン（v2、v2.1、またはv4）。Zoho CRM のバージョンごとに独自のデータモデルがあります

   これらのプロパティに加えて、認可時にサンドボックスまたは開発者インスタンスのいずれかを選択した場合は、InstanceType 接続プロパティでも同じ設定を行ってください。

   Zoho CRM への認証

   Zoho CRM では、データへの認証に2つの方法が用意されています。お使いの環境に応じて適切な方法を選択てください。

   デスクトップ経由で自分のローカルデータに認証を行う場合（非ブラウザ接続）：CData 製品が提供する埋め込みOAuth アプリケーションを使用

   CData 製品はすでにZoho CRM にOAuth アプリケーションとして登録されています。そのため、デスクトップアプリケーションを介したローカルデータへの接続では、自動的に組み込みアプリケーションが使用されます。 OAuth 交換の繰り返しを避け、ローカルデータにアクセスするたびにOAuthAccessToken を手動で設定する手間を省くには、InitiateOAuth をGETANDREFRESH に設定してください。

   ネットワーク経由で共有データに認証を行う場合（ブラウザ接続）：カスタムOAuth アプリケーションを使用

   すべてのOAuth フローで、この認証を有効にするにはAuthScheme をOAuth に設定する必要があります。

   より詳細な認証手順については、ヘルプドキュメントの「Zoho CRM への認証」をご確認ください。

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

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

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

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

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

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\ZohoCRMEntities.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 CRM のデータにアクセスできます。以下のコードはAccounts テーブルのレコードを作成してリアルタイムデータを取得し、新しく作成したレコードを表示します。

   require_once 'ZohoCRMEntities.php';
   try{
     $svc = new CDataAPI();
     $accounts = new Accounts();
     $accounts->Industry = 'Data/Telecom OEM';
     $svc->AddToAccounts($accounts);
     $svc->SetSaveChangesOptions(SaveChangesOptions::None);
     $svc->SaveChanges();
     $response = $svc->accounts()->Execute();
     foreach($response->Result as $accounts)
       echo $accounts->Account_Name."";
   } catch (Exception $e) {    //CData Connect AI からのエラーをキャッチ
     echo $e->getError(), "\n";
   }