跳转到主要内容

​
开始使用 manage Lists endpoint 组

本快速概览将帮助你使用 Postman 向 manage List endpoints 发送你的第一个请求。 如果你想查看不同语言的示例代码，请访问我们的 X API v2 sample code GitHub 代码库。 **注意：**在此示例中，我们将向 Create a List endpoint 发送请求，但你也可以将本快速上手中的方法应用到其他管理类请求。
先决条件要完成本指南，你需要一组用于为请求进行身份验证的密钥和令牌。你可以按照以下步骤生成这些密钥和令牌：
  • 注册开发者账户并获得批准。
  • 在开发者门户中创建一个 Project 以及关联的 开发者 App。
  • 前往你的 App 的“Keys and tokens”页面以生成所需凭据。请确保将所有凭据保存在安全位置。

​
构建管理 List 请求的步骤

步骤一：选择工具或库 有多种工具、代码示例和库可用于向此 endpoint 发起请求。为简化流程，我们将在此使用 Postman。 要将 X API v2 的 Postman 集合加载到你的环境中，请点击以下按钮：
加载 X API v2 集合到 Postman 后，导航至“List”文件夹，选择“Manage List”文件夹，然后选择 “Create a List”。 步骤二：为请求进行身份验证 要正确地向 X API 发起请求，你需要验证自己具有相应权限。对 manage Posts 的 endpoint，你必须使用 OAuth 1.0a User Context 或 OAuth 2.0 Authorization Code with PKCE 对请求进行身份验证。 在此示例中，我们将使用 OAuth 1.0a User Context。 你必须将你的密钥和令牌（具体包括 API Key、API Secret Key、OAuth 1.0a 用户 Access Token，以及 OAuth 1.0a 用户 Access Token Secret）添加到 Postman。你可以通过选择名为“X API v2”的环境（在 Postman 右上角），并将你的密钥和令牌添加到 “initial value” 和 “current value” 字段中（点击环境下拉菜单旁的“眼睛”图标）来完成。 如果配置正确，这些变量会自动填充到请求的 authorization 选项卡中。   步骤三：为新 List 指定名称 使用此 endpoint 创建新 List 时，List 的名称是必填的请求体参数。你也可以选择提供描述并指定该 List 是否为私有。 在 Postman 中，前往“Body”选项卡，将 List 的名称作为 name 参数的值输入。此外，如需为该 List 添加描述，只需以与 name 相同的方式添加一个名为 description 的新键，并将 List 的描述作为其值。将 List 设为私有遵循相同模式，但此参数仅接受 true 或 false 值。 
KeyValueParameter type
name列表名称（必填）body
description列表描述（可选）body
privatetrue 或 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”请求。此 endpoint 需要你要删除的 List 的 ID。在“Params”选项卡中，将要删除的 List 的 ID 填入 id 列的值。  当 delete 请求成功后，你将收到与以下示例类似的响应： 
{
  "data": {
    "deleted": true
  }
}
⌘I