API 金鑰¶
這頁能幫你做什麼¶
帳戶頁的「API 金鑰」分頁讓你建立與管理 API 金鑰,用於以程式方式呼叫平台時驗證身分。金鑰歸屬於你的帳號,沿用你的權限。
個人金鑰 vs 應用程式金鑰
這頁的「API 金鑰」是個人金鑰,歸屬你的帳號、沿用你的權限。若要給第三方服務使用、且想限制只能存取特定群組的資源,請改由管理員建立應用程式 API 金鑰(不具管理員權限、帶群組白名單)。
妥善保管金鑰
API 金鑰等同於帳號憑證,請勿外流或寫死在公開的程式碼中。若疑似外洩,請立即停用或刪除該金鑰。
API 金鑰清單¶
點右上角頭像選單的「API 金鑰」,或在帳戶頁切到「API 金鑰」分頁。

清單欄位:
| 欄位 | 說明 |
|---|---|
| 名稱 | 金鑰名稱,點擊可進入詳細頁。 |
| 描述 | 金鑰用途說明。 |
| 狀態 | 金鑰目前是否啟用。 |
| 最後更新 | 最後一次更新時間,可點欄位標題排序。 |
右上角的 +()為「建立」,重新整理()圖示會重新載入清單。每一列的「⋮」()選單提供「編輯」與「刪除」。
建立 API 金鑰¶
- 在「API 金鑰」分頁點右上角的 +(,建立)。
- 填入「名稱」。
- 視需要填寫「描述」。
- 點儲存。

完整欄位說明¶
| 欄位 | 必填 | 預設 | 說明 |
|---|---|---|---|
| 名稱 | 是 | 無 | 金鑰的識別名稱,僅能使用英文字母、數字、- 與 _。 |
| 描述 | 否 | 無 | 金鑰用途的說明文字。 |
建立後會進入該金鑰的詳細頁,可在此複製金鑰值(見下方)。
詳細頁與取得金鑰值¶
在清單點金鑰名稱進入詳細頁,顯示 ID、名稱、描述、啟用、API 金鑰(金鑰值)、狀態與最後更新時間。

「API 金鑰」欄位即實際的金鑰值,以遮罩呈現,點旁邊的 複製鈕即可複製到你的應用程式使用。「ID」欄位旁也有一個 複製鈕,可單獨複製金鑰 ID。
詳細頁右上角提供 「編輯」與 「刪除」,標題旁另有 我的最愛、卡片可用 收合(見通用介面元件)。
編輯與停用¶
在詳細頁點「編輯」可修改:
| 欄位 | 必填 | 說明 |
|---|---|---|
| 名稱 | 是 | 金鑰名稱。 |
| 描述 | 否 | 用途說明。 |
| 啟用 | 否 | 關閉即停用金鑰,使用該金鑰的請求將無法通過驗證;可再次開啟恢復。 |
若不再需要某把金鑰,可用「⋮」()選單或詳細頁的「刪除」永久移除。
下一步¶
- 回到 帳戶概覽 查看其他帳戶設定。