跳转到主要内容
本指南将带你完成发送首个请求的步骤。一旦你注册了 X 账户,它将是很好的参考资源。 如果你希望使用代码示例、更技术性的指南,或 Postman 等图形化工具,请参考以下指南来完成你的首次请求: 本指南假定你已获取并妥善保存了你的 API Key 和 Secret用户 access token 和 secretApp Access Token。你可以按照获取 X API 访问权限指南中的步骤了解具体操作。

步骤 1:确定你要使用的 endpoint

X API 允许你通过代码执行多种操作,这些操作与您在 X 网站或移动应用上能完成的操作类似。 我们在 API Reference Index 中列出了可通过 API 使用的完整 endpoint 清单,但为简化起见,建议优先从以下选项中选择:

步骤 2:选择用于发起请求的工具

有些请求较为简单,但也有些实现起来较为棘手。因此,我们出色的开发者社区构建了工具,以帮助屏蔽部分复杂性。 以下是一些推荐的工具及其使用说明:

Postman

Postman 是一款可视化工具,可用于向 REST endpoint 发起请求。我们围绕 Postman 准备了一些优质资料,帮助您上手并探索通过 X API 提供的各个 endpoint。 我们建议先阅读「使用 Postman 入门」教程,了解如何添加您的密钥和令牌并发起首个请求。 我们还为每个 X API v2 endpoint 提供了快速上手指南,其中大多数使用 Postman。您可以在各自的 endpoint 章节找到这些指南,这里是其中一些链接:
  • 快速上手:发布一条 Tweet
  • 快速上手:搜索 Post
  • 快速上手:查询用户
请注意,您无法使用 Postman 向 streaming endpoint 发起请求。请访问过滤的流1% 抽样 stream的快速上手指南,了解如何使用这些 endpoint。 如果您更偏好更为简洁的图形化工具,也可以考虑使用 Insomnia

示例代码

如果你想用一些简单代码来发起请求,我们为每个 X API v2 endpoint 提供了多种语言的示例代码。 你可以在我们的 GitHub 仓库 X-API-v2-sample-code 中找到这些示例代码。仓库还包含 README 文件,可帮助你了解如何设置凭据,以便正确配合请求使用。 例如,下面是用户查询 endpoint 的一个 cURL 示例。要使用该请求,你只需将 ACCESS_TOKEN 和 USERNAME 分别替换为你的 App Access Token 和 X 用户名(handle)。然后,将此代码复制粘贴到命令行工具中,按下 Return 或 Enter 键即可。
curl "https://api.x.com/2/users/by/username/$USERNAME" -H "Authorization: Bearer $ACCESS_TOKEN"

活跃的 X Developer 社区还用多种编程语言构建了库,便于你向 X API 发起请求。 我们提供了一个”工具与库”页面,列出了我们所知的所有社区库。每个库通常都包含一个 README 文件,你可以据此在本机设置仓库并发送你的第一个请求。
请注意: 如果你遇到任何问题,请查阅与你要调用的 endpoint 对应的开发者文档、我们的支持页面,或在论坛向社区寻求帮助。我们会协助你成功发起请求!

第 3 步。查看响应

当你成功发出请求后,将会收到一个包含与该请求相关 metadata 的负载。 如果你调用的是采用 GET HTTP 方法的 endpoint,你将以 JSON 格式收到与你请求的资源(Post、user、List、Space 等)相关的 metadata。请查看返回的各个 fields,看看能否将你请求的信息对应到 X 上的内容。 如果你调用的是采用 POST、PUT 或 DELETE HTTP 方法的 endpoint,则表示你在 X 上执行了一个操作。前往 X.com 或移动 App,查看能否找到该操作。

步骤 4. 使用参数调整你的请求

每个 endpoint 都有一组不同的参数可用于调整请求。例如,在使用 GET endpoint 时,你可以通过 fields 和 expansions 参数请求额外的 metadata 字段。你还可以在诸如 search PostsPost countsfiltered stream 等 endpoint 上尝试多种过滤工具,帮助你将接收到的 data 范围缩小到你所关注的那些 Posts。 你可以在所使用的 endpoint 的 API Reference 中找到请求参数和 fields 的完整列表,并可在我们的集成指南和基础知识页面中获取更多有用的集成信息。 你可以通过我们的 Important resources 指南了解我们为你提供的所有学习材料的更多信息。
I