集成指南

本页介绍在将 mutes endpoint 集成到你的系统时需要了解的若干工具和关键概念。我们将内容分为以下部分：

• 实用工具
• 关键概念
• 身份验证
• 开发者门户、Project 和 App
• 请求速率限制
• fields 与 expansions

​

实用工具

在深入介绍有助于你集成此 endpoint 的关键概念之前，建议先熟悉以下内容：

​

Postman

Postman 是一款功能强大的工具，可用于测试 endpoint。每个 Postman 请求都包含所有路径参数和请求体参数，帮助您快速了解可用内容。要进一步了解我们的 Postman 集合，请访问我们的 “Using Postman” 页面。 

​

代码示例

想用您常用的编程语言，通过代码快速对接此 endpoint 吗？我们在 GitHub 页面提供了多种代码示例，供您作为起点参考。

​

第三方库

利用我们的社区提供的第三方库来帮助你入门。通过查找相应的版本标签，你可以找到与 v2 endpoint 兼容的库。

​

核心概念

​

身份验证

所有 X API v2 endpoint 都要求你使用一组凭证（亦称“密钥和令牌”）对请求进行身份验证。你可以使用 OAuth 1.0a 用户上下文来对该 endpoint 的请求进行身份验证。 

OAuth 1.0a 用户上下文，这意味着你必须使用一组 API Key 和用户 Access Tokens 才能成功发起请求。access token 必须与代其发起请求的用户关联。如果你希望为另一位用户生成一组 Access Tokens，则该用户必须通过 三方 OAuth 授权流程 授权你的 App。

请注意，OAuth 1.0a 的使用可能较为复杂。如果你不熟悉此身份验证方法，建议使用一个 library 或者使用诸如 Postman 之类的工具。

​

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

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

​

请求速率限制

每天都有成千上万的开发者向 X API 发起请求。为管理海量请求，我们在每个 endpoint 上设置了请求速率限制，以限制你代表你的 App 或代表已通过身份验证的用户所能发起的请求次数。 

这些 endpoint 在用户级别实施请求速率限制，这意味着你所代表的已通过身份验证的用户，无论使用哪一个开发者 App，对该 endpoint 的调用次数都有上限。 

下表显示了每个 endpoint 的请求速率限制。

Endpoint	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 次请求

​

字段与扩展

X API v2 的 GET endpoint 允许用户使用名为 fields 和 expansions 的一组工具，精确选择希望从 API 返回的 data。expansions 参数允许你展开在载荷中被引用的对象。例如，查询置顶的 List 可让你获取以下expansions：

• owner_id

fields 参数允许你精确选择希望在不同数据对象中接收的fields。此 endpoint 主要返回用户对象。默认情况下，List 对象返回 id 和 name 字段。若要接收 list.created_at 或 list.description 等其他字段，你需要使用 fields 参数明确请求这些字段。 

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

下表展示了该查询 endpoint 可用的字段与扩展：

Endpoint	Fields	Expansions
/2/users/:id/pinned_lists	list.fields user.fields	owner_id