API 密钥

最新更新:2023-03-07

用 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