跳转到主要内容

开始使用 Authenticated User Lookup 端点

本快速入门指南将帮助你使用 Postman 向 authenticated user lookup 端点发出第一个请求。 如果你想查看不同语言的示例代码,请访问我们的 X API v2 sample code GitHub 代码库。

前提条件

要完成本指南,你需要一组用于认证请求的密钥和令牌。你可以按照以下步骤生成这些密钥和令牌:
  • 注册开发者账户并通过审批。
  • 在开发者门户中创建一个项目以及关联的开发者应用
  • 前往你的应用的“Keys and tokens”页面生成所需的凭证。请务必将所有凭证保存在安全位置。

构建已授权用户查询请求的步骤

第一步:选择一个工具或库

有多种工具、代码示例和库可用于向该端点发起请求,但为简化流程,我们将在此使用 Postman。 要将 X API v2 的 Postman 集合导入到您的环境,请点击以下按钮: 在将 X API v2 集合导入 Postman 后,前往“Authenticated User Lookup”文件夹,并选择“Lookup an Authenticated User”。

步骤二:对请求进行认证

要正确向 X API 发起请求,你需要先确认自己具备相应权限。对于此端点,你必须使用 OAuth 1.0a 用户上下文OAuth 2.0 授权码(PKCE) 对请求进行认证。 在本示例中,我们将使用 OAuth 1.0a 用户上下文。 你需要将密钥和令牌——具体为 API Key、API Secret Key、OAuth 1.0a 用户 Access Token,以及 OAuth 1.0a 用户 Access Token Secret——添加到 Postman。你可以在 Postman 右上角选择名为“X API v2”的环境,然后将密钥和令牌添加到“initial value”和“current value”字段中(点击环境下拉菜单旁的眼睛图标)。 如果配置正确,这些变量会自动填充到该请求的 authorization 选项卡中。  
步骤三:确定要检索的用户字段
在完成步骤三后,如果点击“Send”按钮,响应中将返回默认的user object字段:id、name 和 username。 如果希望在 id、name 和 username 之外获取更多字段,需要在请求中通过field和/或expansion参数指定这些字段。 在本练习中,我们将从不同对象请求三组附加字段:
  1. 主用户对象中的附加 user.created_at 字段。
  2. 与返回用户关联的置顶 Post 对象的默认字段:id 和 text。
  3. 与其关联的 Post 对象中的附加 tweet.created_at 字段。
在 Postman 中,转到“Params”选项卡,并在“Query Params”表中添加以下键值对:
KeyValueReturned fields
user.fieldscreated_atuser.created_at
expansionspinned_tweet_idincludes.tweets.id,
includes.tweets.text
tweet.fieldscreated_at, author_idincludes.tweets.created_at, includes_tweets.author_id
现在,你应该会在“Send”按钮旁边看到一个类似的 URL:
      https://api.x.com/2/users/me?user.fields=created_at&expansions=pinned_tweet_id&tweet.fields=author_id,created_at