跳到主要内容

配置文件-集成

cloudbaserc.json 中的 integrations 字段用于声明集成中心的配置（微信支付、公众号、AI 工具等）。集成中心把凭证、回调、验签等模板化逻辑沉淀在平台层，业务方只需用云函数 SDK / HTTP 调用即可。

属性值
类型Array<Integration>
说明每个元素描述一个集成的配置（keyId、authTypeCode、envVariables 等）

子字段​

字段类型必填说明
keyIdString是集成实例唯一标识，用于匹配云端已有实例；同一 envId 下唯一
nameString否集成实例名称（仅用于显示），未填写时默认使用 keyId
authTypeCodeString是集成类型代码，决定集成中心为你部署哪种云函数模板。可用 tcb integration types 命令查询
descriptionString否集成实例描述
envVariablesObject否集成相关凭证型环境变量，由集成中心托管（业务代码不要硬编码）
demoCodeFunctionNameString否要绑定的云函数名称

authTypeCode 常用取值​

取值说明
weixinpaydc微信小程序支付
weixinpaynative微信 Native 支付
weixinpayjsapi微信 JSAPI 网页支付
wechatoa微信公众号
agentmp / agentpaAI Agent（小程序 / 公众号）

envVariables 凭证字段​

（可用字段因 authTypeCode 而异）：

  • 微信支付：MCH_ID + API_KEY（或证书）
  • 公众号：APP_ID + APP_SECRET
  • 具体每个集成需要的字段以控制台为准

部分集成支持通过 authConfig 配置额外参数（公钥、回调 URL 白名单等），具体以集成中心控制台为准。

平台背景、整体能力、与传统接入的对比见 集成中心概述；最新可用 authTypeCode 与字段以 集成中心控制台 为准。

示例​

{
  "integrations": [
    {
      "keyId": "myPayment",
      "authTypeCode": "weixinpaydc",
      "envVariables": {
        "MCH_ID": "1234567890",
        "API_KEY": "your-api-key"
      }
    }
  ]
}

从文件读取字段值（@ 文件引用语法）​

部分字段（如微信支付的 privateKey、apiV3Key 等）通常是多行文本或较长的敏感内容（例如 PEM 格式私钥）。直接把它们写进 JSON 需要手动把换行符转义为 \n，既繁琐又容易出错。

CLI 支持在 envVariables 的值中使用 @ 前缀直接引用文件，创建或更新时会自动读取该文件内容作为字段值：

{
  "integrations": [
    {
      "keyId": "key-abc123",
      "authTypeCode": "weixinpaydc",
      "envVariables": {
        "appId": "wx1234567890",
        "apiV3Key": "@./secrets/apiv3key.txt",
        "privateKey": "@./secrets/apiclient_key.pem"
      }
    }
  ]
}

文件引用语法说明：

写法含义
@./certs/key.pem相对路径（相对于 cloudbaserc.json 所在目录）
@/absolute/path/key.pem绝对路径
非 @ 开头的普通字符串按字面值处理（需自行把换行符转义为 \n）

说明：

  • 读取文件内容时会自动去除 BOM 和首尾空白字符，保持 PEM 等格式整洁。
  • 若引用的文件不存在或无法读取，CLI 会报错并中止操作，请检查路径是否正确。
  • 该语法在 tcb integration create 与 tcb config update integration 中均可使用。
  • 建议将密钥文件加入 .gitignore，避免敏感凭证被提交到代码仓库。

相关命令​