跳到主要内容

创建与管理密钥

本文介绍如何在 AMMDS 系统管理后台开启开放 API、创建与管理 API Key，以及调用接口时的鉴权方式。

前置条件​

系统配置

在调用开放 API 之前，需要完成以下配置：

  1. 登录 AMMDS 系统管理后台
  2. 进入 系统管理 → 系统配置
  3. 找到 开放API 配置项，将其开启
  4. 保存配置并重启服务（如需）

创建 API Key​

创建API Key

  1. 在系统管理后台，进入 系统管理 → 密钥管理 页面
  2. 点击 创建密钥 按钮
  3. 填写密钥名称（如"自动化脚本"、"第三方集成"等），方便区分用途
  4. 类型选择：X-API-Key （推荐）
  5. 点击确认生成密钥
  6. 复制并妥善保存生成的密钥（页面关闭后将无法再次查看完整密钥）

使用 API Key​

在调用需要鉴权的接口时，将 API Key 放在请求头中：

x-api-key: your-api-key-here

查看API文档​

查看API文档

  1. 在系统管理后台，进入 系统管理 → 密钥管理 页面
  2. 点击 接口文档 按钮，即可查看 API 文档。

安全建议​

  • 妥善保管：API Key 拥有完整的接口调用权限，请勿泄露给不相关的人员
  • 定期轮换：建议定期更新 API Key，降低泄露风险
  • 最小化使用：仅在需要的场景和环境中使用 API Key
  • 环境隔离：开发环境和生产环境建议使用不同的 API Key

常见问题​

Q: API Key 丢失了怎么办？

A: 可以在后台管理页面删除旧密钥并重新创建新的 API Key。

Q: 调用接口返回 401 错误？

A: 请检查：① GLOBAL_OPEN_API 是否已开启；② 请求头中是否正确携带了 x-api-key；③ API Key 是否有效且未过期。

Q: 哪些接口不需要 API Key？

A: /api/v1/health 相关接口为公开接口，无需鉴权即可访问。