跳到主要內容 跳至補充內容

管理 API 金鑰

API 金鑰是用於驗證的唯一識別碼,允許使用者、開發人員或程式安全存取 API。這對於追蹤和控制 API 使用十分重要,有助於防止濫用並確保安全通訊。

使用 API 金鑰連線至 Qlik Cloud API

您可以使用 API 金鑰與 qlik.dev 上的 REST API 參考互動。可以使用 Postman 或 qlik-cli 等工具進行 API 存取。如需更多資訊,請參閱 Qlik API 概述qlik-cli

範例:使用 Postman 連線至 Qlik API

請執行下列動作:

  1. 啟動 Postman

  2. 將 HTTP 方法設為 GET

  3. 輸入 Qlik Cloud API 端點的 URL。

    例如,若要列出租用戶中的所有空間:

    https://your-tenant.eu.qlikcloud.com/api/v1/spaces

  4. 驗證索引標籤,選擇持有人 Token 作為驗證類型

  5. Token 欄位中輸入 API 金鑰。

  6. 按一下傳送

如果請求成功,API 將傳回 JSON 回應。在此範例中,回應將包含空間清單。

啟用租用戶中的 API 金鑰

依照預設,已停用 API 金鑰產生。租用戶管理員必須在租用戶中啟用 API 金鑰,以允許使用者產生。

請執行下列動作:

  1. 管理 活動中心內,前往設定
  2. API 金鑰之下,選取啟用 API 金鑰
  3. 根據需要調整下列設定:

    • 變更 Token 到期上限:修改新產生之 Token 的到期。現有 API 金鑰將會保留原始到期值。此值沒有上限。

    • 變更每個使用者的作用中 API 金鑰上限:此限制只適用於新的 API 金鑰。若達到限制,將會拒絕建立其他 API 金鑰。您可以設定的最大值是 1000。
    資訊備註您可能需要重新整理瀏覽器,以在使用者設定檔頁面查看 API 金鑰區段中反映的變更。
  4. 若要開始產生 API 金鑰,按一下產生新的。您將重新導向至使用者設定檔的 API 金鑰區段。

產生和管理 API 金鑰

產生 API 金鑰

若要產生新的 API 金鑰,您必須有開發人員角色。租用戶管理員可以向使用者指派此角色。

請執行下列動作:

  1. 按一下使用者設定檔圖示並選取設定檔設定

  2. 前往 API 金鑰區段,並按一下產生新的金鑰

  3. 為 API 金鑰提供描述並設定到期時間。

  4. 按一下產生以建立金鑰。

  5. 複製產生的 API 金鑰並安全儲存。請注意,之後無法擷取金鑰。

編輯 API 金鑰

您可以在建立後變更 API 金鑰的名稱。

刪除 API 金鑰

資訊備註刪除 API 金鑰是永久性且無法復原。請確保此動作不會中斷任何進行中且依賴於此的流程或整合。

請執行下列動作:

  1. 按一下使用者設定檔圖示並選取設定檔設定

  2. 前往 API 金鑰區段。

  3. 在您要刪除的 API 金鑰旁按一下 更多 並選取刪除

  4. 若要移除所有金鑰,按一下金鑰清單上方的全部刪除

監控並撤銷 API 金鑰

管理 活動中心的 API 金鑰區段中,您可以檢視與租用戶相關的所有 API 金鑰。您可以依名稱、ID 或擁有者搜尋金鑰。

API 金鑰狀態

API 金鑰可以有下列狀態:

  • 作用中API 金鑰目前正在使用中。
  • 已過期:已達到期日期。
  • 已撤銷:已撤銷 API 金鑰並且無法再使用。

撤銷 API 金鑰

作為租用戶管理員,為了維護安全性,主動監控 API 金鑰活動很重要。如偵測到可疑活動,您可以撤銷 API 金鑰。

資訊備註撤銷 API 金鑰會立即停用 API 金鑰,影響任何進行中且依賴於此的流程或整合。撤銷無法復原;無法重新啟用已撤銷的 API 金鑰。

請執行下列動作:

  1. 管理 活動中心,前往事件

  2. 查看任何可疑活動,例如過度使用特定 API 金鑰。

  3. 按一下事件旁的 向下箭頭,以展開詳細資訊並複製 API 金鑰 ID。

  4. 前往 API 金鑰區段並使用其 ID 搜尋 API 金鑰。

  5. 按一下金鑰旁的 更多 並選取撤銷。您只能撤銷狀態為作用中的金鑰。

  6. 若要撤銷多個 API 金鑰,在表格中選取並按一下右上角的撤銷

API 金鑰管理的最佳做法

  • 保持金鑰機密性:安全儲存 API 金鑰並避免將其暴露在公用程式碼存放庫。

  • 定期重新產生:定期重新產生 API 金鑰以增強安全性。

  • 監控使用情況:定期檢查 API 金鑰活動以識別任何可疑行為。

此頁面是否對您有幫助?

若您發現此頁面或其內容有任何問題——錯字、遺漏步驟或技術錯誤——請告知我們可以如何改善!