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

こんにちは！ウェブ担当の加藤です。マーケ関連のデータ分析や整備もやっています。

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

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

Connect Cloud を構成

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

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

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

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

1. 「Users」ページに移動し、 Invite Users をクリックします。
2. 新しいユーザーのE メールアドレスを入力して、 Send をクリックしてユーザーを招待します。
3. 「Users」ページからユーザーを確認および編集できます。

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

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

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

Connect Cloud からZoho Projects に接続

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

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

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

   Zoho Projects に接続するには、Region をサーバーURL のトップレベルドメイン（TLD）に設定します。

   Zoho Projects への認証

   Zoho Projects は、データに接続する2つの方法を提供します。

   • デスクトップ経由で自分のローカルデータに接続する場合（非ブラウザ接続）は、CData が提供する組み込みOAuth アプリケーションを使用します。
   • ネットワーク経由で共有データに接続する場合（ブラウザ接続）は、カスタムOAuth アプリケーションを使用します。

   すべてのOAuth フロー（埋め込みまたはカスタム）で、この認証を有効にするにはAuthScheme をOAuth に設定する必要があります。

   ヘルプドキュメントでは、次の3つの一般的な認証フローでのZoho Projects への認証について詳しく説明します。

   • デスクトップ：ユーザーのローカルマシン上でのサーバーへの接続で、テストやプロトタイピングによく使用されます。埋め込みOAuth またはカスタムOAuth で認証されます。
   • Web：共有ウェブサイト経由でデータにアクセスします。カスタムOAuth でのみ認証されます。
   • ヘッドレスサーバー：他のコンピュータやそのユーザーにサービスを提供する専用コンピュータで、モニタやキーボードなしで動作するように構成されています。埋め込みOAuth またはカスタムOAuth で認証されます。

   認証方法の詳細は、ヘルプドキュメントを参照してください。

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

Connect Cloud にZoho Projects OData エンドポイントを追加する

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

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

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

1. まずは、ODataPHP SDK を使用してCData Connect Cloud が公開したWeb サービスに接続するプロキシクラスを作成します。

   URI 部分を書き換えて、次のようなコマンドを実行してください。

   php C:\PHPLib\ODataphp\PHPDataSvcUtil.php /uri=https://your-server:8032/api.rsc/@your-personal-access-token/ /out=C:\PHPLib\ODataphp\ZohoProjectsEntities.php

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

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

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

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

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