laahudra / twitch-api-php
PHP的Twitch API客户端。
v0.1.7
2017-08-27 05:49 UTC
Requires
- php: >=5.6.0
Requires (Dev)
- phpunit/phpunit: ^5.7
README
PHP的Twitch API客户端。
支持的API
此库旨在支持Twitch API的v3
、v4
和v5
版本,直到每个版本被弃用。如果没有指定API版本,则默认使用v5
。
已完成功能
主要API端点
- 认证
- Bits
- 频道动态
- 频道
- 聊天
- 剪辑
- 收藏夹
- 社区
- 游戏
- 摄取
- 搜索
- 直播流
- 团队
- 用户
- 视频
缺少任何端点?在此处提交问题。
其他功能
- IRC客户端
- 发布/订阅(例如Bits & Whispers)
- 视频上传
其他集成
- StreamsLabs
- 警报
- 认证
- 捐赠
- 用户
基本示例
$options = [ 'client_id' => 'YOUR-CLIENT-ID', ]; $twitchApi = new \TwitchApi\TwitchApi($options); $user = $twitchApi->getUser(26490481); // By default API responses are returned as an array, but if you want the raw JSON instead: $twitchApi->setReturnJson(true); $user = $twitchApi->getUser(26490481); // If you want to switch between API versions on the fly: $twitchApi->setApiVersion(3); $user = $twitchApi->getUser('summit1g');
有关更多常见用例,请参阅示例目录。
需求
需要PHP 5.6或更高版本。
安装
可以通过composer引入库
$ composer require nicklaw5/twitch-api-php
或者将以下依赖项添加到您的composer.json
文件中,并运行composer install
"nicklaw5/twitch-api-php": "0.1.*"
测试
可以使用以下命令运行所有单元测试
$ vendor/bin/phpunit # or simply "phpunit" if you have it installed globally
文档
Twitch API文档可以在这里找到。
至于此库的文档,它仍在待办事项列表中。在此期间,大多数现代IDE默认提供,或通过使用插件,将提供类属性和方法自动完成。或者,您可以简单地查看源代码。
许可证
在MIT许可证下分发。