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

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



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

API Server の設定

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

Salesforce Data 360 への接続

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

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

  5. それでは、Salesforce Data 360 への認証方法を設定していきましょう。Salesforce Data 360 では、OAuth 標準による認証をサポートしています。

    OAuth 認証

    AuthScheme をOAuth に設定してください。

    デスクトップアプリケーション

    CData 製品では、デスクトップでの認証を簡略化する埋め込みOAuth アプリケーションを提供しています。

    また、Salesforce Data 360 コンソールで設定および登録するカスタムOAuth アプリケーションを介してデスクトップから認証することも可能です。詳しくは、ヘルプドキュメントのカスタムOAuth アプリの作成をご確認ください。

    接続する前に、以下のプロパティを設定してください。

    • InitiateOAuth：GETANDREFRESH。InitiateOAuth を使用すれば、繰り返しOAuth の交換を行ったり、手動でOAuthAccessToken を設定する必要がなくなります
    • OAuthClientId（カスタムアプリケーションのみ）：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントID
    • OAuthClientSecret（カスタムアプリケーションのみ）：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット

    接続すると、CData 製品がデフォルトブラウザでSalesforce Data 360 のOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えてください。

    以下のようにドライバーがOAuth プロセスを完了します。

    • コールバックURL からアクセストークンを取得します
    • 古いトークンの期限が切れた際は、新しいアクセストークンを取得します
    • OAuthSettingsLocation にOAuth 値を保存し、接続間で永続化します

    Web アプリケーションやヘッドレスマシンを含むその他のOAuth 認証方法については、ヘルプドキュメントをご確認ください。

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

それでは、Salesforce Data 360 への認証方法を設定していきましょう。Salesforce Data 360 では、OAuth 標準による認証をサポートしています。

OAuth 認証

AuthScheme をOAuth に設定してください。

デスクトップアプリケーション

CData 製品では、デスクトップでの認証を簡略化する埋め込みOAuth アプリケーションを提供しています。

また、Salesforce Data 360 コンソールで設定および登録するカスタムOAuth アプリケーションを介してデスクトップから認証することも可能です。詳しくは、ヘルプドキュメントのカスタムOAuth アプリの作成をご確認ください。

接続する前に、以下のプロパティを設定してください。

  • InitiateOAuth：GETANDREFRESH。InitiateOAuth を使用すれば、繰り返しOAuth の交換を行ったり、手動でOAuthAccessToken を設定する必要がなくなります
  • OAuthClientId（カスタムアプリケーションのみ）：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントID
  • OAuthClientSecret（カスタムアプリケーションのみ）：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット

接続すると、CData 製品がデフォルトブラウザでSalesforce Data 360 のOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えてください。

以下のようにドライバーがOAuth プロセスを完了します。

  • コールバックURL からアクセストークンを取得します
  • 古いトークンの期限が切れた際は、新しいアクセストークンを取得します
  • OAuthSettingsLocation にOAuth 値を保存し、接続間で永続化します

Web アプリケーションやヘッドレスマシンを含むその他のOAuth 認証方法については、ヘルプドキュメントをご確認ください。

API Server のユーザー設定

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

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

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

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

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

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

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

それでは、Salesforce Data 360 への認証方法を設定していきましょう。Salesforce Data 360 では、OAuth 標準による認証をサポートしています。

OAuth 認証

AuthScheme をOAuth に設定してください。

デスクトップアプリケーション

CData 製品では、デスクトップでの認証を簡略化する埋め込みOAuth アプリケーションを提供しています。

また、Salesforce Data 360 コンソールで設定および登録するカスタムOAuth アプリケーションを介してデスクトップから認証することも可能です。詳しくは、ヘルプドキュメントのカスタムOAuth アプリの作成をご確認ください。

接続する前に、以下のプロパティを設定してください。

  • InitiateOAuth：GETANDREFRESH。InitiateOAuth を使用すれば、繰り返しOAuth の交換を行ったり、手動でOAuthAccessToken を設定する必要がなくなります
  • OAuthClientId（カスタムアプリケーションのみ）：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントID
  • OAuthClientSecret（カスタムアプリケーションのみ）：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット

接続すると、CData 製品がデフォルトブラウザでSalesforce Data 360 のOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えてください。

以下のようにドライバーがOAuth プロセスを完了します。

  • コールバックURL からアクセストークンを取得します
  • 古いトークンの期限が切れた際は、新しいアクセストークンを取得します
  • OAuthSettingsLocation にOAuth 値を保存し、接続間で永続化します

Web アプリケーションやヘッドレスマシンを含むその他のOAuth 認証方法については、ヘルプドキュメントをご確認ください。

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

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

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

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

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

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

    require_once 'SalesforceDataCloudEntities.php';
try{
  $svc = new CData();
  $account = new Account();
  $account->EmployeeCount = '250';
  $svc->AddToAccount($account);
  $svc->SetSaveChangesOptions(SaveChangesOptions::None);
  $svc->SaveChanges();
  $response = $svc->account()->Execute();
  foreach($response->Result as $account)
    echo $account->[Account ID]."";
} catch (Exception $e) {    //catch errors from the API Server
  echo $e->getError(), "\n";
}

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

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

CData API Server

この記事の内容

関連記事