跳转到主要内容本页介绍在将 Lists 端点集成到你的系统时需要了解的若干工具和关键概念。我们将内容划分为以下几个部分:
在深入介绍有助于你集成此端点的一些关键概念之前,我们建议先熟悉以下内容:
Postman 是一款非常好用的工具,可用于测试各类端点(endpoint)。每个 Postman 请求都包含所有路径参数和请求体参数,帮助你快速了解可用的选项。要进一步了解我们的 Postman 集合,请访问我们的「使用 Postman」页面:“使用 Postman”。
想用你常用的编程语言,配合一些代码来对接此 endpoint 吗?我们在 GitHub 页面提供了多种可作为起点的代码示例。
利用我们社区提供的第三方库来帮助你快速上手。你可以通过查找相应的版本标签,找到可与 v2 端点配套使用的库。参见原文链接:/x-api/tools-and-libraries/overview
所有 X API v2 端点都要求你使用一组凭据(也称为密钥和令牌)对请求进行认证。
这些特定端点需要使用 OAuth 1.0a 用户上下文 或 OAuth 1.0a 用户上下文(中文),这意味着你必须使用一组 API 密钥和用户访问令牌才能成功发起请求。访问令牌必须与你代表其发起请求的用户关联。如果你想为另一位用户生成一组访问令牌,他们必须通过 三方 OAuth 流程 或 三方 OAuth 流程(中文) 授权或认证你的应用。
请注意,OAuth 1.0a 的使用可能比较棘手。如果你不熟悉这种认证方法,我们建议使用库 或 库(中文) 或 Postman 等工具来正确地为你的请求进行认证。
要获取可用于 X API v2 端点的一组认证凭据,您必须先注册开发者账户,在该账户下设置一个Project(/zh/resources/fundamentals/projects),并在该 Project 中创建一个开发者应用(/zh/resources/fundamentals/developer-apps)。随后,您可以在开发者应用中找到您的密钥和令牌。
每天有成千上万的开发者向 X API 发起请求。为管理如此庞大的请求量,我们在每个端点上设置了速率限制,以限制你代表你的应用或代表已通过身份验证的用户所能发起的请求次数。
这些端点按用户维度进行速率限制,这意味着你所代表的已通过身份验证的用户在任何开发者应用中调用该端点的次数都有上限。
下表展示了各端点的速率限制。
| | |
|---|
| 端点 | HTTP 方法 | 速率限制 |
| /2/lists | POST | 每 15 分钟 300 次请求 |
| /2/lists/:id | DELETE / PUT | 每 15 分钟 300 次请求 |