1. 接口描述
接口请求域名: tcb.tencentcloudapi.com 。
用户创建集成
默认接口请求频率限制:20次/秒。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数,本接口取值:CreateUserKey。 |
| Version | 是 | String | 公共参数,本接口取值:2018-06-08。 |
| Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
| EnvId | 是 | String | 环境ID 示例值:asf2342-afds |
| Name | 否 | String | 用户创建的集成名称,或者密钥名称 示例值:集成名称1 |
| KeyID | 否 | String | 用户创建的集成ID,集成表示,或者密钥对标识,前半部分用户填写,后半部分平台按照一定规则生成 示例值:poiuas8-098asdfaf |
| Description | 否 | String | 集成描述 示例值:这是个集成描述 |
| AuthTypeCode | 否 | String | 集成类型,或者授权类型码,对应GetUserKeyTemplateList接口的AuthTypeCode字段,比如github、gitlab、gitee、meeting、PublicAccountOpenService等 示例值:github |
| Ext | 否 | String | 根据集成类型的不同,ext会有不同的子结构,具体每种授权类型的ext需要填写的信息,可以通过GetUserKeyTemplateList获取 示例值:{"a":"b"} |
| TicketID | 否 | String | github、gitlab、gitee、腾讯会议等oauth类型的,需要传这个ticket_id,创建的密钥对跟auth_ticket_token(对于github、gitlab、gitee)、weda_ticket_token(对于腾讯会议)关联起来 示例值:Zw3NdqeHfhInWHkNFq49 |
| Business | 否 | String | 业务类型,integration:从集成中心来的,默认为空,表示是从授权管理中心来的 示例值:integration |
| RuntimeConfig | 否 | AgentRuntimeConfig | 创建demo代码云函数需要的参数信息 入参限制:当Business为integration,且AuthTypeCode为(weixinmp、wxvirtualpay、weixin-store、channels、weixinpaydc)之一时必填 |
| DemoCodeFunctionName | 否 | String | 创建集成时创建关联的示例代码云函数的名称,当Business为integration,且AuthTypeCode为(weixinmp、wxvirtualpay、weixin-store、channels、weixinpaydc)之一时必填 示例值:wx-pay-04y48gfh-demo-scfweb |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| CreateResult | Integer | 创建成功记录条数 示例值:1 |
| RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 创建微信支付集成
输入示例
POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateUserKey
<公共请求参数>
{
"EnvId": "lowcode-0g2qsnk29ac7c5e8",
"Name": "wx-pay",
"KeyID": "wx-pay-zg6rmxnv3",
"AuthTypeCode": "weixinpaydc",
"Ext": "{\"notifyURLCallbackType\":\"system\",\"notifyURLPayResourceType\":\"function\",\"notifyURLRefundsResourceType\":\"function\",\"notifyURLPayURL\":\"https://wx-pay-zg6rmxnv3.integration-callback.tcloudbase.com/wechatpay/order\",\"notifyURLRefundsURL\":\"https://wx-pay-zg6rmxnv3.integration-callback.tcloudbase.com/wechatpay/refund\",\"notifyURLPayResourceName\":\"wx-pay-zg6rmxnv3-demo-scfweb\",\"notifyURLRefundsResourceName\":\"wx-pay-zg6rmxnv3-demo-scfweb\",\"type\":2,\"appId\":\"xxx\",\"merchantId\":\"xxx\",\"merchantSerialNumber\":\"xxx==vaU3a0fK1G/JUsTzLkBYHGoKpzYStJr43HGa6BG+xxx\",\"privateKey\":\"-----BEGIN PRIVATE KEY-----\\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQClXYJt6OdwTu+l\\xxxxx\\n5HC5/PxlRyoJCcxNvYcfeDYjUQwiQSOa5HWgiikBrtqH5vJcud4LUIHn52fDkGH7\\nWIVxUod8h2A1IPSR1iUPI3s=\\n-----END PRIVATE KEY-----\",\"apiV3Key\":\"vUZgkXeA7rJo6CMi3q5Psw==+39rYyVvCXD+UvmvDcGj26S6WMy+ifrKNvCWcuZrhxSOLMvxor/FI/P12REOItsN\",\"wxPayPublicKeyId\":\"PUB_KEY_ID_0113315977012026022800111946001600\",\"wxPayPublicKey\":\"-----BEGIN PUBLIC KEY-----\\nxxxLb2\\n3P2lKuOG+nBMBRgqrBGFGO+VBSJyLcu+0GXBe7h4qhyeL0mWGwSPqZE98pMKhpom\\ntwIDAQAB\\n-----END PUBLIC KEY-----\"}",
"Business": "integration",
"DemoCodeFunctionName": "wx-pay-zg6rmxnv-demo-scfweb",
"RuntimeConfig": {
"Runtime": "Nodejs18.15",
"MemorySize": 256,
"InstallDependency": true,
"Timeout": 900,
"Code": {
"CosBucketRegion": "ap-shanghai",
"TempCosObjectName": "/2026-04-23/1259548930/lowcode-0g2qsnk29ac7c5e8/wx-pay-zg6rmxnv-demo-scfweb.zip"
}
}
}
输出示例
{
"Response": {
"CreateResult": 1,
"RequestId": "9148111c-909d-42e5-a490-6e5d5869e044"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.ThirdServiceError | 请求第三方服务,第三方服务返回报错信息 |
| InternalError | 内部错误。 |
| InternalError.Database | 数据库错误。 |
| InternalError.Timeout | 服务超时。 |
| InvalidParameter | 参数格式或类型错误,如 Uin、EnvId、Domain 缺失或非法。 |
| InvalidParameter.EnvId | 环境ID非法。 |
| UnauthorizedOperation | 未授权操作。 |
| UnknownParameter | 未知参数错误。 |