semako / slack-api
通过PHP对象访问您的Slack团队API
0.20.1
2016-05-30 21:02 UTC
Requires
- php: >=5.5
- ext-curl: *
- doctrine/collections: ^1.2
- guzzlehttp/guzzle: ^6.0
- jms/serializer: ^1.0
- symfony/event-dispatcher: ^2.3|^3.0
- symfony/yaml: ^2.3|^3.0
Requires (Dev)
- mockery/mockery: ^0.9
- phpunit/phpunit: ^4.7
- symfony/var-dumper: ^2.3|^3.0
Suggests
- cleentfaar/slack-bundle: For easy integration with your Symfony projects
- cleentfaar/slack-cli: Command-line application for interacting with the Slack API
- dev-master
- 0.20.1
- 0.19.1
- 0.18.1
- 0.17.1
- 0.16.1
- 0.15.3
- 0.15.2
- 0.15.1
- 0.14.5
- 0.14.4
- 0.14.3
- 0.14.2
- 0.14.1
- 0.13.2
- 0.13.1
- 0.12.3
- 0.12.2
- 0.12.1
- 0.11.4
- 0.10.3
- 0.10.1
- 0.10.0
- 0.9.4
- 0.9.3
- 0.9.2
- 0.9.2b
- 0.9.1
- 0.2
- 0.1
- dev-fixed-bad-requirements
- dev-fixed-tests
- dev-team.info
- dev-patch-1
- dev-refactoring-round-4
- dev-refactoring-round-3
- dev-refact-pr-29
- dev-raupies-refactorings
This package is auto-updated.
Last update: 2024-09-07 22:21:30 UTC
README
通过PHP对象访问您的Slack团队API。
文档
- 入门 - 在使用此库之前,您需要生成一个令牌或设置oAuth。
- 安装 - 关于通过composer或作为git子模块安装此库的信息。
- 使用 - 一些使用此库访问Slack API的简单示例。
- API方法 - Slack的每个API方法及其使用此库的
Payload
类访问的详细说明。 - 事件 - 监听由
ApiClient
触发的事件的示例。
特性
- 使用专用的payload类访问Slack的所有API方法(请参阅使用文档)
- payload和响应遵循官方文档中描述的定义(有一些例外,我认为这将使区分更清晰)。
- 您和Slack之间的数据使用JMS Serializer包序列化,允许使用完全规范化的PHP对象与API交互。
- 代码已被高度抽象,以支持在更具体的实现中重用(请参阅SlackBundle)
进一步阅读
我已经尽最大努力在代码中包含适当的官方文档链接。
仍然,您最好查看Slack 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 客户端,或者禁用对等验证(出于安全原因不推荐),并将其传递给 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 文档。