云 API 参考

使用开放云，您可以通过标准 REST API 访问 Roblox 资源，这让您从命令行自动化工具到复杂的网站应用程序一切都能建立。开放云 API 支持 HTTPS 并使用 API 钥匙 或 OAuth 2.0 进行身份验证。您可以更新体验、重新启动服务器、与数据存储和内存存储工作、管理用户限制、列出库存物品，以及更多。

关于这个参考

此参考文档分为两个部分：

• 一个基于功能的部分，将 API 按使用案例分类 (虚拟形象、游戏通行证、用户等)。
• 一个 部分，用系统分开端点 (Open Cloud v2、v1 或遗旧版)。 两个部分 包含完整的可用 API 端点列表；使用任何一个帮助您找到您需要的内容。

尽可能使用 Open Cloud v2、Open Cloud v1 或 支持 API 钥匙和/或 OAuth 2.0 认证的遗产端点。这些 API 具有强大的稳定性保证，定期添加新资源。

使用饼干认证的遗产 API 端点可以无需通知进行断改，且具有最小稳定性保证。我们不建议使用它们来满足生产应用。遗产 API 在多年间被各种名称所知，包括 Roblox 站点 API、网站 API 和经典 API。

开始使用开放云

1. 为您的应用设置认证。

   查看文档，了解如何使用 API 钥匙 或 OAuth 2.0。API 钥匙是最简单的方式开始。

2. 使用工具如 Postman 和 OpenAPI 描述 或 OAuth 2.0 示例应用程序 来测试 API 调用，使用 API 描述 或 OAuth 2.0 示例应用程序 进行。

3. 查看 资源指南 以获取使用某些 API 的端到端示范。

4. 探索左侧导航以获取完整列表的 Open Cloud v2 和 v1 资源、常用 API 模式、类型和错误代码。