PHP のOData SDK を使用したTalkdesk のデータのクエリ

CData API Server は、ADO.NET Provider for Talkdesk（またはその他の250+ ADO.NET Providers のデータ）と組み合わせることで、Talkdesk のデータをWeb サービスとして公開します。下記の手順に従って、Talkdesk のデータをPHP オブジェクトとして使用しましょう。

API Server の設定

以下のリンクからAPI Server の無償トライアルをスタートしたら、セキュアなTalkdesk OData サービスを作成していきましょう。

Talkdesk への接続

PHP からTalkdesk のデータを操作するには、まずTalkdesk への接続を作成・設定します。

1. API Server にログインして、「Connections」をクリック、さらに「接続を追加」をクリックします。
2. 「接続を追加」をクリックして、データソースがAPI Server に事前にインストールされている場合は、一覧から「Talkdesk」を選択します。
3. 事前にインストールされていない場合は、コネクタを追加していきます。コネクタ追加の手順は以下の記事にまとめてありますので、ご確認ください。
   CData コネクタの追加方法はこちら >>
4. それでは、Talkdesk への接続設定を行っていきましょう！

5. Talkdesk では OAuth 2.0 の Client Credentials グラントを使用します。ブラウザでの認可ステップやコールバック URL は必要ありません。

   以下の接続プロパティを設定します。

   • AccountName：Talkdesk アカウントの名前。
   • Region：Talkdesk インスタンスがデプロイされているリージョン。指定できる値は US（デフォルト）、EU、CA、AU、UK、FedRamp です。
   • OAuthClientId：カスタム OAuth アプリケーションの登録時に割り当てられた Client Id。
   • OAuthClientSecret：カスタム OAuth アプリケーションに割り当てられた Client Secret。

   カスタム OAuth アプリケーションの作成

   1. Talkdesk アカウントにログインし、ナビゲーションメニューから OAuth Clients を選択します。
   2. Create OAuth Client をクリックし、クライアントにわかりやすい名前を付けます。
   3. Grant Type を Client Credentials に設定します。
   4. Add scopes をクリックし、アクセスしたいデータに応じたスコープを選択します。
   5. Create をクリックし、Client Id と Client Secret をコピーします。

   接続時、ドライバーは Talkdesk にアクセストークンを自動でリクエストしてキャッシュし、有効期限が切れると更新します。アプリケーションで選択したスコープが、クエリ予定のビューに対応していることを確認してください。対応していない場合、トークンのリクエストが失敗することがあります。

6. 接続情報の入力が完了したら、「保存およびテスト」をクリックします。

Talkdesk では OAuth 2.0 の Client Credentials グラントを使用します。ブラウザでの認可ステップやコールバック URL は必要ありません。

以下の接続プロパティを設定します。

• AccountName：Talkdesk アカウントの名前。
• Region：Talkdesk インスタンスがデプロイされているリージョン。指定できる値は US（デフォルト）、EU、CA、AU、UK、FedRamp です。
• OAuthClientId：カスタム OAuth アプリケーションの登録時に割り当てられた Client Id。
• OAuthClientSecret：カスタム OAuth アプリケーションに割り当てられた Client Secret。

カスタム OAuth アプリケーションの作成

1. Talkdesk アカウントにログインし、ナビゲーションメニューから OAuth Clients を選択します。
2. Create OAuth Client をクリックし、クライアントにわかりやすい名前を付けます。
3. Grant Type を Client Credentials に設定します。
4. Add scopes をクリックし、アクセスしたいデータに応じたスコープを選択します。
5. Create をクリックし、Client Id と Client Secret をコピーします。

接続時、ドライバーは Talkdesk にアクセストークンを自動でリクエストしてキャッシュし、有効期限が切れると更新します。アプリケーションで選択したスコープが、クエリ予定のビューに対応していることを確認してください。対応していない場合、トークンのリクエストが失敗することがあります。

API Server のユーザー設定

次に、API Server 経由でTalkdesk にアクセスするユーザーを作成します。「Users」ページでユーザーを追加・設定できます。やってみましょう。

1. 「Users」ページで ユーザーを追加をクリックすると、「ユーザーを追加」ポップアップが開きます。
2. 次に、「ロール」、「ユーザー名」、「権限」プロパティを設定し、「ユーザーを追加」をクリックします。
3. その後、ユーザーの認証トークンが生成されます。各ユーザーの認証トークンとその他の情報は「Users」ページで確認できます。

Talkdesk 用のAPI エンドポイントの作成

ユーザーを作成したら、Talkdesk のデータ用のAPI エンドポイントを作成していきます。

