README

与Pardot API交互的PHP包

作者: Andrew Mc Cormack

Pardot API PHP库

通过PHP对象集成Pardot API的库

该库简化了认证和查询Pardot API的过程，并提供了对所有v4 API功能的访问。

最新版本2.0.0支持Salesforce SSO认证。

设置

要初始化Pardot API对象，请传递您的用户电子邮件、密码、客户端ID、客户端密钥和业务单元ID凭据。任何后续请求API以获取数据都会在尝试获取数据之前自动执行认证操作。

use CyberDuck\Pardot\PardotApi;

$pardot = new PardotApi(
    'EMAIL',
    'PASSWORD',
    'CLIENT_ID',
    'CLIENT_SECRET',
    'BUSINESS_UNIT_ID',
);

查询API

您可以在任何Pardot对象上调用查询方法，传递对象、运算符和数据数组（可选）

$result = $pardot->request('campaign', 'read/id/1');

$result = $pardot->request('campaign', 'query', ['created_after' => 'today']);

对象方法

PardotApi实例具有与Pardot中的对象类型相对应的函数，以简化对API的调用。调用这些函数之一时，会返回一个查询对象（->campaigns()返回一个CampaignsQuery对象）。这些返回的对象反过来具有对应于不同对象操作（如查询、创建、更新、插入、删除等）的函数。以下是可以用的对象列表：

账户方法

$pardot->account()->read(); // retrieves current account information

活动方法

$pardot->campaign()->query([...]); // queries and returns a filtered list
$pardot->campaign()->create([...]); // creates an object using passed array data
$pardot->campaign()->read(1); // queries an object by ID
$pardot->campaign()->update(1, [...]); // updates an object by ID using passed array data 

自定义字段方法

$pardot->customField()->query([...]); // queries and returns a filtered list
$pardot->customField()->create([...]); // creates an object using passed array data
$pardot->customField()->read(1); // queries an object by ID
$pardot->customField()->update(1, [...]); // updates an object by ID using passed array data 
$pardot->customField()->delete(1); // deletes an object by ID

自定义重定向方法

$pardot->customRedirect()->query([...]); // queries and returns a filtered list
$pardot->customRedirect()->read(1); // queries an object by ID

动态内容方法

$pardot->dynamicContent()->query([...]); // queries and returns a filtered list
$pardot->dynamicContent()->read(1); // queries an object by ID

电子邮件点击方法

$pardot->emailClick()->query([...]); // queries and returns a filtered list

电子邮件方法

$pardot->email()->read(1); // queries an object by ID
$pardot->email()->stats(1); // Returns the statistical data for the list email 
$pardot->email()->sendToID(1, [...]); // Sends a 1 to 1 email to an ID using an array of email config / data
$pardot->email()->sendToEmail('name@example.com', [...]); // Sends a 1 to 1 email to a email address an array of email config / data
$pardot->email()->send([...]); // send an email to a list of IDs

电子邮件模板方法

$pardot->emailTemplate()->listOneToOne(); // Returns a list of email templates used in 1 to 1 emails

表单方法

$pardot->form()->query([...]); // queries and returns a filtered list
$pardot->form()->read(1); // queries an object by ID

生命周期历史方法

$pardot->lifecycleHistory()->query([...]); // queries and returns a filtered list
$pardot->lifecycleHistory()->read(1); // queries an object by ID

生命周期阶段方法

$pardot->lifecycleStage()->query([...]); // queries and returns a filtered list

列表成员资格方法

// @todo

列表方法

// @todo

机会方法

// @todo

潜在客户账户方法

// @todo

潜在客户方法

$pardot->prospect()->query([...]); // queries and returns a filtered list
$pardot->prospect()->read(1); // queries an object by ID

标签对象方法

$pardot->tagObject()->query([...]); // queries and returns a filtered list
$pardot->tagObject()->read(1); // queries an object by ID

标签方法

$pardot->tag()->query([...]); // queries and returns a filtered list
$pardot->tag()->read(1); // queries an object by ID

用户方法

$pardot->user()->query([...]); // queries and returns a filtered list
$pardot->user()->read(1); // queries an object by ID
$pardot->user()->readByEmail('name@example.com'); // queries an object by email

访客活动方法

// @todo

访客方法

$pardot->visitor()->query([...]); // queries and returns a filtered list
$pardot->visitor()->read(1); // queries an object by ID
$pardot->visitor()->assign(1,2); // Assigns or reassigns the visitor by ID to a prospect ID.

访问方法

$pardot->visit()->query([...]); // queries and returns a filtered list
$pardot->visit()->read(1); // queries an object by ID

调试

可以通过开启调试来启用错误消息。默认情况下，对Pardot API的请求会静默失败，以防止致命的应用程序错误。在实现此库时应进行额外的响应检查，因为大多数方法在API查询有问题时将返回null。

$pardot->setDebug(true);

输出类型

您可以更改输出类型为完整、简单、移动或批量。默认为完整。

$pardot->setOuput('full');