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

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

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

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

Connect AI を構成

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

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

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

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

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

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

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

    Salesforce 接続プロパティの設定方法

    埋め込みOAuth(UI でのログイン)による接続設定

    それでは、Salesforce への接続について説明していきましょう。最も簡単な方法として、Salesforce にログインする際と同様にUI 上からログインするだけで接続設定が完了します(埋め込みOAuth)。この方法をご利用になる場合は、「Salesforce への接続」をクリックしてください。

    標準認証の設定

    埋め込みOAuth 以外の方法を利用する場合、以下の3つの認証方式をご利用いただけます。標準的な認証方式では、以下の情報が必要となります。

    • ユーザー名
    • パスワード
    • セキュリティトークン

    セキュリティトークンの取得方法については、セキュリティトークン取得手順をご確認ください。

    OAuth 認証の設定

    ユーザー名とパスワードによる認証がご利用いただけない(避けたい)場合は、OAuth 認証をお使いいただけます。

    SSO(シングルサインオン)の設定

    最後に、IDプロバイダー経由でのシングルサインオンをご利用になる場合は、以下のプロパティを設定してください。

    • SSOProperties
    • SSOLoginUrl
    • TokenUrl

    より詳細な設定手順については、ヘルプドキュメントの「はじめに」セクションをご確認ください。

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

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

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

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

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

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

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

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

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

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

    require_once 'SalesforceEntities.php';
    try{
      $svc = new CDataAPI();
      $account = new Account();
      $account->Name = 'GenePoint';
      $svc->AddToAccount($account);
      $svc->SetSaveChangesOptions(SaveChangesOptions::None);
      $svc->SaveChanges();
      $response = $svc->account()->Execute();
      foreach($response->Result as $account)
        echo $account->Industry."";
    } catch (Exception $e) {    //CData Connect AI からのエラーをキャッチ
      echo $e->getError(), "\n";
    }
    

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

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

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