更新日期
1. 简介
1.1 功能概述
密钥管理 用于创建和管理 API Key，并支持查看 API 调用日志，方便进行接口调用管理、问题排查和安全审计。
API Key 是调用开放平台接口时使用的身份标识。通过配置应用授权范围、接口授权范围和 IP 白名单，可以限制接口的访问权限和调用来源，提高接口调用安全性。
1.2 应用场景
- 第三方系统调用开放平台接口，实现数据同步与业务集成。
- 为不同业务系统分配独立 API Key，控制接口访问权限。
- 通过 IP 白名单限制接口调用来源，提升接口安全性。
- 查看接口调用记录和操作日志，辅助问题排查和安全审计。
- 通过 API Key 实现企业内部系统与英雄云平台的数据互通。
1.3 版本说明
企业版及以上版本可使用。
2. 设置入口
进入英雄云工作台首页，在左侧导航栏点击「开放平台」，随后在页面顶部菜单栏选择「密钥管理」，即可查阅相关参数说明及 API 文档。
3. 操作指南
3.1 创建 API Key
进入「开放平台 >> 密钥管理 >> API Key」，点击右上角「+ API Key」即可。创建成功后，系统会自动生成对应的 API Key，可继续配置名称、授权范围和 IP 白名单等信息。
3.2 配置 API Key
1）修改名称：点击 API Key 名称，进入配置页面，即可修改。
2）设置授权范围
在 API Key 配置页面，可根据实际需求进行以下配置：
- 应用授权范围 ：限制该 API Key 可访问的应用范围。
- 接口授权范围 ：限制该 API Key 可调用的接口范围。
- IP 白名单 ：限制允许调用 API 的来源 IP。
点击「确定」保存配置。完成后，API Key 的访问权限将按设定规则生效。
3.3 管理 API Key
在「密钥管理 >> API Key」页面，可进行以下操作：
- 复制 Key ：复制当前 API Key，用于接口调用配置。
- 启用/停用 API Key ：停用后，该 Key 将无法继续调用开放平台接口。
- 复制当前配置 ：基于当前授权配置快速创建新的 API Key。
- 删除 API Key ：删除后，相关接口调用将立即失效，请谨慎操作。
3.4 查看 API 调用日志
进入「密钥管理 >> API 调用日志」，可查看最近 API 的调用记录，包括平台日志和应用日志，包括调用时间、调用接口、IP地址、返回状态等信息，用于接口使用分析和问题排查。
4. 注意事项
- API Key 属于敏感信息，应妥善保存，避免泄露。
- 删除或修改授权范围可能导致接口调用失败。
- IP 白名单配置不当可能导致合法请求被拦截。
如需获得更多帮助，请
联系我们
微信扫码
专业客服答疑
联系电话
400-920-4330
