快速上手

​

开始使用管理 Lists 端点组

本快速概览将帮助你使用 Postman 向管理 List 端点发出你的第一个请求。

如果你希望查看不同语言的示例代码，请访问我们的 X API v2 sample code GitHub 代码库。

**注意：**在此示例中，我们将调用“Create a List”端点，但你也可以将本快速入门中的做法应用到其他管理类请求。

先决条件

要完成本指南，你需要一组用于对请求进行认证的 keys and tokens。你可以按照以下步骤生成这些 keys 和 tokens：

• 注册开发者账户 并获得批准。
• 在开发者门户中创建一个 Project 并关联一个 developer App。
• 前往你的应用的“Keys and tokens”页面以生成所需的凭证。请确保将所有凭证保存在安全的位置。

​

构建管理 List 请求的步骤

步骤一：选择工具或库

有多种工具、代码示例和库可用于向此端点发起请求。为简化流程，我们在此使用 Postman。

要将 X API v2 的 Postman 集合加载到你的环境，请点击以下按钮：

将 X API v2 添加到 Postman

在 Postman 中加载 X API v2 集合后，进入“List”文件夹，选择其下的“Manage List”，然后选择 “Create a List”。

步骤二：为请求进行认证

要正确向 X API 发起请求，你需要确认自己具备相应权限。对于管理 Posts 的端点，你必须使用 OAuth 1.0a 用户上下文 或 OAuth 2.0 授权码（PKCE） 对请求进行认证。

本示例将使用 OAuth 1.0a 用户上下文。

你需要将 keys 和 tokens（具体包括 API Key、API Secret Key、OAuth 1.0a user Access Token，以及 OAuth 1.0a user Access Token Secret）添加到 Postman。方法是选择名为“X API v2”的环境（位于 Postman 右上角），并将你的 keys 和 tokens 分别填入 “initial value” 和 “current value” 字段（点击环境下拉旁的眼睛图标）。

如果设置正确，这些变量会自动填充到请求的 Authorization 选项卡中。   步骤三：为新的 List 指定名称

使用此端点创建新 List 时，List 的名称是必填的请求体参数。你还可以选择提供描述，并指定该 List 是否为私密。

在 Postman 中，转到“Body”选项卡，将 List 的名称作为 name 参数的值输入。此外，如需为 List 添加描述，只需以与 name 相同的方式添加名为 description 的新键，并将描述作为其值。将 List 设为私密遵循相同的模式，但此参数仅接受 true 或 false 值。 

Key	Value	Parameter type
name	列表名称（必填）	body
description	列表描述（可选）	body
private	true 或 false（可选）	body

现在你应当会在 “Send” 按钮旁看到一个类似的 URL：

https://api.x.com/2/lists

步骤四：发起请求并查看响应

一切就绪后，点击 “Send” 按钮，你将会收到与以下示例响应类似的结果：

{
  "data": {
    "id": "1441162269824405510",
    "name": "通过 Postman 创建的新列表"
  }
}

如果返回的响应对象包含一个 id 和你的 List 名称，则表示你已成功创建该 List。 

要删除一个 List，请在已加载到 Postman 的 X API v2 集合中，打开 “Lists” 文件夹并选择 “Delete a List” 请求。此端点需要你要删除的 List 的 ID。在 “Params” 选项卡中，将要删除的 List 的 ID 填入 id 列对应的值。 

删除请求成功后，你将收到类似以下示例的响应：

{
  "data": {
    "deleted": true
  }
}