管理 API 鑰匙

開啟雲端驗證並授權 API 存取使用 API 鑰匙，讓您可以為存取特定資源並使用 API 提供粒度權限和安全控制，例如資料儲存和地點。

所有開放雲 API 需要您創建一個 API 鑰匙並在您的請邀請中包含 x-api-key 標題，這允許應用程序在您的代理上驗證開啟雲朵。

創建 API 鑰匙

您可以為個人所有的體驗或群組所有的體驗創建並配置 API 鑰匙 (A Roblox 群組可以允許多個創作者在同一個體驗上工作、使用相同的資產和分享 API 鑰匙)。

您必須是群組所有者或指派到群組內的角色，持有 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. 在 安全 部分中，明確將 I鍵 存取設定為 CIDR 語法 ，否則您無法使用 API 鑰匙。 您可以找到本機電環境的 I鍵

10. (可選) : 為您的資源增加額外保護，設定明示的過期日期，以便您的鑰匙在該日期後自動停止運作。

11. 點擊 儲存並生成鑰匙 按鈕。

12. 將 API 鑰匙字串複製並儲存到 不是 公共儲存庫的代碼。

13. 查看您創建的 API 鑰匙在 資料庫 頁面的 創作者面板 。

群組擁有 API 鑰匙權限

群組所有者可以管理群組所有者 API 鑰匙權限，讓群組成員擁有不同的 API 鑰匙控制水平。也有情況會自動取消群組成員對 API 鑰匙控制權限的 API 鑰匙管理權限。

許可授權

作為群組所有者，您可以授予 管理所有 API 鑰匙 權限給群組內的角色。這個權限的成員具有您群組所有者的所有 API 鑰匙的權限，包括能創建立、創作、查檢視、撤銷、取消、審計和審計所有群組的 API 鑰匙的能力。

您也可以授權 管理自己的 API 鑰匙 權限給角色內的角群組。這允許會員僅創建並檢視擁有的鑰匙，而不是能夠管理其他人的鑰匙。

權限無效

有多個情況下會自動取消群組成成員 會員的權限來管理群組 API 鑰匙：

• 會員被指派到不具權限的角色。這可能會在群組的擁有轉移期間發生。
• 會成員 會員的權限在目前分配的角色上已停用。
• 成員離開或被移除群組。
• 會成員 會員的帳戶受到 Roblox 的審核。

在這些情況中，由該用戶生成的 API 鑰匙獲得 撤回 狀態。要重新使用這些鑰匙，群組所有者或具有 管理所有 API 鑰匙 權限的成員必須重生鑰匙。

CIDR 格式

為了進一步保護您的資源，當 創建 API 鑰匙 時，指定 IP 地址可以使用 IP 鑰匙的任何正常 IP 地址或使用 CIDR 語法 。 CIDR 語法 IP 地址看起來像正常 IP 地址，但它們結束於斬號和代表網路路由的數位：

• 普通 : 192.168.0.0
• CIDR : 192.168.0.0/24

前者是 IP 地址，後者是 網路 маска ，計算 1 秒的位元數量以二進制格式。 在以前的範例中， 24 代表 255.255.255.0

API 鑰匙狀態

API 鑰匙最初有一個啟用狀態，但在其生命時間過程中可能會變成無效狀態。要了解為什麼 API 鑰匙變更狀態並且如何將 API 鑰匙返回到有效狀態，請參閱下表。