README

安装

• RelateIQ 客户端在Packagist上的位置
• RelateIQ 客户端在GitHub上的位置

要获取RelateIQ客户端的最新版本，只需在composer.json文件中添加它。

"torann/relateiq": "dev-master"

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

Laravel 设置

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

'Torann\RelateIQ\ServiceProvider'

无需添加外观，该包会为您添加。

将RelateIQ添加到服务配置

打开app/config/services.php并添加relateiq。

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

RelateIQ 客户端实例

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

对于Laravel，简单地使用外观RelateIQ。

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

方法

创建联系人 newContact(:properties)

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

参数

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

示例

$contact = RelateIQ::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 RelateIQ::getContact('741d645a488c0b21eb');

获取所有联系人 getContacts()

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

示例

$contacts = new RelateIQ::getContacts();

更新联系人

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

示例

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

变更日志

v0.1.0

• 首次发布