管理 API 金鑰 | Qlik Cloud 說明
跳到主要內容 跳至補充內容

管理 API 金鑰

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

video thumbnail

使用 API 金鑰連線至 Qlik Cloud API

您可以使用 API 金鑰與 Qlik REST API 參考互動。諸如 Postman 或 qlik-cli 等工具可用於 API 存取。如需詳細資訊,請參閱 Qlik API 概觀qlik-cli

資訊備註

API 憑證提供對 Qlik Cloud 的直接程式設計存取,且不限於使用者介面中可用的工作流程。請使用最低權限原則來指派角色與 OAuth 範圍。處理服務帳戶與 API 憑證時,應採取與管理員憑證相同等級的謹慎態度。如需詳細資訊,請參閱 API 存取控制與信任邊界

範例:使用 Postman 連線至 Qlik API

請執行下列動作:

  1. 啟動 Postman

  2. 將 HTTP 方法設定為 GET

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

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

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

  4. Auth 索引標籤上,選擇 Bearer Token 作為 Auth Type

  5. 將您的 API 金鑰輸入至 Token 欄位

  6. 按一下 Send

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

設定 API 金鑰設定

請執行下列動作:

  1. 管理 活動中心,前往 設定 頁面。

  2. 選取 功能控制 索引標籤。
  3. API 金鑰 區段中,視需要調整下列設定:

    • 變更最大 Token 到期時間:設定新產生之 API Token 的到期期間。現有的 API 金鑰將保留其原始到期值。此值沒有上限。

    • 變更每位使用者的最大作用中 API 金鑰數:設定使用者可擁有的 API 金鑰數量限制。此限制僅適用於新金鑰。如果達到限制,使用者將無法建立額外的金鑰。最大值為 1000。

您可能需要重新整理瀏覽器,才能在個人設定頁面的 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 金鑰無法重新啟用。

請執行下列動作:

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

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

  3. 按一下事件旁邊的 向下箭頭 以展開其詳細資料,然後複製 API 金鑰 ID。

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

  5. 按一下金鑰旁邊的 更多,然後選取 撤銷。您只能撤銷狀態為「作用中」的金鑰。

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

API 金鑰管理的最佳實務

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

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

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

此頁面是否對您有幫助?

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