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

加藤龍彦
加藤龍彦
デジタルマーケティング
API Server とOData PHP SDK を使用して、エンティティをオブジェクトとしてモデリングすることでPHP でCvent エンティティを手軽に使用。



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

API Server の設定

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

Cvent への接続

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

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

  5. 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 ページにあります。
  6. 接続情報の入力が完了したら、「保存およびテスト」をクリックします。

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 ページにあります。

API Server のユーザー設定

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

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

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

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

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

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

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

API エンドポイント

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 ページにあります。

さらに、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\Cvent\
  • Unix or Mac OS X：~/cdata/Cvent/

Cvent エンティティを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\CventEntities.php

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

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

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

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

    require_once 'CventEntities.php';
try{
  $svc = new CData();
  $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) {    //catch errors from the API Server
  echo $e->getError(), "\n";
}

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

詳細はこちら、または無料トライアルにお申し込みください：

CData API Server

この記事の内容

関連記事