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 调用。请在删除前确保所有业务已完成密钥替换和备份。