跳转到主要内容
本页介绍了在将 mutes endpoint 集成到你的系统时需要了解的多种工具和关键概念。我们将本页划分为以下几个部分:

实用工具

在深入介绍有助于你集成此 endpoint 的关键概念之前,我们建议你先熟悉以下内容:

Postman

Postman 是一款非常适合用于测试 endpoint 的工具。每个 Postman 请求都会包含所有路径参数和请求体参数,帮助你快速了解可用项。要进一步了解我们的 Postman 集合,请访问我们的 “Using Postman” 页面。 

代码示例

想用你常用的编程语言配合此 endpoint 快速上手吗?我们在 GitHub 页面提供了多种代码示例,可作为你的起步参考。

第三方库

利用我们的社区提供的第三方库来快速上手。通过查找相应的版本标签,你可以找到与 v2 endpoint 兼容的库。

关键概念

身份验证

所有 X API v2 endpoint 都要求你使用一组凭据(亦称“密钥和令牌”)对请求进行身份验证。你可以使用 OAuth 1.0a 用户上下文,或使用 OAuth 2.0 授权码模式(Authorization Code)配合 PKCE 来对这些 endpoint 的请求进行身份验证。  OAuth 1.0a 用户上下文 要求你使用你的 API Key、用户 Access Tokens,以及若干其他参数来创建授权标头,随后将其随请求一起发送。Access Tokens 必须与您代表其发出请求的用户关联。如果你希望为另一位用户生成一组 Access Tokens,该用户必须通过三方 OAuth 授权流程授权你的 App。  请注意,OAuth 1.0a 可能较难使用。如果你不熟悉此身份验证方法,建议使用、使用 Postman 等工具,或使用 OAuth 2.0 来对你的请求进行身份验证。 OAuth 2.0 授权码模式(Authorization Code)配合 PKCE 能更好地控制应用的 scope,以及在多设备间的授权流程。OAuth 2.0 允许你选择细粒度的特定 scope,以便代表用户获取相应的权限。  要在你的 App 中启用 OAuth 2.0,你需要前往开发者门户的 App 设置,在“身份验证设置”中将其启用。

开发者门户、Project 及开发者 App

要获取可用于 X API v2 endpoint 的一组身份验证凭据,您必须先注册开发者账户,在该账户中设置一个 Project,并在该 Project 中创建一个开发者 App。随后,您可以在该开发者 App 中找到您的密钥和令牌。  

请求速率限制

每天都有成千上万的开发者向 X API 发起请求。为帮助管理海量请求,请求速率限制 会施加在每个 endpoint 上,限制你代表你的 App 或经身份验证用户所能发起的请求数量。 这些 endpoint 采用用户级别的请求速率限制,这意味着你代表其发起请求的经身份验证用户,在任何开发者 App 中对该 endpoint 的调用次数都有上限。 针对每个 endpoint,用户级别的请求速率限制为:使用 POST 和 DELETE 方法时为每 15 分钟 50 次;而使用 GET 方法时仅为每 15 分钟 15 次。  

字段与扩展

X API v2 的 GET endpoint 允许用户使用一组称为 fields 和 expansions 的工具,精确选择希望从 API 返回的 data。expansions 参数允许你展开载荷中被引用的对象。例如,该 endpoint 允许你获取以下expansions
  • pinned_tweet_id
fields 参数允许你在不同数据对象中精确选择希望接收的fields。此 endpoint 主要返回用户对象。默认情况下,用户对象会返回 idnameusername 字段。若要接收其他字段,例如 user.created_atuser.entities,需要通过 fields 参数显式请求这些字段。 我们在 X API v2 data dictionary 中新增了关于结合使用 fields 和 expansions 的指南。 静音列表查询可能会返回大量 data。为确保在任何时刻都能提供一致且高性能的结果,我们采用分页。分页是 X API v2 的 endpoint 提供的一项功能,用于在单个响应无法容纳所有结果时分批返回数据。此时,data 会以一系列“页面”形式返回。了解如何对结果进行分页。
请注意: 如果用户在 X 上执行静音操作,每 15 分钟最多可发出 200 次请求。
I