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

实用工具

在介绍有助于你集成此端点的一些关键概念之前,我们建议你先熟悉:

Postman

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

代码示例

想用你常用的编程语言配合一些代码来配置并使用此端点吗?我们在 GitHub 页面提供了多种代码示例,可作为你的起点。

第三方库

借助我们社区的第三方库第三方库快速上手。你可以通过查找相应的版本标签,找到与 v2 端点兼容的库。

关键概念

认证

所有 X API v2 端点都要求你使用一组凭据(也称为密钥和令牌)对请求进行认证。你可以使用 OAuth 1.0a 用户上下文、仅应用(App only)或 OAuth 2.0 授权码(PKCE)来对发送到此端点的请求进行认证。  OAuth 1.0a 用户上下文(/zh/resources/fundamentals/authentication#oauth-1-0a-2),这意味着你必须使用一组 API Keys 和用户 Access Tokens 才能成功发起请求。Access Tokens 必须与你代表其发起请求的用户关联。如果你想为另一位用户生成一组 Access Tokens,他们必须通过 三方(3-legged)OAuth 流程(/zh/resources/fundamentals/authentication#obtaining-access-tokens-using-3-legged-oauth-flow)授权你的应用。 请注意,OAuth 1.0a 使用起来可能比较复杂。如果你不熟悉此认证方法,建议你使用一款(/zh/x-api/tools-and-libraries/overview)、使用 Postman 等工具,或使用 OAuth 2.0 或仅应用(App only)来对请求进行认证。 OAuth 2.0 授权码(PKCE)(/zh/resources/fundamentals/authentication#oauth-2-0-authorization-code-flow-with-pkce-2) 允许对应用的作用域进行更精细的控制,并支持跨多设备的授权流程。OAuth 2.0 允许你选择特定的细粒度作用域,从而代表用户获取特定权限。  要在你的应用中启用 OAuth 2.0,必须在开发者门户的“应用设置”中的认证设置里将其开启。 仅应用(App only)(/zh/resources/fundamentals/authentication#app-only-authentication-and-oauth-2-0-bearer-token) 只要求你在请求中携带一个仅应用 Access Token(/zh/resources/fundamentals/authentication#app-only-authentication-and-oauth-2-0-bearer-token)。你可以在开发者应用内直接生成一个仅应用 Access Token,或使用 POST oauth2/token(/zh/resources/fundamentals/authentication#post-oauth2-token) 端点生成。

开发者门户、Project 与开发者应用

要获取可用于 X API v2 端点的一组认证凭据,你必须先注册开发者账号、在该账号下设置一个 Project(或查看本地化版本:Project),并在该 Project 内创建一个开发者应用(或查看本地化版本:开发者应用)。随后,你可以在开发者应用中找到你的密钥和令牌。  

速率限制

每天都有成千上万的开发者向 X API 发起请求。为帮助管理如此庞大的请求量,我们在每个端点上设置了速率限制,以限制你代表你的应用或代表已认证用户所能发起的请求数量。 此端点在应用级和用户级都会受到速率限制。应用级速率限制意味着你(开发者)在给定时间段内,从任一应用(通过使用 API Key 和 API Secret Key,或 Bearer Token)只能对该端点发起一定数量的请求。用户级速率限制意味着你代表其发起请求的已认证用户,在任何开发者应用中只能执行一定次数的列表 Post 查询。 下表显示了各端点的速率限制。
端点HTTP 方法速率限制
/2/lists/:id/tweetsGET每 15 分钟 900 次请求
字段与 expansions X API v2 的 GET 端点允许用户使用名为 fieldsexpansions 的一组工具,精确选择希望从 API 返回的数据。expansions 参数允许你展开载荷中被引用的对象。例如,查找列表 Post 允许你拉取以下expansions
  • author_id
fields 参数允许你精确选择希望接收的不同数据对象中的哪些fields。此端点主要返回 Post 对象。默认情况下,Post 对象返回 idtext 字段。若要接收诸如 tweet.created_attweet.lang 等其他字段,你需要使用 fields 参数明确请求这些字段。 我们在X API v2 数据字典中新增了关于同时使用 fields 和 expansions的指南。 下表显示了查找端点可用的字段和 expansions:
端点字段Expansions
/2/lists/:id/tweetstweet.fields

user.fields
author_id
分页 查找列表 Post 可能会返回大量数据。为确保我们在任意时间点都能返回一致且高性能的结果,我们使用分页。分页是 X API v2 中的一项功能,用于在端点返回的结果超过单个响应所能包含的数量时,将数据分为一系列“页面”。了解更多关于如何分页获取结果的信息。