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

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

API Server の設定

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

Salesforce Pardot への接続

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

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

5. Salesforce Pardot はUsername、Password、およびUser Key を指定して接続します。

   • ApiVersion: 提供されたアカウントがアクセス可能なSalesforcePardot API バージョン。 デフォルトは4です。
   • User: Salesforce Pardot アカウントのユーザー名。
   • Password: Salesforce Pardot アカウントのパスワード。
   • UserKey: SalesforcePardot アカウントの一意のユーザーキー。このキーは永久的に利用できます。
   • IsDemoAccount (optional): でもアカウントの場合は、TRUE に設定。

   Pardot User Key へのアクセス

   現在のアカウントのUser Key にアクセスするには、「設定」->「My Profile」の「API User Key」行にアクセスします。

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

Salesforce Pardot はUsername、Password、およびUser Key を指定して接続します。

• ApiVersion: 提供されたアカウントがアクセス可能なSalesforcePardot API バージョン。 デフォルトは4です。
• User: Salesforce Pardot アカウントのユーザー名。
• Password: Salesforce Pardot アカウントのパスワード。
• UserKey: SalesforcePardot アカウントの一意のユーザーキー。このキーは永久的に利用できます。
• IsDemoAccount (optional): でもアカウントの場合は、TRUE に設定。

Pardot User Key へのアクセス

現在のアカウントのUser Key にアクセスするには、「設定」->「My Profile」の「API User Key」行にアクセスします。

API Server のユーザー設定

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

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

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

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

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

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

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

Salesforce Pardot はUsername、Password、およびUser Key を指定して接続します。

• ApiVersion: 提供されたアカウントがアクセス可能なSalesforcePardot API バージョン。 デフォルトは4です。
• User: Salesforce Pardot アカウントのユーザー名。
• Password: Salesforce Pardot アカウントのパスワード。
• UserKey: SalesforcePardot アカウントの一意のユーザーキー。このキーは永久的に利用できます。
• IsDemoAccount (optional): でもアカウントの場合は、TRUE に設定。

Pardot User Key へのアクセス

現在のアカウントのUser Key にアクセスするには、「設定」->「My Profile」の「API User Key」行にアクセスします。

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

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

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

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

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

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

   require_once 'SalesforcePardotEntities.php';
   try{
     $svc = new CData();
     $prospects = new Prospects();
     $prospects->ProspectAccountId = '703';
     $svc->AddToProspects($prospects);
     $svc->SetSaveChangesOptions(SaveChangesOptions::None);
     $svc->SaveChanges();
     $response = $svc->prospects()->Execute();
     foreach($response->Result as $prospects)
       echo $prospects->Id."";
   } catch (Exception $e) {    //catch errors from the API Server
     echo $e->getError(), "\n";
   }