API Key

簡介

功能簡介

API Key，即 API 密鑰，是賦予某種形式的祕密令牌的名稱，與 Web 服務（或類似的）請求一起送出以辨識請求的來源。密鑰可以包含在請求內容的某個摘要中，以進一步驗證來源並防止篡改這些值。

使用場景

如在配置前端事件調用部分外掛時，需要開啟 API 功能後，才能成功配置使用外掛。

預期效果

以自動取得流程狀態外掛配置中，需要配置 Jodoo API 後才能開啟外掛為例。如下所示：

設定步驟

設定入口

在「開放平台 > 密鑰管理」處，選擇「API Key」，即可對 API Key 進行建立、設定等操作。

建立 API

1. 點擊「建立 API Key」，在 API 列表中系統會自動建立出成一條 API Key。如下所示：

附註：

1. 一個帳戶最多建立 500 個 API Key。

2. 系統自動生成的 API Key 資料不可修改。

2. API Key 預設隱藏不顯示，點擊旁邊的小眼睛圖標即可顯示 API Key 全部內容。

修改 API 名稱

API Key 生成後，點擊生成的 API Key 所在行，進入 API Key 資訊詳情頁面，在「名稱」處，可以修改 API 名稱，以便區分多個 API。

授權範圍

點擊 API Key 所在行，進入 API Key 資訊詳情頁面，可對「應用授權範圍」和「API 授權範圍」進行設定。如下所示：

1. 應用授權範圍

應用授權範圍支援「全部應用」和「部分應用」兩種範圍：

2. API 授權範圍

API授權範圍支援「全部 API」和「部分 API」兩種範圍：

IP 白名單

設定 IP 白名單後，只有來自白名單範圍內的 IP 地址的請求才會被正常處理，不在白名單內的 IP 地址的請求不會成功。

點擊 API Key 所在列，進入 API Key 資訊詳情頁面，在「IP 白名單」處，點擊「新增 IP」。如下所示：

在 IP 白名單內，支援設定單個 IP 地址或 IP 地址段。設定 IP 地址段時僅支援帶一個 * 號通配符的 IP 格式。如下所示：

附註：

1. 若未設定任何白名單，則任何 IP 均可使用對應的 API Key。

2. 若未設定任何白名單的情況下，所有外掛都可調用該 API Key；若已設定了白名單時，所有外掛都不可調用該 API Key。

3. 不對企業內所有 IP 總數量設定上限，而是對每個 API Key 內的白名單 IP 數量設定上限。每個 API Key 內的白名單 IP 數量上限為 50 個。

4. IP 白名單內，暫不支援 IPV6 地址。

停用/啟用

在「狀態」處，透過關閉/開啟狀態開關，對於已經建立的密鑰可以進行停用，停用的密鑰也可以重新開啟使用。

複製

1. 複製密鑰值

在 API Key 的密鑰值處，點擊複製圖標，即可快捷複製密鑰值後並進行應用。如下所示：

2. 複製整條 API Key

在 API Key 的操作處，點擊複製圖標，即可複製整條 API Key。複製後，API Key 的授權範圍和 IP 白名單會同步複製，但複製後的 API Key 會生成新的密鑰值。如下所示：

刪除

對於不需要使用的 API Key 可以進行刪除。由於 API Key 的重要性，也可以透過刪除再新建的方式進行 API Key 的定期更換。

附註：

刪除前請確認該 API Key 沒有被使用。