應用程式 API 金鑰¶
這頁能幫你做什麼¶
「應用程式 API 金鑰」(Application API Key) 是給第三方服務使用的 API 金鑰，讓外部系統可以代表終端使用者呼叫平台 API。和帳戶頁的個人 API 金鑰不同：個人金鑰歸屬於你的帳號、沿用你的權限；應用程式金鑰由管理員建立、帶有一份群組白名單，而且永遠不具備管理員權限。
常見情境：把平台能力接到公司既有的後端服務、網站或自動化流程，又希望嚴格限制這把金鑰只能動到指定群組的資源。
需要管理員權限
「應用程式 API 金鑰」屬於「管理」區，只會出現在管理員帳號的選單。一般使用者看不到。若看不到這個項目，表示你的帳號不是管理員。
妥善保管金鑰
金鑰等同憑證，請勿外流或寫死在公開程式碼中。若疑似外洩，請立即停用或刪除該金鑰。
進入頁面¶
點右上角頭像選單中「管理」分組下的「應用程式 API 金鑰」，進入清單頁（網址為 /application-api-keys）。
清單¶
清單欄位：
| 欄位 | 說明 |
|---|---|
| 名稱 | 金鑰名稱，點擊可進入詳細頁。 |
| 啟用 | 金鑰目前是否啟用（顯示「是」／「否」）。 |
| 最後更新 | 最後一次更新時間，可點欄位標題排序。 |
右上角的 為「建立」、 為重新整理；清單可依「ID」或「名稱」搜尋。清單與詳細頁的共用操作說明見通用介面元件 — 頂列與清單頁的共用操作。
建立¶
- 在清單頁點右上角的 （建立）。
- 填入「名稱」。
- 在「授權群組」選擇一個或多個可使用這把金鑰的群組。
- 視需要填寫「描述」。
-
點儲存。建立後會進入詳細頁，可在此取得金鑰值。
完整欄位說明¶
| 欄位 | 必填 | 預設 | 說明 |
|---|---|---|---|
| 名稱 (Name) | 是 | 無 | 金鑰的識別名稱，僅能使用英文字母、數字、- 與 _。 |
| 授權群組 (Authorized Groups) | 是 | 無 | 指定可使用此 API 金鑰的群組（可多選）。這把金鑰只能存取所選群組有權限的資源，形成一份白名單。 |
| 描述 (Description) | 否 | 無 | 金鑰用途的說明文字。 |
| 啟用 (Enabled) | 否 | 開啟 | 僅在編輯時出現。關閉即停用金鑰，使用該金鑰的請求將無法通過驗證；可再次開啟恢復。 |
永遠不具管理員權限
應用程式 API 金鑰無論授權哪些群組，都不會取得管理員權限。它的可用範圍完全由「授權群組」決定。
詳細頁與取得金鑰值¶
在清單點金鑰名稱進入詳細頁，可看到金鑰的 ID、名稱、授權群組、描述、啟用狀態與最後更新時間，並可複製實際的金鑰值交給第三方服務使用。詳細頁右上角提供 「編輯」與 「刪除」。
編輯與停用¶
在詳細頁點「編輯」可修改名稱、授權群組、描述，以及用「啟用」開關停用或恢復金鑰。若不再需要某把金鑰，可用清單每列的 選單或詳細頁的「刪除」永久移除。
下一步¶
- 到 群組 規劃這把金鑰要授權的群組權限。
- 若只是個人要以程式呼叫 API，改用帳戶頁的個人 API 金鑰。