Postman 入门

本教程将介绍什么是 Postman，以及如何快速完成设置。

​

简介

Postman 是一款桌面端与网页版应用，可通过图形化界面向 API 发起请求。我们建议在探索 X API、X Ads API 与 Labs 端点的功能时，以及排查应用问题时使用 Postman。 

我们目前提供两套 Postman 集合：

X API v2 集合

X Ads API 集合

​

先决条件

在开始使用 X 的 Postman 集合之前，您需要确保已为所选的 X 开发者平台工具准备好相应的访问权限和凭据。您可以在我们的“入门”页面或“入门”页面（中文）了解如何获取访问权限的更多信息。

当您已拥有开发者账户、完成开发者应用或开发者应用（中文）的设置，并取得一组认证或认证（中文）密钥和令牌，且已正确配置环境以便向计划使用的特定 API 发起请求后，即可按照以下步骤开始。  

​

X 的 Postman 集合入门

​

第一步：将一个 X 的 Postman 集合添加到你的账号

虽然你可以在 Postman 中自行构建所需的特定端点，但我们已替你完成繁重工作，提供了一套可直接使用的相关 API 集合。只需点击前文“Postman collections”部分的任意链接，所选 API 对应的全部端点集合就会添加到你的 Postman 应用中。这些集合也可在 Postman API network 获取。每个端点都会自动包含可用参数、示例响应以及预设的认证方式，因此你只需添加凭证和参数值即可开始探索相关功能。

在此示例中，我们将使用 X 的 API v2 collection。   

​

步骤二：将你的密钥和令牌添加为环境变量

当你将集合添加到你的 Postman 实例时，它会自动添加一个名为“X API v2”的环境，你需要将你的密钥和令牌添加到其中。在此步骤中，我们将引导你把开发者应用（App）的密钥和令牌添加到“X API v2”环境中。

要将你的密钥和令牌添加到“X API v2”环境，请点击 Postman 右上角的“manage environments”按钮，或点击右上角的设置按钮。

在环境列表中，点击“X API v2”。

接下来，将你通过 Apps 仪表板生成的各类密钥和令牌以变量的形式添加到表格中。以下是表格应有的示例：

VARIABLE	INITIAL VALUE	CURRENT VALUE
consumer_key	QAktM6W6DF6F7XXXXXX	QAktM6W6DF6F7XXXXXX
consumer_secret	AJX560A2Omgwyjr6Mml2esedujnZLHXXXXXX	AJX560A2Omgwyjr6Mml2esedujnZLHXXXXXX
access_token	1995XXXXX-0NGqVhk3s96IX6SgT3H2bbjOPjcyQXXXXXXX	1995XXXXX-0NGqVhk3s96IX6SgT3H2bbjOPjcyQXXXXXXX
token_secret	rHVuh7dgDuJCOGeoe4tndtjKwWiDjBZHLaZXXXXXX	rHVuh7dgDuJCOGeoe4tndtjKwWiDjBZHLaZXXXXXX
bearer_token	AAAAAAAAAAAAAAAAAAAAAL9v6AAAAAAA99t03huuqRYg0mpYAAFRbPR3XXXXXXX	AAAAAAAAAAAAAAAAAAAAAL9v6AAAAAAA99t03huuqRYg0mpYAAFRbPR3XXXXXXX

请注意，上表中的密钥和令牌均为示例，不能用于实际请求。

当你将凭证添加为变量并确保已选中 X API v2 环境后，即可向 X API v2 集合发出请求。因为各端点的授权选项卡已配置为自动继承该环境中的变量。

如需在 Postman 中使用用户访问令牌，请跳转至 XXXX 查看更多操作细节。

​

第三步：选择端点 

接下来，从集合中选择一个端点并开始构建请求。你可以在右侧导航中选择端点。如下所示：

在本示例中，我们将使用 X API v2 > Post Lookup > Single Post 端点。 

​

第四步：在 Params 选项卡中添加值

接下来前往 Params 选项卡。你会看到一组未激活的参数，带有说明各参数用途的描述，以及可在请求中传递的所有潜在取值列表。

在此示例中，我们将启用 expansions 和 tweet.fields 查询参数，并添加以下值：

Key	Value
tweet.fields	created_at,attachments
expansions	author_id

除添加查询参数外，我们还需要添加必填的路径变量 id。由于此端点返回 Post，我们需要添加一个有效的 Post ID 作为其值。

你可以通过访问 x.com，点击某条 Post，然后在 URL 中查找该 Post 的 ID。例如，以下 URL 的 Post ID 是 1228393702244134912：

https://x.com/XDevelopers/status/1228393702244134912

在 Params 选项卡中，向下滚动，越过所有查询参数，找到“Path Variables”部分。我们将把你想使用的 Post ID 作为值添加到 id 键中。

如果你已正确完成本步骤中的所有输入，Params 选项卡应如下所示：

​

第五步：发送请求并查看响应

现在你的请求已配置完成，可以点击“发送”按钮。 

如果一切配置正确，你将会收到如下有效负载：

{
    "data": {
        "author_id": "2244994945",
        "text": "开发者在情人节贺卡上写了什么?\n  \nwhile(true) {\n    I = Love(You);  \n}",
        "id": "1228393702244134912",
        "created_at": "2020-02-14T19:00:55.000Z"
    },
    "includes": {
        "users": [
            {
                "username": "XDevelopers",
                "name": "开发者",
                "id": "2244994945"
            }
        ]
    }
}

​

使用 Postman 生成用户访问令牌：

​

使用 OAuth 1.0a 生成用户访问令牌

请查看 OAuth 1.0a 流程测试集合 中的三步流程。

​

使用 OAuth 2.0 生成用户访问令牌

如果你想在 Postman 中生成 OAuth 2.0 用户访问令牌，可以生成 OAuth 2.0 访问令牌并与 X API v2 Postman collection 搭配使用。 

在你的工作区中点击该集合，转到名为“Auth”的选项卡，并将类型选择为“OAuth 2.0”。然后在“Configure New Token”标题下，前往“Configuration Options”。你可以将“Grant Type”更新为“Authorization Code (With PKCE)”。

你需要将 Callback URL 更新为与你的应用关联的回调 URL。此外，还需要更新以下参数：

• Auth URL -  https://x.com/i/oauth2/authorize
• Access Token URL -  https://api.x.com/2/oauth2/token
• Client ID - 来自 Dev Portal 的 OAuth 2.0 客户端 ID
• Client Secret - 如果你使用的是机密客户端
• Scope - 与要访问的端点相匹配的权限范围。例如“tweet.read users.read”
• 你的回调 URL（也称为重定向 URL）。必须与你在应用的认证设置中配置的内容一致。
• State - state

准备就绪后，点击“Get New Access Token”来生成访问令牌。如果你看到一个对话框提示出现问题，可能需要按返回按钮登录。你需要在对话框中点击“Authorize app”为你的应用授权访问你的账户。

授权应用后，你将被重定向回 Postman，在那里你可以看到你的令牌，并点击“Use Token”按钮，以代表已授权用户开始发起请求。

你现在已准备好使用该 Postman collection。

​

接下来

如果你在 Postman 中点击“Code”按钮，就可以将我们刚刚创建的请求转换为你选择的语言，例如 Python、Node 或 Ruby，帮助你快速上手。Postman 提供了详尽的文档，可能会对你有所帮助。我们在 GitHub 上也提供了一些示例代码，可帮助你更快对接这些端点。