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

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

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

Connect AI を構成

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

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

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

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

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

Connect AI からServiceDesk Plus に接続

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

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

   OAuth 認証の設定

   ServiceDeskPlus は、安全な認証のために Zoho OAuth 2.0 を使用します。OAuth アクセスをセットアップするには、以下のステップで進めます：

   1. https://api-console.zoho.com の Zoho Developer Console でアプリケーションを登録します
   2. アプリケーション構成に合わせてリダイレクト URI を設定します
   3. アプリケーション設定から Client ID と Client Secret を控えておきます

   以下の接続プロパティを設定して接続を確立してください：

   • AuthScheme：OAuth に設定します。
   • OAuthClientId：Zoho アプリケーションの Client ID に設定します。
   • OAuthClientSecret：Zoho アプリケーションの Client Secret に設定します。
   • Scope：必要な ServiceDeskPlus の権限に設定します（デフォルトでは requests、problems、assets、projects への読み取りアクセスが含まれます）。
   • Domain：ServiceDeskPlus のドメインに設定します。
   • Portal：ServiceDeskPlus のポータルに設定します。

   接続文字列の例

   Profile=C:\profiles\ServiceDeskPlus.apip;ProfileSettings="Portal=itdesk;Domain=.in;Scope=SDPOnDemand.requests.READ SDPOnDemand.problems.READ SDPOnDemand.assets.READ SDPOnDemand.projects.READ";AuthScheme=OAuth;OAuthClientId=your_client_id;OAuthClientSecret=your_client_secret;
   

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

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

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

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

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

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

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