跳到主要内容

获取环境 API Key

创建好第一个环境后,您需要为每一位用户(员工、客户、租户)分配独立隔离的云开发环境,并为其签发环境访问凭证。

云开发提供 API Key 作为环境访问凭证:API Key 由云开发平台绑定到指定的环境 ID,在服务端强制校验,即使泄露也只能访问该用户自己的环境,无法横向访问其他用户的数据。API Key 是平台集成场景下唯一推荐的环境访问方式

接入总览

整个平台集成接入分为三步:

  1. 创建环境:通过 API 为每个用户创建专属环境,详见 开通并创建第一个环境
  2. 获取环境 API Key:为每个环境签发 API Key 并下发给用户(本文)
  3. 使用 API Key 对接环境:用户将 API Key 配置到 Agent 工具中,即可操作自己的环境,详见 使用 API Key 对接环境

创建 API Key

通过 API 创建

调用腾讯云 CreateApiKey 接口,为用户环境创建 api_key 类型密钥:

// 示例:为用户环境创建 API Key
const result = await tcbClient.CreateApiKey({
EnvId: userEnvId, // 用户的云开发环境 ID
KeyType: "api_key", // 服务端管理员级密钥
KeyName: `user-${userId}`,
// ExpireIn: 7776000 // 可选:有效期(秒),不填则不过期
});
// result.ApiKey 为密钥明文,仅返回一次,请妥善保存

控制台手动创建

也可在控制台手动创建:云开发控制台 → 环境 → API Key 管理

下发给用户

平台通过自有渠道(站内信、邮件等)将 CLOUDBASE_ENV_IDCLOUDBASE_API_KEY 分配给对应的用户。用户在 Agent 工具的 MCP 配置中填入环境 ID + API Key,即可直接操作自己的云开发环境,无需任何额外登录流程。

安全注意事项

安全提示

api_key 拥有该环境的完整管理员权限。可通过安全渠道供用户配置本地 MCP,或仅保存在平台服务端;不得写入业务前端、浏览器可执行代码、应用代码仓库或公开渠道。建议定期轮换,单环境最多创建 5 个。

下一步

获取 API Key 后,即可将环境接入您的 Agent 平台:

使用 API Key 对接环境