管理 API 钥匙

使用 API 钥匙 API 访问授权和认证，使您能够使用 API 访问特定资源和控制您在体验中访问和使用特定资源的特定权限和安全控制，例如数据存储和地点。

所有开放云 API 都需要您创建一个 API 钥匙，具有有效的权限，并在您的请求中包含一个 x-api-key 头谱，允许应用程序在您的代表名下向 Open Cloud 验证。

创建 API 钥匙

您可以为您个人拥有的体验或群组拥有的体验创建和配置 API 钥匙（A Roblox 群组 群组 允许多个创作者同时为同一体验、使用相同的资产和共享 API 钥匙）。

您必须是群组的所有者或已被分配到群组中的角色，才能为您的群组创建 API 钥匙。群组成员只能通过与角色相同的资源访问权限创建 API 钥匙。例如，只有具有“ 创建和编辑群组体验 ”权限的群组成员才能创建能够发布地方文件的 API 钥匙。

要创建 API 钥键：

1. 导航到创建者仪表板。

2. （可选） 单击 创建者中心 下拉菜单，如果您为群组创建 API 钥匙，选择一个群组。

3. 在左侧导航菜单中，选择 打开云 → API钥匙 。

4. 点击 创建 API 钥匙 按钮。

5. 为 API 钥键输入唯一的名称。使用您稍后可以回忆目的的名称，例如 PLACE_PUBLISHING_KEY 发布地点到您的体验。

6. 在 访问权限 部分中，从 选择 API 系统 菜单中选择 API 并单击 添加 API 系统 按钮。如果需要添加多个 API 到键匙，请重复此步骤。

7. 选择您想要使用 API 钥键访问的体验。

8. 从 体验操作 下拉列表中，选择您想要启用API钥键的操作。

   在 API 引用 中，许多操作包括必要的权限范围。例如，清除内存存储 操作需要 universe.memory-store:flush 权限。

   为了安全原因，每个 API 钥匙上限都有可能需要的权限。如果 API 钥匙泄露，这个最小特权原则可以确保资源的最小子集。

9. 在 安全性 部分中，明确地将 IP 访问设置为使用 CIDR 语法 来键，否则您无法使用 API 钥匙。您可以找到您本地环境器的 IP

10. (可选) : 为了为您的资源添加额外的保护，设置明确的过期日期，以便您的钥匙在该日期后自动停止工作。

11. 点击 保存并生成钥匙 按钮。

12. 复制并保存 API 钥匙串到一个安全位置，其位置不是您的代验证码的公共存储库。

13. 查看你创建的 API 钥匙在 创建者仪表板 的 积分页面 。

群组拥有 API 钥匙权限

群组所有者可以管理群组拥有的 API 钥匙权限，以便群组成员根据角色和权限在 API 钥匙上拥有不同的控制级别。还有情况，在 which 角色和权限 在群组中，自动 revoke API 钥匙管理权限。

权限授予

作为群组所有者，您可以向角色在您的群组中授予 管理所有 API 钥匙 权限。 有此权限的会员具有您组的 API 钥匙的所有权限，包括创创建 or 创作、查看、撤回、撤销和查看所有群组的 API 钥匙。

您还可以向角色在您的群组内授予 管理自己的 API 钥匙 权限。这允许成员仅创建和查看由他们拥有的钥匙，而不能管理其他人的钥匙。

权限无效

有多种情况，可以自动取消群组成会员 / 成员的权限来管理群组 API 钥匙：

• 成员被分配到另一个没有权限的角色。这可能是在组的所有权转移中发生的。
• 成会员 / 成员的权限在他们当前分配的角色上已禁用。
• 成员离开或被移除从群组。
• 该会员 / 成员的帐户受到Roblox的审核。

在这些情况下，该用户生成的 API 钥匙都获得了 取消 状态 。要使用这些钥匙，群组所有者或有 管理所有 API 钥匙 权限的成员必须重生钥匙。

CIDR 格式

为了进一步保护您的资源，当 创建一个 API 钥匙 时，指定 IP 地址，它可以通过使用正常 IP 地址或使用 CIDR 语法 来访问 API 钥匙。 CIDR IP 地址看起来像一个正常 IP 地址，除了它结尾以下划号和一个代表网络路由的十六进制，它还表示 IP 地址的几个位置在网络路由中的重要性：

• 普通 : 192.168.0.0
• CIDR ：192.168.0.0/24

前部分是 IP 地址，后部分是 网服务器面具 ，计算 1 秒的位数在二进制格式。在以前的示例中， 24 意味着 255.255.255

API 钥匙状态

API 钥匙最初有一个有效状态，但在他们的生命时间过期时可能会变为无效状态。要了解为什么 API 钥匙已更改状态，并且如何将 API 钥匙返回到有效状态，请参阅以下表。