跳转到主要内容

开始使用 Spaces 查询端点

本快速入门指南将帮助你使用 Postman 向某个 Spaces 查询端点发送首个请求,并指定一组 fields。 如果你想查看不同编程语言的示例代码,请访问我们的 X API v2 示例代码 GitHub 仓库。

先决条件

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

构建 Spaces 查询请求的步骤

在本示例中,我们将调用“按创建者 ID 查询用户 Spaces”的端点,但你也可以将本快速入门中的方法应用于其他查询请求。 步骤一:选择合适的工具或库 有多种工具、代码示例和库可用于调用此端点,这里我们使用 Postman 来简化流程。 要将 X API v2 的 Postman 集合加载到你的环境,请点击以下按钮: 将 X API v2 集合加载到 Postman 后,前往 Spaces 文件夹,找到“Lookup Spaces created by one or more users”请求。   步骤二:为请求进行认证 要正确调用 X API,你需要验证访问权限。此端点要求你使用 OAuth 2.0 App-OnlyOAuth 2.0 授权码(PKCE) 对请求进行认证。 为简化起见,我们在此请求中使用 OAuth 2.0 App-Only;但如果你需要请求私有metrics 或来自私密账户的 Spaces,则需使用其他认证方式之一。  使用 OAuth 2.0 App-Only 时,你必须将密钥和令牌(尤其是 App Access Token,亦称 App-only Bearer Token)添加到 Postman。你可以在 Postman 右上角选择名为“X API v2”的环境,然后将密钥和令牌添加到“initial value”和“current value”字段(点击环境下拉菜单旁的眼睛图标)。 若配置无误,这些变量会自动注入到请求的 Authorization 选项卡中。   步骤三:确定并指定要检索其 Posts 的用户 你必须在请求中指定要为其检索进行中或即将开始的 Spaces 的用户。本示例将传递单个用户 ID。 用户 ID 是表示账号 handle 的数值,你可以在账号的个人资料 URL 中找到。例如,以下账号的用户名为 XDevelopers。 https://x.com/XDevelopers 要将该用户名转换为用户 ID,你需要使用带用户名的用户查询端点,并在返回的 payload 中找到数值型用户 ID。对于 @XDevelopers,用户 ID 为 2244994945。 在 Postman 中,进入“Params”选项卡,将该用户 ID 输入到 id 参数的“Value”列。
KeyValue
id2244994945
步骤四:确定并指定要检索的 fields 如果在步骤三后点击“Send”按钮,你将收到一个 id,这是响应中默认返回的唯一 Space object 字段。 如需返回更多字段,需要在请求中通过 space.fields 或 expansions 参数进行指定。 在本练习中,我们将请求来自不同对象的三组额外字段:
  • 主 Spaces 对象中的附加 title 字段
  • 指定 creator ID 的完整 user object
  • 关联用户对象中的附加 user.created_at 字段
在 Postman 中,进入“Params”选项卡,在“Query Params”表中添加以下 key:value 对:
KeyValueReturned fields
space.fieldstitlecreator_id
expansionscreator_idincludes.users.id, includes.users.name, includes.users.username
user.fieldscreated_atincludes.users.created_at
此时你应当能在“Send”按钮旁看到以下 URL: https://api.x.com/2/spaces/by/creator_ids?user_ids=2244994945&space.fields=creator_id&expansions=creator_id&user.fields=created_at 步骤五:发送请求并查看响应 完成所有设置后,点击“Send”按钮,即可收到如下响应:
{
   "data": [
    {
        "creator_id": "2244994945",
        "id": "1zqKVXPQhvZJB",
        "title": "你好,世界 👋",
        "state": "运行中"
   },
   "includes": {
       "users": [
           {
               "created_at": "2013-12-14T04:35:55.000Z",
               "name": "Twitter Dev",
               "id": "2244994945",
               "username": "TwitterDev"
           }
       ]
   }
]
}