1. まず、「API」ページに移動し、 「 テーブルを追加」をクリックします。
2. アクセスしたい接続を選択し、次へをクリックします。
3. 接続を選択した状態で、各テーブルを選択して確認をクリックすることでエンドポイントを作成します。

OData のエンドポイントを取得

以上でTalkdesk への接続を設定してユーザーを作成し、API Server でTalkdesk データのAPI を追加しました。これで、OData 形式のTalkdesk データをREST API で利用できます。API Server の「API」ページから、API のエンドポイントを表示およびコピーできます。

Talkdesk では OAuth 2.0 の Client Credentials グラントを使用します。ブラウザでの認可ステップやコールバック URL は必要ありません。

以下の接続プロパティを設定します。

• AccountName：Talkdesk アカウントの名前。
• Region：Talkdesk インスタンスがデプロイされているリージョン。指定できる値は US（デフォルト）、EU、CA、AU、UK、FedRamp です。
• OAuthClientId：カスタム OAuth アプリケーションの登録時に割り当てられた Client Id。
• OAuthClientSecret：カスタム OAuth アプリケーションに割り当てられた Client Secret。

カスタム OAuth アプリケーションの作成

1. Talkdesk アカウントにログインし、ナビゲーションメニューから OAuth Clients を選択します。
2. Create OAuth Client をクリックし、クライアントにわかりやすい名前を付けます。
3. Grant Type を Client Credentials に設定します。
4. Add scopes をクリックし、アクセスしたいデータに応じたスコープを選択します。
5. Create をクリックし、Client Id と Client Secret をコピーします。

接続時、ドライバーは Talkdesk にアクセストークンを自動でリクエストしてキャッシュし、有効期限が切れると更新します。アプリケーションで選択したスコープが、クエリ予定のビューに対応していることを確認してください。対応していない場合、トークンのリクエストが失敗することがあります。

さらに、OData SDK for PHP との互換性のためにAPI Server を構成します。「Settings」をクリックし、OData セクションで「デフォルトバージョン」を2.0 に設定します。

API Server に接続するユーザーの認証トークンを取得

作成するOData サービスを決定したら、「Users」をクリックして任意のユーザーをクリックし、ユーザーの認証トークンを取得します。API Server は、認証トークンベースの認証を使用して、主要な認証スキームをサポートします。SSL を使用すれば、接続の認証だけでなく、暗号化も可能です。IP アドレスを使用してアクセスを制限することも可能です。デフォルトでは、ローカルマシンからの接続のみが許可されます。

わかりやすくするために、URL に認証トークンを設定してAPI Server への認証を行います。これはデフォルトでは有効になっていないため、API Server の構成ファイルであるsettings.cfg に以下の行を追加する必要があります。

[Application]
AllowAuthTokenInUrl = true

settings.cfg ファイルはデータディレクトリに配置されています。.NET 版では、www の下のapp_data フォルダがデータディレクトリになっています。Java 版でのデータディレクトリの位置は、OS によって変わります。

• Windows：C:\ProgramData\CData\Talkdesk\
• Unix or Mac OS X：~/cdata/Talkdesk/

Talkdesk エンティティをPHP オブジェクトとして使用する

以下のステップに従ってOData PHP SDK を使用し、API Server によって公開されるWeb サービスに接続するプロキシクラスを作成します。

1. 以下のようなコマンドにURL を渡します。

   php C:\PHPLib\ODataphp\PHPDataSvcUtil.php /uri=https://your-server:8032/api.rsc/@your-authtoken/ /out=C:\PHPLib\ODataphp\TalkdeskEntities.php

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

   API Server とOData SDK for PHP は、フォーム認証とWindows 認証をサポートします。API Server は、認証トークンを使用してOData エンドポイントへのアクセスを許可されたユーザーを認証します。HTTP Basic 認証で認証トークを指定するか、OData URL に追加することができます。

   許可されたユーザーは、API Server の「Users」セクションで設定できます。

2. PHP のオブジェクト指向インターフェースを使用して、Talkdesk のデータへのアクセスを開始できます。以下のコードは、Users テーブルのレコードを作成し、リアルタイムデータを取得して、新しく作成されたレコードを表示します。

   
   require_once 'TalkdeskEntities.php';
   try{
     $svc = new CData();
     $users = new Users();
     $users->Active = 'true';
     $svc->AddToUsers($users);
     $svc->SetSaveChangesOptions(SaveChangesOptions::None);
     $svc->SaveChanges();
     $response = $svc->users()->Execute();
     foreach($response->Result as $users)
       echo $users->Id."
   ";
   } catch (Exception $e) {    //catch errors from the API Server
     echo $e->getError(), "\n";
   }