跳转到主要内容
本指南将带你依次完成一些步骤,帮助你发起首次请求。注册 X 账号后,你可以将其作为入门参考。 如果你希望使用代码示例、更多技术向导,或 Postman 等图形化工具,请参考以下指南以完成你的首次请求: 本指南假定你已获取并安全保存了你的 API key 和 secret用户 Access Token 和 Secret应用 Access Token。你可以按照获取 X API 访问权限指南的步骤了解如何完成上述操作。

步骤 1. 确定要使用的 endpoint

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

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

虽然有些请求很直观,但另一些可能较难构建。因此,出色的开发者社区开发了工具,以屏蔽部分复杂性。 以下是一些推荐的工具及其使用方法:

Postman

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

示例代码

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

出色的 X 开发者社区还使用多种编程语言构建了可用于向 X API 发起请求的库。 我们整理了一个”工具与库”页面,列出了我们已知的所有社区库。每个库通常都会附带 ReadMe 文件,帮助你在本地设置仓库并发送你的第一个请求。
请注意: 如果你遇到任何问题,请查阅你要调用的端点对应的开发者文档、我们的支持页面,或在我们的论坛向社区求助。我们会帮助你成功发起请求!

步骤 3. 查看响应

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

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

每个 endpoint 都有各自的一组参数,可用于修改你的请求。例如,在使用 GET endpoint 时,你可以通过 fields 和 expansions 参数请求额外的元数据字段。你还可以在诸如 搜索 PostPost 计数过滤流 等 endpoint 上尝试多种不同的过滤工具,帮助将你接收的 data 精确缩小到你感兴趣的那些 Post。 你可以在所用 endpoint 的 API Reference 中找到请求参数和 fields 的完整列表,并在我们的集成指南和基础知识页面中获取更多有用的集成信息。 你可以通过我们的重要资源指南了解我们为你提供的全部学习资料。