chrishardie / crowdtangle-api
CrowdTangle API的最小化PHP实现
v1.0.1
2022-04-08 12:54 UTC
Requires
- php: ^8.0
- guzzlehttp/guzzle: ^6.2|^7.0
Requires (Dev)
- phpunit/phpunit: ^9.4
README
这是CrowdTangle API的一个最小化PHP实现。[链接](https://help.crowdtangle.com/en/articles/1189612-crowdtangle-api)包含了可用方法和参数的详细信息。我欢迎通过PR向客户端添加额外方法。
以下是一些如何使用此包的示例
$client = new ChrisHardie\CrowdtangleApi\Client($accessToken); // get lists $client->getLists(); // get accounts in a list $client->getAccountsForList($listId); // get posts $client->getPosts([ 'accounts' => '12345678', 'startDate' => '2022-03-01', ]); // get a single post $client->getPost($postId);
查看[完整CrowdTangle API文档](https://github.com/CrowdTangle/API/wiki)以获取有关可用参数和语法的详细信息。
安装
您可以通过composer安装此包
composer require chrishardie/crowdtangle-api
用法
以下是当前支持的API方法
getLists()
- 获取账户的列表、保存的搜索和保存的帖子列表getAccountsForList($listId, $parameters, $maxRecords)
- 获取给定列表的账户getPosts($parameters, $maxRecords)
- 根据给定参数获取一组帖子getPost($postId)
- 获取特定帖子
在大多数情况下,库只是将所需的参数传递给CrowdTangle API。
对于支持分页的方法(目前为getAccountsForList()
和getPosts()
),默认情况下,此库将尝试每次检索所有页面上的所有记录,每次最多100条,最多1000条。您可以通过为$maxRecords
传递一个较低的值来更改此设置。请注意,CrowdTangle API的节流限制可能适用。
测试
composer test
变更日志
有关最近更改的更多信息,请参阅变更日志。
鸣谢
受Spatie的Dropbox API的启发和结构。
许可
MIT许可(MIT)。有关更多信息,请参阅许可文件。