waschick/salesforceiq

SalesforceIQ (RelateIQ) API v2 客户端,适用于 Laravel 及独立项目。从 torann/relateiq 分支而来。

此包的官方仓库似乎已不存在,因此该包已被冻结。

0.2.5 2017-03-15 23:02 UTC

This package is not auto-updated.

Last update: 2021-12-11 12:33:45 UTC


README

Latest Stable Version Total Downloads

关于

这将帮助您使用 PHP 访问 SalesforceIQ REST API。API 简单到几乎可以完全通过基本的 Curl 调用来完成您想做的事情... 几乎。但,有时一点 SDK 帮助会使事情更加愉快。有关文档,请在此处查看。

安装

"waschick/salesforceiq": "dev-master"

接下来,您需要运行 composer install 来下载它并更新自动加载器。

Laravel 设置

一旦 SalesforceIQ 客户端安装完成,您需要将服务提供者注册到应用程序中。打开 app/config/app.php 并找到 providers 键。

'SalesforceIQ\ServiceProvider'

无需添加 Facade,该包会为您添加。

将 SalesforceIQ 添加到 Services 配置

打开 app/config/services.php 并添加 salesforceiq

'salesforceiq' => array(
	'key'    => '66cfba7f741d645a488c0b21ebFAKE',
	'secret' => 'effd5216acac6314219ALSOFAKE',
),

SalesforceIQ 客户端实例

$riq = new SalesforceIQ('66cfba7f741d645a488c0b21ebFAKE', 'effd5216acac6314219ALSOFAKE');
$contact = $riq->getContact('741d645a488c0b21eb');

对于 Laravel,简单使用 SalesforceIQ Facade。

$contact = new SalesforceIQ::getContact('741d645a488c0b21eb');

方法

创建联系人 newContact(:properties)

一个 POST 请求,用于创建新的联系人对象,并返回带有新唯一 ID 的创建的联系人。

参数

  • :properties 由 SalesforceIQ 联系人对象组成的属性。以下属性通过 API 支持:
    • name
    • email (必需)
    • phone
    • address
    • company
    • title
    • twitter

示例

$contact = SalesforceIQ::newContact(array(
    'name'    => 'John Doe',
    'email'   => 'john.doe@mail.box',
    'phone'   => '555-4454',
    'address' => '22 Hill Ave',
    'company' => 'Box Maker, Inc.',
    'title'   => 'Lead Taper',
    'twitter' => '@John4Boxes'
));

获取单个联系人 getContact(:id)

一个 GET 请求,通过 ID、电子邮件或电话号码获取特定的联系人。

参数

  • :id 要获取的联系人的标识符。

示例

$contact = new SalesforceIQ::getContact('741d645a488c0b21eb');

获取所有联系人 getContacts()

一个 GET 请求,获取组织中的所有联系人的分页集合。

示例

$contacts = new SalesforceIQ::getContacts();

更新联系人

一个 PUT 请求,用于更新特定联系人的详细信息。

示例

$contact = new SalesforceIQ::getContact('741d645a488c0b21eb');
$contact->name = 'Sally Doe';
$contact->save();

变更日志

v0.1.0

  • 首次发布

版本 v.0.2.0

  • 从 Torann/RelateIQ 分支而来
  • 更新了版权信息
  • 更新了命名空间
  • 将端点URL更改为Salesforce域名

版本 v.0.2.1

  • 从类文件中移除了额外的命名空间层

版本 v.0.2.2

  • 从文件名和类名中移除了"Riq"前缀
  • 必须将"List"更改为"Collection",以避免使用PHP保留字

版本 v.0.2.3

  • 增强了列表项响应解析,通过结合原始数据与字段定义生成更友好的关联数组
  • 向客户端添加了GetAllListItems($listId)函数,以检索特定列表的全部内容

版本 v.0.2.4

  • 修复了检索列表项正确值的问题;Salesforce IQ提供了带有ID和显示值的列表项定义,然后引用ID值,但我们错误地使用数组索引进行转换。构建了一个具有正确值的参考数组。

版本 v.0.2.5

  • 添加了"User"作为资源类型,具有检索用户ID的名称和电子邮件的数组的能力。