跳轉到
版本 v1.0.25

API 金鑰

這頁能幫你做什麼

帳戶頁的「API 金鑰」分頁讓你建立與管理 API 金鑰,用於以程式方式呼叫平台時驗證身分。金鑰歸屬於你的帳號,沿用你的權限。

個人金鑰 vs 應用程式金鑰

這頁的「API 金鑰」是個人金鑰,歸屬你的帳號、沿用你的權限。若要給第三方服務使用、且想限制只能存取特定群組的資源,請改由管理員建立應用程式 API 金鑰(不具管理員權限、帶群組白名單)。

妥善保管金鑰

API 金鑰等同於帳號憑證,請勿外流或寫死在公開的程式碼中。若疑似外洩,請立即停用或刪除該金鑰。

API 金鑰清單

先從側邊欄最底部的頭像選單點「帳戶」進入帳戶頁,再切到「API 金鑰」分頁(頭像選單本身沒有「API 金鑰」這一項)。

帳戶頁的「API 金鑰」分頁,上方為一般/安全/群組/API 金鑰四個分頁(目前在「API 金鑰」),下方是搜尋列與金鑰清單,底部有分頁控制

清單欄位:

欄位 說明
名稱 金鑰名稱,點擊可進入詳細頁。
描述 金鑰用途說明。
狀態 金鑰目前是否啟用。
最後更新 最後一次更新時間,可點欄位標題排序。

搜尋列右側依序是「全部」篩選、重新整理()與 +(,建立,只有圖示沒有文字)。搜尋框右側的 可切換要依「名稱」還是「描述」搜尋;「全部」下拉只有「全部」與「常用」(=只看加入我的最愛的金鑰)兩個選項,不能用來只看啟用或停用的金鑰——要挑出停用的金鑰請直接看「狀態」欄。清單底部有分頁控制(預設每頁 10 筆),完整說明見通用介面元件 — 清單頁的共用操作

還沒有任何金鑰時,畫面長得不一樣

第一次來(清單是空的)時看不到上面那張表格,畫面中央是一張空狀態卡片「新增 API 金鑰」,卡片上有一顆寫著「新增」的按鈕——這時不必去找右上角那顆只有圖示的 +,直接點卡片上的「新增」即可。

把滑鼠移到某一列上,最右側會出現「⋮」()選單,提供「編輯」與「刪除」。

建立 API 金鑰

  1. 在「API 金鑰」分頁點右上角的 +(,建立)。
  2. 填入「名稱」。
  3. 視需要填寫「描述」。
  4. 點儲存。

建立 API 金鑰表單

完整欄位說明

欄位 必填 預設 說明
名稱 金鑰的識別名稱,僅能使用英文字母、數字、-_
描述 金鑰用途的說明文字。

建立後會進入該金鑰的詳細頁,可在此複製金鑰值(見下方)。

詳細頁與取得金鑰值

在清單點金鑰名稱進入詳細頁。詳細頁只有一個「一般」分頁,「詳細資料」卡片顯示 ID、名稱、描述、啟用、API 金鑰(金鑰值)、狀態、建立者、更新者與最後更新時間。「建立者」「更新者」是操作這把金鑰的使用者;沒有對應使用者時顯示 -(例如平台自動建立的金鑰,本頁截圖就是這個狀態)。

API 金鑰詳細頁

「API 金鑰」欄位即實際的金鑰值,以遮罩呈現,點旁邊的 複製鈕即可複製到你的應用程式使用。「ID」欄位旁也有一個 複製鈕,可單獨複製金鑰 ID。

詳細頁右上角提供 「編輯」與 「刪除」,標題旁另有 我的最愛、卡片可用 收合(見通用介面元件 — 詳細頁的卡片收合)。

編輯與停用

在詳細頁點「編輯」可修改:

欄位 必填 說明
名稱 金鑰名稱。
描述 用途說明。
啟用 關閉即停用金鑰,使用該金鑰的請求將無法通過驗證;可再次開啟恢復。

若不再需要某把金鑰,可用「⋮」()選單或詳細頁的「刪除」永久移除。

拿到金鑰之後要交給誰

這把金鑰是給程式用的,平台介面上沒有任何地方可以「用」它,所以你自己在畫面上驗證不了它是不是活的。實務做法是把金鑰交給要串接的工程師(連同你替它取的名稱與用途),由他們寫進呼叫平台 API 的程式裡;金鑰要放在哪個欄位、呼叫哪個網址,請他們參考平台的 API 文件。

下一步