API 密鑰
通過調用 EngageLab 提供的短信發送 API，您可以實現自動化短信下發，無需在平台頁面手動操作。API 密鑰管理頁面支持密鑰的統一創建、查看和刪除，便於開發者高效、安全地集成和管理短信服務。
安全提醒：
API 密鑰擁有調用 SMS 服務接口的權限，請妥善保管，不要洩露給第三方。
創建 API 密鑰
在使用 EngageLab SMS API 發送短信前，需先創建 API Basic 鑒權密鑰。
點擊頁面右上角“創建 API 密鑰”按鈕，進入密鑰創建頁面，依次填寫以下信息：
- API 密鑰描述
自定義密鑰用途說明，便於後續區分和管理，僅作備註使用。 - 有效日期（選填）
設置密鑰的有效截止日期，到期後自動失效。不填寫則為永久有效。 - IP 白名單（選填）
限定可使用該密鑰的 IP 地址，建議生產環境配置，提升安全性。多個 IP 用英文逗號分隔，留空則不校驗 IP。
填寫完成後，點擊“確認”按鈕，系統將自動生成 DevKey 和 DevSecret，並展示在密鑰列表中。
API 密鑰列表
篩選區域
- 模糊搜索：支持按密鑰描述或 DevKey 關鍵字快速搜索。
- 表頭篩選：可按密鑰狀態下拉篩選。
- 時間篩選：支持按密鑰到期時間篩選。
- 組合篩選：多條件組合，實時展示篩選結果。
字段說明
| 字段 | 說明 |
|---|---|
| 描述 | 對用戶自定義的密鑰用途說明，便於區分管理。 |
| DevKey | 密鑰的唯一標識。用於 API 調用時鑒權。 |
| DevSecret | 密鑰密文，默認隱藏，hover 時可點擊顯示明文及複製。 |
| 創建日期 | 密鑰創建的時間。 |
| 到期日期 | 密鑰有效截止時間，可編輯。 |
| 狀態 | 當前密鑰狀態，包括“啟用”與“禁用”，hover 顯示切換按鈕，支持一鍵切換。 |
| 操作 | 包含“編輯”“刪除”按鈕，刪除操作需二次確認。 |
- DevSecret 顯示/隱藏
默認以星號隱藏，hover 時可顯示明文或複製內容，提升安全性。 - 狀態切換
狀態為開關按鈕，hover 顯示“開/關”，點擊切換啟用/禁用，禁用需二次確認，防止誤操作。注意：：密鑰狀態切換後，需在所有業務系統中同步更新，避免因狀態不一致導致的調用錯誤。
查看密鑰詳情
點擊密鑰列表的任意一行，可進入密鑰詳情頁面，查看完整配置信息及操作日誌。
編輯 API 密鑰
點擊“編輯”按鈕進入密鑰編輯頁面，支持修改密鑰描述、有效期、IP 白名單及重置 DevSecret。
- 重置 DevSecret
在編輯彈窗內點擊“重置”，彈出二次確認，確認後系統自動生成新 DevSecret。
重置後原 DevSecret 立即失效，請及時同步更新到所有業務系統中。
刪除密鑰
如需刪除某個密鑰，點擊“刪除”按鈕並二次確認即可完成刪除。
刪除後，該密鑰將無法用於任何 API 調用。請在刪除前確保所有業務已完成密鑰替換和備份。
