# 管理 API 金鑰

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

[Managing API keys in Qlik Cloud](https://play.vidyard.com/FY9N3NwFQKALEcSBp3Bxy6)

## 使用 API 金鑰連線至 Qlik Cloud API

您可以使用 API 金鑰與 Qlik REST API 參考互動。可以使用 Postman 或 qlik-cli 等工具進行 API 存取。如需更多資訊，請參閱 [Qlik API 概述](https://qlik.dev/apis)和 [qlik-cli](https://qlik.dev/toolkits/qlik-cli)。

資訊備註

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

範例：使用 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. 在 APIToken欄位中輸入 金鑰。

6. 按一下傳送。

如果請求成功，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 金鑰旁按一下 the 刪除 icon 並選取。

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

## 監控並撤銷 API 金鑰

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

### API 金鑰狀態

API 金鑰可以有下列狀態：

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

### 撤銷 API 金鑰

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

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

請執行下列動作：

1. 在 管理 活動中心，前往事件。

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

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

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

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

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

### API 金鑰管理的最佳做法

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

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

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