跳转到主要内容本页面介绍在将 mutes 端点集成到你的系统时需要了解的一些工具和关键概念。我们将本页面分为以下几个部分:
在我们介绍一些有助于你集成此端点的关键概念之前,建议先熟悉:
Postman 是一款非常出色的工具,可用于测试 endpoint。每个 Postman 请求都包含所有路径和请求体参数,帮助你快速了解可用项。要进一步了解我们的 Postman 集合,请访问“Using Postman”页面。
想用你常用的编程语言配合一些代码来使用此 endpoint 吗?我们在 GitHub 页面提供了多种代码示例,可作为你的起点。
利用我们社区提供的第三方库快速入门。查找相应的版本标签即可找到兼容 v2 端点的库。
所有 X API v2 端点都要求你使用一组凭证(也称为密钥和令牌)对请求进行认证。你可以使用 OAuth 1.0a 用户上下文或 OAuth 2.0 授权码(PKCE)来对这些端点的请求进行认证。
OAuth 1.0a 用户上下文 要求你使用 API Keys、用户 Access Tokens,以及少量其他参数来创建授权请求头,然后随请求一同发送。Access Tokens 必须与你所代表的目标用户相关联。如果你想为另一位用户生成一组 Access Tokens,他们必须通过三方 OAuth 流程授权你的应用。
请注意,OAuth 1.0a 使用起来可能较为复杂。如果你不熟悉此认证方法,我们建议使用库、使用 Postman 等工具,或改用 OAuth 2.0 来对请求进行认证。
OAuth 2.0 授权码(PKCE) 可对应用的权限范围进行更精细的控制,并支持跨设备的授权流程。OAuth 2.0 允许你选择细粒度的 scopes,从而代表用户获取相应的权限。
要在你的应用中启用 OAuth 2.0,你必须在开发者门户的 App 设置部分中的认证设置里将其启用。
要获取可用于 X API v2 端点的一组认证凭据,您必须先注册开发者账号,在该账号下设置一个项目,并在该项目内创建一个开发者应用。随后,您可以在开发者应用中找到密钥和令牌。
每天都有成千上万的开发者向 X API 发起请求。为帮助管理庞大的请求量,我们在每个端点设置了速率限制,用于限制你代表你的应用或代表已认证用户所能发起的请求数。
这些端点采用用户级速率限制,这意味着你所代表的已认证用户在任何开发者应用(App)中对该端点的调用次数都有上限。
对于每个端点,使用 POST 和 DELETE 方法的用户级速率限制为每 15 分钟 50 次请求;而使用 GET 方法时,速率限制为每 15 分钟仅 15 次请求。
X API v2 的 GET 端点允许用户使用一组称为字段与 expansions 的工具,精确指定希望从 API 返回的 data。expansions 参数可将负载中被引用的对象展开。例如,此端点支持以下expansions:
fields 参数允许你在不同的数据对象中精确选择希望接收的fields。此端点主要返回 User 对象。默认情况下,User 对象返回 id、name 和 username 字段。若要接收 user.created_at 或 user.entities 等其他字段,你需要通过 fields 参数显式请求这些字段。
我们在 X API v2 data dictionary 中新增了关于结合使用fields 和 expansions的指南。
静音查找可能会返回大量数据。为确保在任意时间返回一致且高性能的结果,我们使用分页。分页是 X API v2 端点中的一项功能,当结果数量超过单个响应可返回的范围时,会将 data 以一系列“页面”的形式返回。了解如何对结果进行分页。
请注意: 如果用户在 X 上执行静音操作,每 15 分钟最多可发出 200 次请求。