接口URL
https://api.polyv.net/v2/video/engagement/{userid}/get
接口说明
(接口调用有频率限制，详细请查看)
- 该接口可查看某一观众累计观看某一视频的完成度情况。无论观众使用哪种终端、分多少次观看，接口返回的是最终的汇总的完成度。比如，视频A时长为50分钟，观众使用PC H5观看了第0~20分钟，使用手机H5观看了第10~30分钟，又使用APP观看了第40~50分钟，累计观看时长为20+20+10=50分钟，但观看的视频内容是 0~30 和 40~50 的部分。虽然累计观看时长与视频时长相同，但完成度为 (30+10)/50=80%。
- 数据隔天更新一次
- 该接口需联系客服开通后才能使用
返回结果支持格式
JSON
请求方式
GET
请求参数
| 参数名 | 必选 | 类型及范围 | 说明 |
|---|---|---|---|
| userid | true | string | 用户id，路径参数 |
| ptime | true | string | 当前13位毫秒级时间戳，3分钟内有效 |
| sign | true | string | 签名，40位大写的sha1值 |
| vid | true | string | 视频vid |
| viewerId | true | string | 自定义观众id |
返回结果
{
"code": 200,
"status": "success",
"message": "success",
"data": 0.71
}
失败返回json(不带jsonp)
{
"code": 400,
"status": "error",
"message": "ptime is too old.",
"data": ""
}
字段描述
| 字段名称 | 描述 |
|---|---|
| data | 已完成进度比例 |
响应说明
| 错误代码 | message | 说明 |
|---|---|---|
| 400 | sign can not be empty. | 加密串为空 |
| 400 | vid invalid. | 视频vid错误 |
| 400 | ptime is too old. | 时间戳过期 |
| 400 | ptime is illegal. | 时间戳参数格式不对或者超过当前时间3分钟 |
| 400 | Could not find user by userid. | userid不存在 |
| 400 | the sign is not right. | 加密串不正确 |
| 400 | video not found | 视频不存在 |
| 400 | permission limit | 没有权限访问api |
PHP请求示例
<?php
header("Content-type: text/html; charset=utf-8");
$userid="用户id";
$secretkey="用户$secretkey";
$params = array(
'ptime' => time()*1000,
'vid' => '视频vid',
'viewerId' => '学员id'
);
# 创建排序后的字典
foreach ($params as $key=>$value){
$arr[$key] = $key;
}
sort($arr);
$str='';
$length=count($arr);
foreach ($arr as $k => $v) {
$str = $str.$v.'='.$params[$v];
if($k < $length-1) {
$str = $str.'&';
}
}
$hash=strtoupper(sha1($str.$secretkey));
$params['sign']=$hash;
$url="http://api.polyv.net/v2/video/engagement/${userid}/get?".http_build_query($params);
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$output = curl_exec($ch);
curl_close($ch);
//打印获得的数据
print_r($output);
?>
签名规则：
将非空的请求参数按照参数名字典顺序排列，连接参数名与参数值,并在尾部加上secretkey，生成40位大写SHA1值，作为sign。 以下是示例过程：
1、请求参数为
ptime = "1492591990000"
vid = "382839019131be68715e9455f8d0971a_3"
format = "json"
2、将请求参数按照参数名字典顺序排列
format = "json"
ptime = "1492591990000"
vid = "382839019131be68715e9455f8d0971a_3"
3、连接字符串
连接参数名与参数值,并在尾部加上secretkey（secretkey的值为tIQp4ATe9Z），如下：
format=json&ptime=1492591990000&vid=382839019131be68715e9455f8d0971a_3tIQp4ATe9Z
4、生成签名sign
50BF9B165630A8047EB1D17D95A469CC51FF754E
Loading...