fabiosatyro / twitteroauth
Requires
- php: >=5.3.0
This package is not auto-updated.
Last update: 2024-09-23 13:57:37 UTC
README
PHP 库,用于处理 Twitter 的 OAuth API。
流程概述
- 使用客户端凭据构建 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/";
自定义用户代理。
$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 开始,该页面显示了“使用 Twitter 登录”的图像,该图像超链接到 redirect.php。此按钮应显示在您的登录部分的主页上。客户端凭据保存为 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 的 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 - 主要开发者,当前维护者。