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

加藤龍彦
加藤龍彦
デジタルマーケティング
CData Connect AI を使えば、OData を使ってCvent のデータにアクセスできます。CData Connect AI とOData PHP SDK を利用することで、Cvent のエンティティをPHP で取得して、オブジェクトとしてモデル化できます。

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

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

Connect AI を構成

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

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

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

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

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

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

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

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

Connect AI からCvent に接続

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

  1. Connect AI にログインし、 Add Connection をクリックします。 コネクションの追加
  2. 「Add Connection」パネルから「Cvent」を選択します。 データソースの選択
  3. 必要な認証プロパティを入力し、Cvent に接続します。

    Cvent への認証を行う前に、ワークスペースとOAuth アプリケーションを作成する必要があります。

    ワークスペースの作成

    ワークスペースを作成するには：

    1. Cvent にサインインし、App Switcher（ページ右上の青いボタン） -> Admin に移動します。
    2. Admin メニューから、Integrations -> REST API に移動します。
    3. Developer Management の新しいタブが立ち上がります。新しいタブでManage API Access をクリックします。
    4. Workspace を作成し、名前を付けます。開発者にアクセスさせたいスコープを選択します。スコープは、開発者がアクセスできるデータドメインを制御します。
      • All を選択すると、開発者は任意のスコープ、およびREST API にこれから追加されるスコープを選択できます。
      • Custom を選択すると、開発者がOAuth アプリで選択できるスコープを、選択したスコープに制限できます。CData 製品によって公開されるすべてのテーブルにアクセスするには、次のスコープを設定する必要があります。
        event/attendees:readevent/attendees:writeevent/contacts:read
        event/contacts:writeevent/custom-fields:readevent/custom-fields:write
        event/events:readevent/events:writeevent/sessions:delete
        event/sessions:readevent/sessions:writeevent/speakers:delete
        event/speakers:readevent/speakers:writebudget/budget-items:read
        budget/budget-items:writeexhibitor/exhibitors:readexhibitor/exhibitors:write
        survey/surveys:readsurvey/surveys:write

    OAuth アプリケーションの作成

    Workspace を設定して招待すると、開発者はサインアップしてカスタムOAuth アプリを作成できます。手順については、ヘルプドキュメントのカスタムOAuth アプリケーションの作成を参照してください。

    Cvent への接続

    OAuth アプリケーションを作成したら、次の接続プロパティを設定してCvent に接続します。

    • InitiateOAuth：GETANDREFRESH。OAuthAccessToken を自動的に取得およびリフレッシュするために使用します。
    • OAuthClientId：OAuth アプリケーションに関連付けられたClient ID。これは、Cvent Developer Portal のApplications page ページにあります。
    • OAuthClientSecret：OAuth アプリケーションに関連付けられたClient secret。これは、Cvent Developer Portal のApplications page ページにあります。
    接続の設定（Salesforce の表示）
  4. Create & Test をクリックします。
  5. 「Add Cvent Connection」ページの「Permissions」タブに移動し、ユーザーベースのアクセス許可を更新します。 権限を更新

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

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

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

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

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

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

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

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

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

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

はじめる準備はできましたか？

CData Connect AI の詳細、または無料トライアルにお申し込みください：

無料トライアル

この記事の内容

関連記事