查询视频播放密码

接口描述

1、通过视频id查询视频播放密码
2、接口URL中的{userid}为点播账号userid，具体参考菜单【使用须知】->【获取密钥】
3、接口支持https协议

接口URL

http://api.polyv.net/v2/video/{userid}/video-setting-page

在线API调用

请求方式

GET

接口约束

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

请求参数描述

参数名	必选	类型	说明
userid	true	String	保利威点播账户id，可以参考【获取密匙】获取，获取路径：官网->登录->点播（API接口）
ptime	true	Long	当前时间的毫秒级时间戳，3分钟内有效
sign	true	String	签名，为40位大写的SHA1值,生成签名的secretkey密钥作为通信数据安全的关键信息，严禁保存在客户端直接使用，所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则】
vids	true	String	视频id，多个用英文逗号隔开

示例

http://api.polyv.net/v2/video/1b448be323/video-setting-page?vids=1b448be323b452641878b54f21241188_1&sign=1304532D24F75B2209D2B3D7BE62722265E6D21B&userId=1b448be323&ptime=1618281315107

响应参数描述

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

data参数描述

参数名	类型	说明
questionnaire	Object	问卷调查【详见questionnaire字段说明】
isShowPassword	Boolean	是否显示密码 true：显示密码 false：不显示密码
vids	String	视频id
videoPool	Object	视频信息【详见videoPool字段说明】
qid	String	访客信息收集id

questionnaire参数描述

参数名	类型	说明
qid	String	访客信息收集id

videoPool参数描述

参数名	类型	说明
describ	String	视频描述
videoPoolExt	Object	视频扩展信息【详见videoPoolExt字段说明】
tag	String	视频标签
title	String	视频标题
publishUrl	String	首发外链

videoPoolExt参数描述

参数名	类型	说明
password	String	视频密码，为空则表示没有密码

返回错误列表

序号	说明
1	找不到writetoken关联的user
2	文件为空或者writetoken为空
3	提交的json名字JSONRPC为null
4	提交文件格式不正确
5	readtoken为空
6	分页输入出错
7	vid不能为空
8	找不到方法名

Java请求示例

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

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

private static final Logger log = LoggerFactory.getLogger(PasswordTest.class);
/**
 * 查询视频播放密码
 * @throws Exception
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetVideoPassword() 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/"+userId+"/video-setting-page";
    String vids = "1b448be323b452641878b54f21241188_1";

    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("userId", userId);
    requestMap.put("ptime", ptime);
    requestMap.put("vids", vids);
    requestMap.put("sign", VodSignUtil.getSign(requestMap, secretKey));
    String response = HttpUtil.get(url,requestMap);
    log.debug("测试查询视频播放密码,{}", response);
    //do somethings

}

响应示例

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

成功示例

{
    "code":200,
    "status":"success",
    "message":"success",
    "data":{
        "questionnaire":{
            "qid":""
        },
        "isShowPassword":false,
        "vids":"1b448be323b452641878b54f21241188_1",
        "videoPool":{
            "describ":"美食",
            "videoPoolExt":{
                "password":"123456"
            },
            "tag":"合并美食",
            "title":"合并美食视频",
            "publishUrl":""
        },
        "qid":""
    }
}

异常示例

{
    "code":400,
    "status":"error",
    "message":"vids为空.",
    "data":""
}