删除打点信息
更新时间:2022-09-02 18:08:07
接口描述
1、通过视频id删除单个视频的打点信息
2、接口支持https协议
接口URL
http://api.polyv.net/v2/video/delete-chapter-marker
请求方式
POST
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
请求参数描述
| 参数名 | 必选 | 类型 | 说明 |
|---|---|---|---|
| userid | true | String | 保利威点播账户id,可以参考【获取密钥】获取,获取路径:官网->登录->点播(API接口) |
| ptime | true | Long | 当前时间的毫秒级时间戳,3分钟内有效 |
| sign | true | String | 签名,为40位大写的SHA1值,生成签名的secretkey密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】 |
| vid | true | String | 视频id |
| timePoints | false | String | 时间点,单位:秒,多个以英文逗号分隔,如"1,2", 如果不传则删除视频的所有打点信息 |
示例
http://api.polyv.net/v2/video/delete-chapter-marker
表单参数:
vid=1b448be32368e6eb106c31d490c19144_1&sign=37AA7C42A72617593FEE2F5F77F5B6B8325FDDD1&userid=1b448be323&ptime=1620273484026&timePoints=10
响应参数描述
| 参数名 | 类型 | 说明 |
|---|---|---|
| code | Integer | 响应状态码,200为成功返回,非200为失败【详见全局错误说明】 |
| status | String | 响应状态文本信息 |
| message | String | 响应描述信息,当code为400或者500的时候,辅助描述错误原因 |
| data | String | 响应成功时返回success,响应失败为空 |
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 testDeleteChapterMaker() throws Exception, NoSuchAlgorithmException {
//公共参数,填写自己的实际参数
String secretKey = super.secretKey;
String userId = super.userId;
String ptime = String.valueOf(System.currentTimeMillis());
//业务参数
String url = "http://api.polyv.net/v2/video/delete-chapter-marker";
String vid = "1b448be32368e6eb106c31d490c19144_1";
String timePoints = "10";
Map<String, String> requestMap = new HashMap<>();
requestMap.put("userid", userId);
requestMap.put("ptime", ptime);
requestMap.put("vid", vid);
requestMap.put("timePoints", timePoints);
requestMap.put("sign", VodSignUtil.getSign(requestMap, secretKey));
String response = HttpUtil.postFormBody(url, requestMap);
log.debug("测试删除打点信息,{}", response);
//do somethings
}
响应示例
系统全局错误说明详见全局错误说明
成功示例
{
"code": 200,
"status": "success",
"message": "success",
"data": "success"
}
异常示例
{
"code": 400,
"status": "error",
"message": "the sign is not right.",
"data": ""
}
