有奖捉虫:办公协同&微信生态&物联网文档专题 HOT
本文档主要描述腾讯云智能数智人 aPaas 平台接口调用方式,包括权限、公共参数、签名要求等。

一、接口调用环境

正式环境:https://gw.tvs.qq.com

二、权限申请及开通

视频生成 apass 接口使用权限可以通过 资产领用 页面领用,领用后即可开通15天试用权限。

三、请求公共参数及签名方法

公共参数

在调用 aPaas 任一接口时,都需在 URL 中以 QueryString 形式携带以下公共参数:
参数
类型
必须
说明
appkey
string
填写申请权限通过后得到的appkey
timestamp
string
请求时间戳,单位:秒。时间戳需要和当前时间的差异不过能超过五分钟,否则会鉴权失败。
signature
string
请求签名(参考下文 签名方法

签名方法

请求参数签名步骤如下:
1. signature 签名规则如下,这里以下为例说明(示例仅供参考)
appkey = e38267c0e86411ebb02aed82acb0ed99
accesstoken = f68f2d10ae9e4604b76fb05cf46bccec
域名路由 = https://gw.tvs.qq.com/v2/ivh/videomaker/broadcastservice/videomake
2. 对除 signature 之外的所有参数按字典序进行排序,作为签名原文, 目前仅有 appkey 和 timestamp 两个参数,因此排序拼接后的字符串示例为:
appkey=e38267c0e86411ebb02aed82acb0ed99&timestamp=1646636485
3. 对签名原文使用 accesstoken 进行 HmacSha256 加密,之后再进行 base64 编码。
hashBytes = HmacSha256("appkey=e38267c0e86411ebb02aed82acb0ed99&timestamp=1646636485","f68f2d10ae9e4604b76fb05cf46bccec")
signature = Base64Encode(hashBytes)
4. 得到 signature 签名值为:
BfWuaC9kmaicCggXc693uK+sZQ8qe88O4HVQNTdwZuo=
5. 将 signature 值进行 urlencode(必须进行 URL 编码,否则将导致鉴权失败偶现 )后拼接得到最终请求 URL 为:
https://gw.tvs.qq.com/v2/ivh/videomaker/broadcastservice/videomake?appkey=e38267c0e86411ebb02aed82acb0ed99&timestamp=1646636485&signature=BfWuaC9kmaicCggXc693uK%2BsZQ8qe88O4HVQNTdwZuo%3D

四、请求及响应结构

请求体结构
请求体分为Header 和 Palyload 两个参数,在 Header 中可以携带 RequestID 用于标识唯一的一次请求,用于系统联合定位问题。业务参数均放在 Payload 中,各产品接口文档分册中每个接口的入参请放到 Payload 中传递。
{
"Header": {
"RequestID": "",
},
"Payload": {}
}
响应体结构
响应体分为 Header 和 Payload 两个参数,Header 中包含结果码、消息、以及请求唯一 ID,请求唯一 ID 与请求体中传入的值相同。接口具体的返回参数将放置在Payload 中。
{
"Header": {
"Code": 0,
"Message": "",
"RequestID": "", // 如果请求时未填写,由云端生成返回
},
"Payload": {}
}