跳转到主要内容本页介绍在将 blocks 端点集成到你的系统时应了解的多种工具和关键概念。我们将本页分为以下几个部分:
在介绍一些有助于你集成此端点的关键概念之前,我们建议你先熟悉以下内容:
Postman 是一款非常适合用于测试端点的工具。每个 Postman 请求都包含所有路径参数和请求体参数,帮助你快速了解可用内容。要了解更多关于我们的 Postman 集合的信息,请访问我们的 “使用 Postman” 页面。
想用你常用的编程语言,通过示例代码来对接此端点吗?我们在 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 允许你选择细粒度的 scope,从而代表用户获取相应的具体权限。
要在你的应用中启用 OAuth 2.0,你必须在开发者门户的应用设置中,找到该应用的认证设置并将其启用。
要获取可用于 X API v2 端点的一组认证凭证,您必须先注册开发者账户,在该账户下设置一个项目,并在该项目中创建一个开发者应用。随后,您可以在该开发者应用中找到您的密钥和令牌。
每天都有成千上万的开发者向 X API 发起请求。为管理如此庞大的请求量,我们在每个 endpoint 上设置了速率限制,以限制你代表你的应用或经认证用户所能发起的请求数量。
这些 endpoint 采用用户级速率限制,这意味着你代表其发起请求的经认证用户,在任何开发者应用中调用该 endpoint 的次数都有上限。对于 POST 和 DELETE 方法,每个 endpoint 的用户速率限制为每 15 分钟 50 次请求;而对于 GET 方法,速率限制为每 15 分钟仅 15 次请求。
X API v2 的 GET 端点允许用户通过称为字段与 expansions 的一组工具,精确选择希望由 API 返回的数据。expansions 参数可将载荷中被引用的对象展开。例如,此端点允许你获取以下expansions:
fields 参数允许你精确选择希望在不同数据对象中接收的fields。这些端点主要返回 Post 对象。默认情况下,Post 对象仅返回 id 和 text 字段。若要获取其他字段(例如 tweet.created_at 或 tweet.entities),必须通过 fields 参数显式请求。在你的集成中,你可能会考虑使用的一些重要字段包括投票 data、指标、Post 注释以及会话 ID 字段。
我们已在 X API v2 数据字典中添加了关于如何同时使用 fields 与 expansions的指南。
阻止列表查询可能会返回大量数据。为避免一次性返回过多结果,我们采用分页。了解如何分页获取结果。