跳转到主要内容

​
开始使用 List 查找端点

本快速入门指南将帮助你使用 Postman 向 List 查找端点发出第一个请求。 如果你想查看不同语言的示例代码，请访问我们的 X API v2 示例代码 GitHub 代码库。 **注意：**在此示例中，我们将调用 List lookup by ID 端点，但你也可以将本快速入门中的做法应用到其他查找请求。

​
先决条件

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

​
构建 List 查找请求的步骤

步骤一：选择工具或库 有多种工具、代码示例和库可用于向此端点发起请求，但这里我们将使用 Postman 来简化流程。 要将 X API v2 的 Postman 集合加载到你的环境中，请点击以下按钮：
在 Postman 中加载 X API v2 集合后，导航到“List”文件夹，选择“List lookup”文件夹，然后选择“List by ID”。   步骤二：为请求进行认证 要正确地向 X API 发起请求，你需要确认自己具备相应权限。对于此端点，必须使用 App only、OAuth 2.0 授权码（PKCE） 或 OAuth 1.0a 用户上下文 来对请求进行认证。 为简化流程，我们在此请求中使用 App only；但如果你想请求私有metrics 或私有 Lists，则需要使用上述其他认证方式之一。  使用 App only 时，你需要将密钥和令牌（尤其是 App only Access Token）添加到 Postman：选择名为“X API v2”的环境（位于 Postman 右上角），并将你的密钥和令牌填入“initial value”和“current value”字段（点击环境下拉菜单旁的“眼睛”图标）。 如果设置正确，这些变量会自动带入请求的 authorization 选项卡。   步骤三：确定并指定要检索的 List 你必须在请求中指定希望检索的 List。你可以在 x.com 上点击某个 List，然后查看其 URL 来找到该 List 的 ID。例如，以下 URL 的 List ID 是 84839422。 https://x.com/i/lists/84839422 目标 ID 可以是任何有效的 List ID。在 Postman 中，前往“Params”选项卡，将你的 ID 输入到路径变量 id 的“Value”列中。确保不要在任何 ID 的前后包含空格。
KeyValue
id84839422（List ID）
步骤四：确定并指定要检索的 fields 如果你在步骤三之后点击“Send”，响应中会返回默认的 List object 字段：id、name。 如果你希望获取更多字段，需要在请求中通过 list.fields 和/或 expansions 参数进行指定。 在本练习中，我们将从不同对象请求三组额外字段：
  • 在主 Lists 对象中添加 created_at 字段。
  • 使用 expansions 参数请求完整的 user object
  • 在关联的 user 对象中添加 user.created_at 字段。
在 Postman 中，前往“Params”选项卡，在“Query Params”表中添加以下键值对：
KeyValueReturned fields
list.fieldscreated_atcreated_at
expansionsowner_idincludes.users.id,
includes.users.name,
includes.users.username
user.fieldscreated_atincludes.users.created_at
此时你应在“Send”按钮旁看到类似的 URL： https://api.x.com/2/lists/84839422?list.fields=owner_id&expansions=owner_id&user.fields=created_at 步骤五：发送请求并查看响应 完成所有设置后，点击“Send”按钮，你将收到与以下示例相近的响应： 
{
  "data": {
    "id": "84839422",
    "name": "官方Twitter账户",
    "owner_id": "783214"
  },
  "includes": {
    "users": [
      {
        "name": "Twitter",
        "created_at": "2007-02-20T14:35:54.000Z",
        "username": "Twitter",
        "id": "783214"
      }
    ]
  }
}