腾讯云 API

最近更新时间:2025-12-11 15:24:12

我的收藏
腾讯云 API 提供了通用访问腾讯云 API 的接口能力,需要先创建腾讯云 API 访问密钥,并开通对应的云产品服务,

注意事项

关联的密钥信息

创建 APIs 时需要关联对应的密钥信息,需要先在腾讯云云开发的扩展功能 > 授权管理中,新建连接,应用类型选择腾讯云 API,填写相关信息,保存,创建密钥连接信息,然后在创建 APIs 时下拉选择关联。

Path

腾讯云 API 的path,用户仅需要填写 / 即可。

参数处理

header 和签名

腾讯云云开发网关层会处理 header 参数 X-TC-TraceId、X-Cloudbase-Request-Id、X-Request-Id,以及对应的签名处理(使用v3签名,签名需要的 SecretId 和 SecretKey 就是用户创建 APIs 关联的对应类型的密钥连接信息),用户不需关注。

其他参数

ProductName:不是官方接口需要的字段,是 APIs 能力需要的必传字段,是因为各个云产品的接口 host 不一样,为了识别接口具体对应的哪个 host,例如文字识别,取值 ocr,取值腾讯云 API 的产品英文简称,比如 cvm、ocr、sms、ses 等,详见映射的产品列表
Action:见各个接口文档说明
Version:每个接口的 version 取值见各个接口文档说明
Region:有的接口文档需要,有的接口不需要,具体见各个接口文档说明
其他参数:具体见各个接口文档说明

使用示例

比如短信功能,详见查询号码信息的接口

在 APIs 详情页测试

在腾讯云 API 中单击其他方法测试


在微搭低代码测试

1. 在微搭低代码新建或进入已有的应用。
2. 在“代码区”,单击“+”,新建数据查询,选择“新建开放 APIs 查询”。

进行信息填写

async ({ params }) => {
// query 触发时传入的参数
console.log("params", params);

// 请前往【扩展功能】-【APIs连接器】选择需要调用的 userAPIsID 进行替换
const userAPIsID = 'txyAPI_mc62hgf';
const app = await $w.cloud.getCloudInstance();
const result = await app.APIs[userAPIsID].request({
method: "post", // 请求方法
path: "/", // 请求路径
body: JSON.stringify({"ProductName":"sms","Action":"DescribePhoneNumberInfo","Version":"2021-01-11","PhoneNumberSet":["+86159xxxxxxxx"],"Region":"ap-guangzhou"}), // 请求包体
});

// APIs 执行结果
return result;
}
其中,userAPISID 就是用户创建 APIs 之后获取到的 userAPIsID,

此外,method 就是 HTTP 请求方法,path 就是请求的 path,如果有 query 参数,也是在 path 上,根据想要请求的接口,填写对应的 body 参数,然后单击运行,进行测试。