设置打点信息

接口描述

1、通过视频id设置单个视频的打点信息
2、接口URL中的{userid}为点播账号userid，具体参考菜单【使用须知】->【获取密钥】
3、接口仅userid、ptime、vid参与签名，其他参数不参与签名
4、接口支持https协议

接口URL

http://api.polyv.net/v2/video/{userid}/saveKeyFrame

在线API调用

请求方式

POST

接口约束

1、接口同时支持HTTP 、HTTPS ，建议使用HTTPS 确保接口安全，接口调用有频率限制，详细请查看

2、请求参数 seconds（打点秒数）必须要小于视频时长

3、请求参数 dess（打点描述）的个数必须要和 seconds（打点秒数）的个数相同

请求参数描述

参数名	必选	类型	说明
userid	true	String	保利威点播账户id，可以参考【获取密钥】获取，获取路径：官网->登录->点播（API接口）
ptime	true	Long	当前时间的毫秒级时间戳，3分钟内有效
sign	true	String	签名，为40位大写的SHA1值,生成签名的secretkey密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】
vid	true	String	视频id
desc	true	String	打点描述，如果上传多个打点，请用英文逗号","隔开
seconds	true	String	打点秒数，如果上传多个打点，请用英文逗号","隔开
btnsettingswitch	false	String	打点按钮设置开关，不传表示关闭 Y：为开启 N：为关闭
btndesc	false	String	按钮描述，按钮开关开启时必填
btnhref	false	String	按钮跳转地址，按钮开关开启时必填

示例

http://api.polyv.net/v2/video/1b448be323/saveKeyFrame

表单参数：

vid=1b448be323a6a1a6c0c237856f555e88_1&seconds=10,20&btnsettingswitch=Y&btnhref=https://baidu.com&sign=D4F867827C100835254100FF147B1095DA29BB72&btndesc=测试打点按钮&userid=1b448be323&ptime=1617258980678&desc=测试打点10s,测试打点20s

响应参数描述

参数名	类型	说明
code	Integer	响应状态码，200为成功返回，非200为失败【详见全局错误说明】
status	String	响应状态文本信息
message	String	响应描述信息，当code为400或者500的时候，辅助描述错误原因
data	String	请求成功时返回设置成功信息

Java请求示例

快速接入基础代码请下载相关依赖源码， 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 VodSignUtil.java 都包含在下载文件中。

强烈建议您使用点播Java SDK完成API的功能对接，点播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。

private static final Logger log = LoggerFactory.getLogger(VodChapterMakerTest.class);
/**
 * 设置打点信息
 * @throws Exception
 * @throws NoSuchAlgorithmException
 */
@Test
public void testAddChapterMarker() throws Exception, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String secretKey = super.secretKey;
    String userId = super.userId;
    String ptime = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = String.format("http://api.polyv.net/v2/video/%s/saveKeyFrame", userId);
    String vid = "1b448be323a6a1a6c0c237856f555e88_1";
    String desc = "测试打点10s,测试打点20s";
    String seconds = "10,20";
    String btnsettingswitch = "Y";
    String btndesc = "测试打点按钮";
    String btnhref = "https://baidu.com";
    
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("userid", userId);
    requestMap.put("ptime", ptime);
    requestMap.put("vid", vid);
    requestMap.put("desc", desc);
    requestMap.put("seconds", seconds);
    requestMap.put("btnsettingswitch", btnsettingswitch);
    requestMap.put("btndesc", btndesc);
    requestMap.put("btnhref", btnhref);
    
    //系统只部分参数进行签名
    Map<String, String> signMap = new HashMap<>();
    signMap.put("userid", userId);
    signMap.put("ptime", ptime);
    signMap.put("vid", vid);
    requestMap.put("sign", VodSignUtil.getSign(signMap, secretKey));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.debug("测试设置打点信息,{}", response);
    //do somethings
    
}

响应示例

系统全局错误说明详见全局错误说明

成功示例

{
    "code": 200,
    "status": "success",
    "message": "success",
    "data": "the key frame add successfully"
}

异常示例

{
    "code": 400,
    "status": "error",
    "message": "the sign is not right.",
    "data": ""
}