跳转到主要内容
本页汇总了在将 blocks 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 设置页面中,找到该 App 的身份验证设置并将其启用。

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

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

请求速率限制

每天,有成千上万的开发者向 X API 发起请求。为管理庞大的请求量,我们在每个 endpoint 上设置了请求速率限制,从而限制你代表你的 App 或代表已认证用户所能发起的请求次数。 这些 endpoint 采用用户级别的请求速率限制,这意味着你所代表的已认证用户在任何开发者 App 中调用该 endpoint 的次数都有上限。对于 POST 和 DELETE 方法,用户级别的限制为每个 endpoint 每 15 分钟 50 次请求;而对于 GET 方法,限制为每个 endpoint 每 15 分钟仅 15 次请求。  

字段与 expansions

X API v2 的 GET endpoint 允许用户使用称为 fields 和 expansions 的一组工具,精确选择希望从 API 返回的 data。expansions 参数允许你展开在负载中被引用的对象。例如,此 endpoint 允许你获取以下expansions
  • pinned_tweet_id
fields 参数允许你在不同的数据对象中精确选择希望接收的fields。这些 endpoints 主要返回 Post 对象。默认情况下,Post 对象仅返回 idtext 字段。若要接收其他字段,例如 tweet.created_attweet.entities,你需要使用 fields 参数显式请求这些字段。在你的集成中,一些值得考虑的重要字段包括投票数据、度量、Post annotations,以及会话 ID 字段。 我们已在 X API v2 data dictionary 中新增了关于如何同时使用 fields 和 expansions的指南。 Blocks 查询可能返回大量 data。为避免一次返回过多结果,我们采用分页机制。了解如何分页浏览结果
I