集成指南

本页介绍在将 mutes 端点集成到你的系统时需要了解的多种工具和关键概念。我们将本页分为以下几个部分：

• 实用工具
• 关键概念
• 认证
• 开发者门户、Project 和 应用
• 速率限制
• fields 和 expansions

​

实用工具

在介绍有助于你集成该端点的一些关键概念之前，建议先熟悉以下内容：

​

Postman

Postman 是一款非常好用的工具，可用于测试各个端点（endpoint）。每个 Postman 请求都包含所有路径参数和请求体参数，帮助你快速了解可用内容。要进一步了解我们的 Postman 集合，请访问我们的 「使用 Postman」 页面。 

​

代码示例

想用你常用的编程语言配合一些代码来使用这个 endpoint 吗？我们在 GitHub 页面提供了多种代码示例，供你快速上手。

​

第三方库

利用我们社区的第三方库加速上手。你可以通过查找相应的版本标签，找到适配 v2 端点的库。

​

关键概念

​

认证

所有 X API v2 端点都要求你使用一组凭证（也称为密钥和令牌）对请求进行认证。你可以使用 OAuth 1.0a 用户上下文来对该端点的请求进行认证。 

OAuth 1.0a 用户上下文，这意味着你必须使用一组 API Keys 和用户 Access Tokens 才能发起成功的请求。Access Tokens 必须与你所代表发起请求的用户关联。如果你想为另一位用户生成一组 Access Tokens，则他们必须通过 3-legged OAuth flow 授权你的应用。

请注意，OAuth 1.0a 的使用可能较为复杂。如果你不熟悉这种认证方法，我们建议你使用库，或使用 Postman 等工具。

​

开发者门户、Project，以及开发者应用

要获取可用于 X API v2 端点的一组认证凭据，您必须先注册开发者账户，在该账户下设置一个Project、Project并在该 Project 内创建一个开发者应用、开发者应用。然后，您可以在开发者应用中找到您的密钥和令牌。  

​

速率限制

每天都有成千上万的开发者向 X API 发起请求。为便于管理庞大的请求量，我们在每个端点上设置了速率限制，以限制你代表应用或经过身份验证的用户所能发起的请求数量。 

这些端点在用户层面实施速率限制，这意味着你所代表的经过身份验证的用户在任何开发者应用中调用该端点的次数都有上限。 

下表展示了各端点的速率限制。

端点	HTTP 方法	速率限制
/2/users/:id/pinned_lists	POST	每 15 分钟 50 次请求
/2/users/:id/pinned_lists/:list_id	DELETE	每 15 分钟 50 次请求
/2/users/:id/pinned_lists	GET	每 15 分钟 15 次请求

​

字段与 expansions

X API v2 的 GET 端点允许用户使用一组称为 fields 和 expansions 的工具，精确选择希望从 API 返回的 data。expansions 参数允许你展开有效负载中被引用的对象。比如，查询置顶的 Lists 时，你可以获取以下 expansions：

• owner_id

fields 参数允许你在不同的数据对象中精确选择希望接收的具体 fields。该端点主要返回用户对象。默认情况下，List 对象会返回 id 和 name 字段。若要接收诸如 list.created_at 或 list.description 等其他字段，你需要通过 fields 参数显式请求这些字段。 

我们在 X API v2 数据字典 中新增了关于如何同时使用 fields 和 expansions 的指南。

下表展示了该查询端点可用的字段与 expansions：

端点	字段	Expansions
/2/users/:id/pinned_lists	list.fields user.fields	owner_id