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

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

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

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

Connect AI を構成

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

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

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

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

  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 からAct CRM に接続

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

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

    Authentication セクションのUser とPassword プロパティに、有効なAct! ユーザー資格情報を設定する必要があります。認証値に加えて、以下も参照してください。

    • Act! Premium への接続

      認証値に加えて、Act! へのURL も設定が必要です。例：https://eup1-iis-04.eu.hosted.act.com/。

      さらに、接続するActDatabase を指定する必要があります。これは、ご自分のアカウントの「About Act! Premium」メニューのページ右上にある「?」で確認することができます。表示されたウィンドウの「Database Name」を使用します。

    • Act! Premium Cloud への接続

      Act! Premium Cloud アカウントに接続するには、ActCloudName プロパティも指定する必要があります。このプロパティはCloud アカウントのURL アドレスで確認できます。例：https://eup1-iis-04.eu.hosted.act.com/ActCloudName/。

    ActCRM メタデータの取得は高負荷になる可能性があることに注意してください。CacheMetadata プロパティを設定して、メタデータをローカルに格納することをお勧めします。

    接続の設定（Salesforce の表示）
  4. Create & Test をクリックします。
  5. 「Add Act CRM Connection」ページの「Permissions」タブに移動し、ユーザーベースのアクセス許可を更新します。 権限を更新

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

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

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

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

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

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

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

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

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

    require_once 'ActCRMEntities.php';
try{
  $svc = new CDataAPI();
  $activities = new Activities();
  $activities->Subject = 'Sample subject';
  $svc->AddToActivities($activities);
  $svc->SetSaveChangesOptions(SaveChangesOptions::None);
  $svc->SaveChanges();
  $response = $svc->activities()->Execute();
  foreach($response->Result as $activities)
    echo $activities->ActivityDisplayName."";
} catch (Exception $e) {    //CData Connect AI からのエラーをキャッチ
  echo $e->getError(), "\n";
}

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

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

無料トライアル お問い合わせ

この記事の内容

関連記事