视频同步识别接口

1. 接口请求

1.1 接口地址

国内: http://api.video.tuputech.com/v3/recognition/video/syncscan/<secretId>
国外: http://api-us.open.tuputech.com/v3/recognition/video/syncscan/<secretId>

secretId 需替换为您的 secretId，请联系我们为您开通 secretId。

1.2 请求方法及请求头

请求方法: POST

请求头:

参数名称	类型	是否必需	说明
Content-Type	String	是	`multipart/form-data` 或 `application/json`

1.3 说明

1. 支持格式

视频大小限制：不超过 100M；

支持的格式：flv, mkv, mp4, rmvb, avi, wmv, 3gp, ts, mov, gif, m3u8, mpg/mpeg, mxf。

2. 视频截图分辨率

如果视频的分辨率的短边超过 1024，则截取的图片以 “1024/短边” 等比例截取。

例如：视频分辨率为 1920x1080，截图的尺寸为 1820x1024。

1.4 请求参数

参数名称	类型	是否必需	说明
video	String / File	是	1.支持视频链接或者上传视频文件 (上传视频文件时请求类型为 `multipart/form-data`)； 2.只支持一个 video 参数，即只能传一个视频链接或者上传一个视频文件； 3.支持常见视频格式和 gif 动图。
interval	Number	否	视频截图间隔，范围 [0.5, 60] 秒，默认 1 秒。
maxFrames	Number	否	最大截图张数（达到最大截图张数则结束截图），范围 [5, 200] 张，默认 200 张。
tag	String	否	用于给视频附加额外信息（比如：直播客户可能传房间号，或者主播 ID 信息）。方便后续根据 tag 搜索到相关的视频。只支持一个 tag 参数。
tasks	Array	否	指定本次调用要审核的任务。
timestamp	Number	是	当前的服务器的 Unix 时间戳。
nonce	Number	是	随机数。
signature	String	是	我们采用的数字证书签名算法是：`"RSA-SHA256"`，签名输出类型是：`"base64"`，具体步骤如下： 1、所有参与签名的参数为：secretId，timestamp，nonce，用英文半角逗号 “,” 相连，得到 sign_string； 2、利用您的私钥，使用算法 `"RSA-SHA256"` 签名，输出为 `"base64"` 格式，得到参数 signature 的值。点击管理公钥证书查看如何生成私钥，及如何上传您的公钥用于数字签名的认证。

1.5 请求示例

curl请求示例

curl -X POST --header 'Content-Type: multipart/form-data' \
-F 'video=@your_video_file_path_or_url' \
-F 'interval=1' \
-F 'maxFrames=5' \
-F 'timestamp=1559554003759' \
-F 'nonce=0.6157904536165131' \
-F 'signature=your_signature' \
'http://api.open.tuputech.com/v3/recognition/video/syncscan/your_secret_id'

请求体示例

{
    "video": FILE_DATA_or_URL,
    "interval": 1,
    "maxFrames": 5,
    "timestamp": 1559554003759,
    "nonce": 0.6157904536165131,
    "signature": "p0fX2xxb5JMtN0wM7WkQRsyq/aH2zk3zYYRlBAydPmuWkofb06KdSPhq4URYHaAFU/dXodfJS9x2PbZBNz084RF0NIiJvBUcK8mFeA/YliRJnGqv2x3BiNffN61nWJirALvmjbfEWwxFArAIvsV35ivuTBO/jDueWhoxEI9Y="
}

2. 接口响应

2.1 响应内容

接口返回带签名的 JSON 数据，业务数据需要用户解析 json 字段获得

参数名称	类型	说明
signature	String	我们采用的数字证书签名算法是：`"RSA-SHA256"`，签名输出类型是：`"base64"`，首先下载图普科技的公钥证书，然后按如下步骤认证： 1、收到的JSON数据经过JSON.parse()，得到JSON对象，记为data； 2、data含两个字段：signature、json；signature是数字签名，json是真正的有效数据的字符串格式； 3、用signature对json进行签名认证,算法：`RSA-SHA256`，输出类型：`base64`，得到认证结果； 4、认证通过后，对json进行JSON.parse()，得到JSON数据，详见"json"字段说明。
json	String	json 字段经过JSON.parse(json)后，得到具体的结果。

json参数

参数名称	类型	说明
[taskId]	Object	识别任务的结果。
code	Number	返回码，参考服务公共状态码解析。
message	String	返回信息。
nonce	Number	随机数。
timestamp	Number	当前的服务器的Unix时间戳。

taskId参数为接口开通的识别任务返回结果，分为图像或视频结果，可参考以下文档：

同步识别接口