README

Follow Up Boss 服务 PHP api 客户端库

安装

composer require webboy/fub-api-client

配置

使用 .env 文件存储配置常量

FUB_API_KEY - 您的 API 密钥。可以从 FollowUpBoss 控制台获取。

FUB_ORIGIN - 用于设置电子邮件活动（emCampaigns）的源字符串。

用法

您可以使用 4 种基本方法，它们取决于端点。4 种基本方法是

index($query_params)

GET 方法，将列出实体

show($id)

GET 方法，将检索单个实体的数据。需要提供 $id

create($data)

POST 方法，将使用在 $data 参数中提供的数据创建实体

update($id,$data)

PUT 方法，将使用在 $data 参数中提供的数据更新通过 $id 标识的实体

remove($id)

DELETE 方法，将删除通过 $id 标识的实体

示例 1

$client = new Webboy\FubApiClient\Endpoints\Events();
$query_params['limit'] = 15;
$response = $client->index($query_params);

以下代码将生成一个数组

array:15 [▼
  0 => array:13 [▼
    "id" => 1433
    "created" => "2017-09-06T15:29:37Z"
    "updated" => "2017-09-06T15:29:37Z"
    "personId" => 373
    "message" => ""
    "description" => ""
    "noteId" => null
    "source" => "<unspecified>"
    "type" => "Viewed Page"
    "pageTitle" => "Home Page"
    "pageUrl" => "http://ikstrim.net/dev/godzilla-polish-live/"
    "pageDuration" => 0
    "property" => null
  ]
  1 => array:13 [▶]
  2 => array:13 [▶]
  3 => array:13 [▶]
  4 => array:13 [▶]
  5 => array:13 [▶]
  6 => array:13 [▶]
  7 => array:13 [▶]
  8 => array:13 [▶]
  9 => array:13 [▶]
  10 => array:13 [▶]
  11 => array:13 [▶]
  12 => array:13 [▶]
  13 => array:13 [▶]
  14 => array:13 [▶]
]

webboy / fub-api-client

维护者

详细信息