iamhappycoder / twitteroauth
支持Twitter REST API OAuth 1.0A的第一个PHP库。
Requires
- php: >=5.3.0
- ext-curl: *
Requires (Dev)
- phpunit/phpunit: 4.2.*
This package is not auto-updated.
Last update: 2024-09-20 20:26:26 UTC
README
用于处理Twitter OAuth API的PHP库。
流程概述
- 使用客户端凭据构建TwitterOAuth对象。
- 从Twitter请求临时凭据。
- 构建Twitter的授权URL。
- 将用户重定向到授权URL。
- 用户授权访问并从Twitter返回。
- 使用客户端凭据和临时凭据重新构建TwitterOAuth对象。
- 从Twitter获取令牌凭据。
- 使用客户端凭据和令牌凭据重新构建TwitterOAuth对象。
- 查询Twitter API。
术语
术语自0.1.x版本以来已更改,以更好地匹配draft-hammer-oauth IETF RFC。您可以在http://tools.ietf.org/html/draft-hammer-oauth上阅读它。一些术语将与Twitter使用的术语不同。
客户端凭据 - 您在注册Twitter应用程序时获得的消费者密钥/密钥。临时凭据 - 以前称为请求令牌。令牌凭据 - 以前称为访问令牌。
参数
在创建TwitterOAuth对象之后,您可以修改多个参数。
TwitterOAuth的最新版本支持Twitter API v1.1,但如果您想从v1.0更新旧安装,可以执行以下操作。
$connection->host = "https://api.twitter.com/1.1/";
自定义useragent。
$connection->useragent = 'Custom useragent string';
验证Twitter的SSL证书。
$connection->ssl_verifypeer = TRUE;
您还可以在TwitterOAuth.php中找到更多。
使用示例代码的扩展流程
要使用TwitterOAuth与Twitter API,您需要TwitterOAuth.php、OAuth.php和客户端凭据。您可以通过在dev.twitter.com/apps注册您的应用程序来获取客户端凭据。
用户从connect.php开始,该页面显示一个超链接到redirect.php的“用Twitter登录”图像。此按钮应显示在您的登录部分的主页上。客户端凭据保存在config.php中,作为CONSUMER_KEY
和CONSUMER_SECRET
。您可以在应用程序设置页面的配置文件中保存静态回调URL,或在步骤2中稍后使用动态回调URL。在示例中使用https://example.com/callback.php。
-
当用户到达redirect.php时,我们将使用客户端凭据构建一个新的TwitterOAuth对象。如果您有自己的配置方法,请随时使用它而不是config.php。
$connection = new TwitterOAuth(CONSUMER_KEY, CONSUMER_SECRET); // 使用config.php客户端凭据 $connection = new TwitterOAuth('abc890', '123xyz');
-
使用构建的$connection对象,您将请求Twitter的临时凭据。需要
oauth_callback
值。$temporary_credentials = $connection->getRequestToken(OAUTH_CALLBACK); // 使用config.php回调URL。
-
现在我们已经有了临时凭据,用户必须转到Twitter并授权应用程序访问和更新他们的数据。您还可以传递第二个参数FALSE,以不使用Sign in with Twitter。
$redirect_url = $connection->getAuthorizeURL($temporary_credentials); // 使用Sign in with Twitter $redirect_url = $connection->getAuthorizeURL($temporary_credentials, FALSE);
-
现在您将有一个必须发送用户去的Twitter URL。
https://api.twitter.com/oauth/authenticate?oauth_token=xyz123
-
现在用户在twitter.com,可能需要登录。一旦通过Twitter验证,他们可能必须点击允许/拒绝,或者将自动重定向回回调。
-
现在用户已返回到callback.php并允许访问,我们需要使用临时凭据创建一个新的TwitterOAuth对象。
$connection = new TwitterOAuth(CONSUMER_KEY, CONSUMER_SECRET, $_SESSION['oauth_token'], $_SESSION['oauth_token_secret']);
-
现在我们向Twitter请求长期有效的令牌凭据。这些凭据与特定应用程序和用户相关联,将作为密码用于未来的请求。通常,令牌凭据会保存在您的数据库中,但在此示例中,我们只是使用会话。
$token_credentials = $connection->getAccessToken($_REQUEST['oauth_verifier']);
-
使用令牌凭据,我们构建一个新的TwitterOAuth对象。
$connection = new TwitterOAuth(CONSUMER_KEY, CONSUMER_SECRET, $token_credentials['oauth_token'], $token_credentials['oauth_token_secret']);
-
最后,我们可以以用户身份进行请求。您可以GET、POST和DELETE API方法。直接从API文档复制路径,并添加任何您希望包含在API方法中的参数数组,例如curser或in_reply_to_status_id。
$account = $connection->get('account/verify_credentials'); $status = $connection->post('statuses/update', array('status' => '状态文本', 'in_reply_to_status_id' => 123456)); $status = $connection->delete('statuses/destroy/12345');
贡献者
- Abraham Williams - 主要开发者,当前维护者。