agykoala/slack

通过PHP对象访问您的Slack团队API

0.20.2 2018-04-24 08:19 UTC

README

通过PHP对象访问您的Slack团队API。

Build Status Coverage Status Quality Score Latest Version Total Downloads

文档

  • 入门 - 在使用此库之前,您需要生成一个令牌或设置OAuth。
  • 安装 - 关于通过composer或作为git子模块安装此库的信息。
  • 使用方法 - 一些简单的示例,说明如何使用此库访问Slack API。
  • API方法 - Slack的每个API方法和如何使用此库的Payload类访问它们的详细信息。
  • 事件 - 监听由ApiClient触发的事件的示例。

功能

  • 使用专用负载类访问Slack的所有API方法(请参阅使用文档
  • 负载和响应遵循官方文档中描述的相同定义(有一些例外,我认为这可以更好地区分)。
  • 您和Slack之间的数据使用JMS Serializer包进行序列化,允许使用完全指定的PHP对象与API交互。
  • 代码高度抽象,以支持在更具体的实现中重用(请参阅SlackBundle

进一步阅读

我已经尽最大努力在代码中包含适当的官方文档链接。

尽管如此,您最好亲自查阅API文档,以更好地了解每个API方法的确切功能和它将返回的数据。

如果您觉得这个包的某个部分需要更详细的文档,请不要犹豫,为其创建一个问题。

贡献

您对这个项目有一个好主意吗?找到了需要修复的严重错误?太好了!但是在提交PR之前,请确保它符合贡献指南,以加快您的代码合并速度。

缺失的方法

以下方法尚未实现,为什么不贡献并添加一些自己呢?

  • files.delete*
  • pins.add
  • pins.list
  • pins.remove
  • reactions.add
  • reactions.get
  • reactions.list
  • reactions.remove
  • team.accessLogs
  • team.info

* = 已为该方法打开问题/PR

相关包

  • Slack CLI - 用于所有Slack API方法的CLI应用程序。
  • SlackBundle - 提供与此库包集成的Symfony Bundle。

归属

  • Slack 团队,因为他们制作了一个出色的产品,并且API文档非常干净。

常见问题解答

为什么在尝试连接到 Slack API 时会收到 cURL 60 错误?

在底层,这个库使用 Guzzle 来连接到 Slack API,而 Guzzle 发送 HTTP 请求的默认方法是 cURL。

完整的错误代码是 CURLE_SSL_CACERT: Peer certificate cannot be authenticated with known CA certificates,尤其是在 Windows 或 OS X 上,可能是因为 Guzzle 在操作系统上找不到最新的 CA 证书包

要解决这个问题,您首先需要手动创建一个使用备用 CA 证书包的 Guzzle 客户端,或者 禁用 peer 验证(出于安全原因不推荐),然后将它传递给 API 客户端。

$client = new \GuzzleHttp\Client();
$client->setDefaultOption('verify', 'C:\Program Files (x86)\Git\bin\curl-ca-bundle.crt');

// continue as normal, using the client above

$apiClient =  new ApiClient('api-token-here', $client);

如果您收到不同的错误代码,您可以查看 cURL 错误代码列表,或者直接咨询 Guzzle 文档