管理 API 金鑰
API 金鑰作為唯一識別碼以供驗證,允許使用者、開發人員或程式安全存取 API。API 金鑰通常用於追蹤和控制 API 的使用方式,以防濫用。
API 金鑰概述
在 管理 活動中心的 API 金鑰區段中,您可以檢視與租用戶相關的所有 API 金鑰。您可以依名稱、ID 或擁有者搜尋金鑰。
API 金鑰可以有下列狀態:
- 作用中:API 金鑰目前正在使用中。
- 已過期:已達到期日期。
- 已撤銷:已撤銷 API 金鑰並且無法再使用。
租用戶管理員可以啟用 API 金鑰產生,以及監控並撤銷 API 金鑰。若要產生、編輯或刪除 API 金鑰,需要開發人員角色。租用戶管理員可以將此角色指派至使用者,包括自己。
啟用租用戶中的 API 金鑰
依照預設,已停用 API 金鑰。租用戶管理員可以在租用戶內啟用 API 金鑰。
請執行下列動作:
- 在 管理 活動中心內,前往設定。
- 找到 API 金鑰區段並選取啟用 API 金鑰。
- 如有需要,調整下列設定:
變更 Token 到期上限:修改新產生之 Token 的到期。現有 API 金鑰會保留原始到期值。此值沒有上限。
資訊備註您可能需要重新整理瀏覽器,以在使用者設定檔頁面查看 API 金鑰區段中反映的此值變更。- 變更每個使用者的作用中 API 金鑰上限:此設定只會影響新的 API 金鑰。若達到限制,將會拒絕建立新的 API 金鑰。最大值是 1000。
-
若要開始產生 API 金鑰,按一下產生新的。這會將您重新導向至使用者設定檔頁面的 API 金鑰區段,您可在此建立新的金鑰。
產生 API 金鑰
您可以從設定檔產生 API 金鑰。 開始之前,請確認滿足下列要求:
-
您有作用中的授權。
- 啟用 API 金鑰在 管理 活動中心內切換為開啟。
- 您有開發人員角色。
請執行下列動作:
-
按一下右上角的使用者設定檔圖示並選取設定檔設定。
-
在 API 金鑰區段中,按一下產生新的金鑰。
-
提供 API 金鑰的描述和到期時間。
-
按一下產生以建立金鑰。
-
立即複製產生的 API 金鑰並安全儲存。之後無法擷取金鑰。
建立後,可以編輯 API 金鑰的名稱或在必要時刪除。
透過 API 金鑰,您可以使用 Postman 等工具在 qlik.dev 探索 REST API 參考,或安裝 qlik-cli 以直接從命令列存取 Qlik 功能。如需更多資訊,請參閱 Qlik API 概述和 qlik-cli。
監控並撤銷 API 金鑰
作為租用戶管理員,基於安全理由監控 API 金鑰活動很重要。如偵測到可疑活動,您可以撤銷 API 金鑰。
請記住,撤銷 API 金鑰將會立即停用,影響任何進行中且依賴於此的流程或整合。撤銷無法復原,無法重新啟用已撤銷的 API 金鑰。
請執行下列動作:
-
在 管理 活動中心內,前往事件區段。
-
查看任何可疑活動,例如過度使用特定 API 金鑰。
-
按一下事件旁的 ,以展開詳細資訊並複製 API 金鑰 ID。
-
前往 API 金鑰區段並使用其 ID 搜尋 API 金鑰。
-
按一下金鑰旁的 並選取撤銷。您只能撤銷狀態為作用中的金鑰。
-
若要撤銷多個 API 金鑰,在表格中選取並按一下右上角的撤銷。
刪除 API 金鑰
刪除 API 金鑰會從系統中永久移除。刪除 API 金鑰無法復原,將會立即移除其存取權限。請確保此動作不會中斷任何進行中且依賴於此的流程或整合。
您需要開發人員角色才能刪除 API 金鑰。
請執行下列動作:
-
按一下右上角的使用者設定檔圖示並選取設定檔設定。
-
選取 API 金鑰區段。
-
在您要刪除的 API 金鑰旁按一下 並選取刪除。
-
若您想要移除所有金鑰,按一下 API 金鑰清單上方的全部刪除。