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

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



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

Salesforce データ連携について

CData を使用すれば、Salesforce のライブデータへのアクセスと統合がこれまでになく簡単になります。お客様は CData の接続機能を以下の目的で利用しています：

  • カスタムエンティティやフィールドにアクセスでき、Salesforce ユーザーは Salesforce のすべてにアクセスできます。
  • アトミックおよびバッチ更新操作を作成できます。
  • Salesforce データの読み取り、書き込み、更新、削除ができます。
  • SOAP API バージョン 30.0 のサポートにより、最新の Salesforce 機能を活用できます。
  • SOQL サポートによる複雑なクエリの Salesforce サーバーへのプッシュダウンにより、パフォーマンスの向上を実現できます。
  • SQL ストアドプロシージャを使用して、ジョブの作成・取得・中止・削除、添付ファイルやドキュメントのアップロード・ダウンロードなどのアクションを実行できます。

ユーザーは、Salesforce データを以下と頻繁に統合しています：

  • 他の ERP、マーケティングオートメーション、HCM など。
  • Power BI、Tableau、Looker などのお気に入りのデータツール。
  • データベースやデータウェアハウス。

CData ソリューションが Salesforce とどのように連携するかについての詳細は、Salesforce 統合ページをご覧ください。


はじめに


API Server の設定

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

Salesforce への接続

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

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

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

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

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

    標準認証の設定

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

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

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

    OAuth 認証の設定

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

    SSO（シングルサインオン）の設定

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

    • SSOProperties
    • SSOLoginUrl
    • TokenUrl

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

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

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

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

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

標準認証の設定

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

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

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

OAuth 認証の設定

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

SSO（シングルサインオン）の設定

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

  • SSOProperties
  • SSOLoginUrl
  • TokenUrl

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

API Server のユーザー設定

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

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

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

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

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

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

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

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

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

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

標準認証の設定

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

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

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

OAuth 認証の設定

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

SSO（シングルサインオン）の設定

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

  • SSOProperties
  • SSOLoginUrl
  • TokenUrl

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

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

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

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

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

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

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

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

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

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

CData API Server お問い合わせ

この記事の内容

関連記事