接口URL
http://api.polyv.net/v2/video/{userId}/saveKeyFrame
接口说明
(接口调用有频率限制,详细请查看)
设置视频打点
返回结果支持格式
JSON
请求方式
POST,GET
请求数限制
TRUE
请求参数
参数名 | 必选 | 类型 | 说明 |
---|---|---|---|
userid | 是 | string | POLYV用户ID,http://api.polyv.net/v2/video/{userId}/saveKeyFrame中的{userid}需要替换为POLYV用户ID的值 |
vid | 是 | string | 视频的ID |
desc | 是 | string | 打点描述,如果上传多个打点用英文逗号","隔开 |
seconds | 是 | string | 打点秒数【第seconds秒】,如果上传多个打点用英文逗号","隔开 |
ptime | 是 | string | 当前时间的毫秒级时间戳(13位),3分钟内有效 |
sign | 是 | string | 签名,为40位大写的SHA1值 |
btnsettingswitch | 否 | string | 按钮设置开关,“Y”为开启, “N”为关闭,不传表示关闭 |
btndesc | 否 | string | 按钮描述,按钮开关开启时必填,关闭时btndesc不设置 |
btnhref | 否 | string | 按钮跳转地址,按钮开关开启时必填,关闭时btndesc不设置 |
注意事项
seconds(打点秒数【第seconds秒】)必须要小于视频长度;
dess(打点描述)的个数必须要和seconds的个数相同。
响应参数
参数名 | 类型 | 说明 |
---|---|---|
code | int | 成功/失败代码 |
status | string | 成功/失败状态 |
message | string | 成功/失败信息 |
data | string | 成功响应的数据 |
JSON示例
{
code: 200,
status: "success",
message: "success",
data: "the key frame add successfully"
}
php请求示例
<?php
$desc = "第1个打点,第2个打点,第3个打点";
$seconds = "6,16,26";
$userid = "8205ac89d3";
$ptime = time()*1000;
$vid = "8205ac89d3ac2b9a7e72a71d16799803_8";
$secretkey = "kXmHMLeX6M";
$str = "ptime=$ptime"."&userid=$userid"."&vid=$vid".$secretkey;
$sign = strtoupper(sha1($str));
$url = "http://api.polyv.net/v2/video/$userid/saveKeyFrame?ptime=$ptime&desc=$desc&seconds=$seconds&vid=$vid&sign=$sign&";
$content = file_get_contents($url);
echo $content;
?>
签名规则
将请求参数(userid,ptime,vid)按照参数名字典顺序排列,用“&”连接参数名与参数值,并在最后加上secretkey的值,生成40位大写的SHA1值,作为sign。
以下是示例过程:
1. 请求参数为:
userid="8205ac89d3"
ptime="1474160490000"
vid="8205ac89d39ad353f0350e5ce73a7244_8"
2. 将请求参数按照参数名字典顺序排列
ptime="1474160490000"
userid="8205ac89d3"
vid="8205ac89d39ad353f0350e5ce73a7244_8"
3. 连接字符串
连接参数名与参数值,并在首尾加上secretkey的值(本示例的值为kXmHMLeX6M),如下:
ptime=1474160490000&userid=8205ac89d3&vid=8205ac89d39ad353f0350e5ce73a7244_8kXmHMLeX6M
4. 生成签名sign
sign为40位大写的SHA1值:
6944D661A54FDF3DDCE9D94230B4EBB91ECA1026