API 金鑰

最新更新:2024-06-13

使用 EngageLab OTP API 生成驗證碼或進行驗證時,需要創建一個 API Basic鑑權金鑰,因此需在 EngageLab OTP 的「API 金鑰」頁面進行創建。

提醒:擁有 API 金鑰的人或系統將能使用您的 OTP 服務資料,請勿提供給第三方。

創建金鑰

如果您尚未創建金鑰,請點擊「立即創建」進行創建。

EngageLab API金鑰創建

依照提示資訊,依次填入 API 金鑰描述、有效日期、IP 白名單,並設置 API 權限。

  • 若不填有效日期,則默認為永久有效。
  • IP 白名單可以留空,若留空則不會校驗請求IP;配置之後,只有指定名單中的IP才允許發送 API 請求,否則系統會拒絕請求。
  • API 權限可以控制該金鑰是否支持「發送 API」 和「驗證 API」。

EngageLab API金鑰創建

創建成功後,系統將自動生成 DevKey 和 DevSecret。

EngageLab API金鑰自動生成

點擊整行數據,可以進入詳情頁面,獲取 DevKey 和 DevSecret 並複製提供給您的開發人員。

EngageLab API金鑰查看

編輯金鑰

如果需要編輯 API 金鑰,點擊「編輯」進入編輯 API 金鑰頁面。

EngageLab API金鑰編輯

可以修改金鑰描述、重置 DevSecret、修改有效期日期、IP 白名單和 API 權限。

EngageLab API金鑰編輯詳情

禁用金鑰

如果需要禁用某個金鑰,點擊「禁用」: EngageLab API金鑰禁用

此時查看 OTP 金鑰的狀態,可以看到 EngageLab OTP 應用的 API 金鑰狀態已經變為「已禁用」。 EngageLab API金鑰禁用狀態

啟用金鑰

如果需要啟用某個被禁用的 EngageLab OTP 金鑰,點擊「啟用」: EngageLab API金鑰啟用

此時查看 OTP 金鑰的狀態,可以看到 EngageLab OTP 應用

的 API 金鑰狀態已經變為「已啟用」。 EngageLab API金鑰啟用狀態

刪除金鑰

若需要刪除 EngageLab OTP 的某個金鑰,點擊「刪除」經過二次確認即可刪除。 EngageLab API金鑰刪除

在文档中心打开
Contact Sales