drewm/frontapp

超级简单、最小抽象的FrontApp API包装器

dev-master 2016-10-17 10:14 UTC

This package is auto-updated.

Last update: 2024-08-24 04:39:26 UTC


README

这是一个超级简单、最小抽象的Front API包装器,用PHP编写。

类似于我的MailChimp包装器,这可以让您直接从FrontApp API文档到代码。

需要PHP 5.4和curl。

安装

您可以使用Composer安装frontapp

composer require drewm/frontapp

然后您需要

  • 运行composer install以将依赖项添加到您的vendor目录
  • 使用以下行将自动加载器添加到您的应用程序:require("vendor/autoload.php")

示例

首先,使用use-ing类并创建一个包含您的API密钥的实例

use \DrewM\FrontApp\FrontApp;

$FrontApp = new FrontApp('abc123abc123abc123abc123abc123');

然后,列出您的所有邮箱(使用inboxes方法的get操作)

$result = $FrontApp->get('inboxes');

print_r($result);

创建一个邮箱(使用inboxes方法的post操作)

$result = $FrontApp->post("inboxes", [
				'name' => 'Support'
			]);

print_r($result);

使用patch更新操作更新频道成员的更多信息

$channel_id = 'cha_123';

$result = $FrontApp->patch("channels/$channel_id", [
				'settings' => [ 'webhook_url' => 'https://example.com/hook' ]
			]);

print_r($result);

使用delete方法删除联系人

$contact_id = 'ctc_123';

$FrontApp->delete("contacts/$contact_id");

使用success()方法快速测试操作是否成功

$result = $FrontApp->get('inboxes');

if ($FrontApp->success()) {
	print_r($result);	
} else {
	echo $FrontApp->getLastError();
}

故障排除

要获取HTTP客户端或API返回的最后一个错误,请使用getLastError()

echo $FrontApp->getLastError();

对于进一步的调试,您可以检查响应的头和体

print_r($FrontApp->getLastResponse());

如果您怀疑您发送的数据格式不正确,您可以查看包装器发送给FrontApp的内容

print_r($FrontApp->getLastRequest());