跳转到主要内容

​
开始使用 Spaces 查询 endpoint

本快速上手指南将帮助你使用 Postman，向某个 Spaces 查询 endpoint 发出包含指定 fields 的首个请求。 如果你希望查看不同编程语言的示例代码，请访问我们的 X API v2 sample code GitHub 仓库。

​
先决条件

要完成本指南，你需要一组用于对请求进行身份验证的密钥和令牌。你可以按照以下步骤生成这些密钥和令牌：
  • 注册开发者账户并获得批准。
  • 在开发者门户中创建一个Project以及关联的developer App。
  • 前往你的 App 的“Keys and tokens”页面生成所需的凭证。请确保将所有凭证保存在安全位置。

​
构建 Spaces 查询请求的步骤

在本示例中，我们将调用按创建者 ID 的用户 Spaces 查询 endpoint，但你也可以将本快速上手中的做法应用到其他查询请求。 步骤一：选择工具或库 你可以使用多种工具、代码示例和库来调用此 endpoint，这里我们使用 Postman 以简化流程。 要将 X API v2 的 Postman 集合加载到你的环境，请点击以下按钮：
在将 X API v2 集合加载到 Postman 后，前往 Spaces 文件夹，找到“Lookup Spaces created by one or more users”请求。   步骤二：为请求进行身份验证 要正确调用 X API，你需要确认自己具备相应权限。为此，此 endpoint 要求你使用 OAuth 2.0 App-Only 或 OAuth 2.0 Authorization Code with PKCE 进行身份验证。 为简单起见，我们在此请求中使用 OAuth 2.0 App-Only。但如果你想请求私有度量或私密用户的 Spaces，则需要使用其他身份验证方式之一。  要使用 OAuth 2.0 App-Only，你必须将密钥和令牌（特别是 App Access Token，也称 App-only Bearer Token）添加到 Postman。你可以在 Postman 右上角选择名为“X API v2”的环境，并将密钥和令牌分别填入“initial value”和“current value”字段（点击环境下拉菜单旁的眼睛图标）完成此操作。 如配置正确，这些变量会自动填充到请求的 authorization 选项卡中。   步骤三：确定并指定要检索其 Post 的用户 你必须在请求中指定要为其检索正在进行或即将开始的 Spaces 的用户。在本示例中，我们传入单个用户 ID。 用户 ID 是表示账号句柄的数值，你可以在账号的个人资料 URL 中找到相关信息。例如，以下账号的用户名是 XDevelopers。 https://x.com/XDevelopers 要将该用户名转换为用户 ID，你需要使用带用户名的用户查询 endpoint，并在响应负载中找到数值型用户 ID。对于 @XDevelopers，用户 ID 为 2244994945。 在 Postman 中，进入“Params”选项卡，将该用户 ID 输入到 id 参数的“Value”列中。
KeyValue
id2244994945
步骤四：确定并指定要检索的 fields 如果你在步骤三之后点击“Send”按钮，你将收到一个 id，这是响应中默认返回的唯一 Space object 字段。 如果希望获取更多字段，你需要在请求中通过 space.fields 或 expansions 参数进行指定。 在本练习中，我们将从不同对象请求三组附加字段：
  • 主 Spaces 对象中的附加 title 字段。
  • 指定 creator ID 对应的完整用户对象
  • 关联用户对象中的附加 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": "Running"
   },
   "includes": {
       "users": [
           {
               "created_at": "2013-12-14T04:35:55.000Z",
               "name": "Twitter Dev",
               "id": "2244994945",
               "username": "TwitterDev"
           }
       ]
   }
]
}
⌘I