README

SupportBee REST API的PHP包装器。

您可以在“设置 > API令牌”页面找到您的API令牌。更多信息请参阅https://developers.supportbee.com/api。

安装

在项目根目录下，运行以下命令

composer require amalfra/supportbee

这将创建一个vendor目录（如果您还没有），并设置自动加载类映射。

使用方法

安装完成后，您应该能够在代码中加载composer自动加载器。

您可以使用命名空间加载包装器类：

require __DIR__ . '/vendor/autoload.php';

use \Amalfra\SupportBee\Client as SupportBee;

现在创建一个新的对象

$supportbee = new SupportBee();

在此阶段，您还可以提供配置参数token, company，这些参数在整个API中使用。这些可以作为数组直接传递

$config = array(
	'token' => 'your token',
	'company' => 'your company name'
);

$supportbee = new SupportBee($config);

现在可以使用实例执行可用的API调用。所有API的结果都将返回为关联数组。如果返回的状态码不是200，则会抛出异常。

可用的API方法

有关可用参数的详细信息，请参阅https://developers.supportbee.com/api。

如果有多个参数：作为关联数组传递。所有方法名称均遵循驼峰命名法。

票据

tickets - 以最后活动顺序返回公司的15张票据。仅返回未存档的票据（请查看可选参数以获取存档票据）。
ticket - 通过id检索指定的票据。
searchTickets - 返回与搜索查询匹配的公司最后活动的15张票据。
createTicket - 为公司创建票据。将票据信息作为关联数组传递。
deleteTicket - 删除已删除的票据。只有管理员可以删除已删除的票据。
archiveTicket - 存档未存档的票据。
unarchiveTicket - 解存档已存档的票据。
assignTicket - 将票据分配给用户或组。第一个参数是票据id。第二个参数是一个关联数组，其中索引为user_id，如果要将票据分配给用户，则为group_id，如果要将票据分配给组。
starTicket - 为未加星标的票据加星。
unstarTicket - 为已加星标的票据取消加星。
spamTicket - 对未标记为垃圾邮件的票据标记为垃圾邮件。
unspamTicket - 取消标记为垃圾邮件的票据。
trashTicket - 将未删除的票据放入回收站。
untrashTicket - 从回收站中恢复已删除的票据。
addLabelToTicket - 向票据添加标签。您可以传递票据_id和标签名称作为参数。
removeLabelFromTicket - 从票据中删除标签。您可以传递票据_id和标签名称作为参数。

replies - 检索具有id ticket_id的票据的所有回复。
reply - 检索具有id ticket_id的票据指定的回复。

comments - 检索具有id ticket_id的票据的所有评论。
createComment - 向id为ticket_id的票据创建评论。将评论信息作为关联数组传递为第二个参数。

代理

agents - 检索公司的所有已确认代理。
agent - 通过id获取指定公司的代理。

组

groups - 获取公司的所有组。

片段

snippets - 返回公司的所有片段。

WebHooks

webhooks - 返回公司的所有WebHooks。

报告

avgFirstResponseTimeReport - 返回平均首次响应时间的数据点。
ticketsCountReport - 返回工单数量的数据点。
repliesCountReport - 返回回复数量的数据点。

电子邮件

emails - 返回公司的所有电子邮件。
createEmail - 为公司创建电子邮件。第二个参数以关联数组的形式传递电子邮件信息。

开发

有疑问、问题或建议吗？请在问题跟踪器上发布。

你可以通过分支项目并提交拉取请求来贡献更改。你可以通过运行vendor/bin/phpunit来确保测试通过。欢迎贡献 😍

UNDER MIT LICENSE

The MIT License (MIT)

在此特此免费授予任何获得本软件及其相关文档文件（以下简称"软件"）副本的人权，不受限制地处理软件，包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或出售软件副本的权利，并允许向软件提供的人这样做，前提是遵守以下条件

amalfra / supportbee

维护者

详细信息