修改分类设置

接口描述

1、通过分类id,修改一级分类的属性,例如是否源文件播放等
2、接口URL中的{userid}为点播账号userid,具体参考菜单【使用须知】->【获取密钥】
3、接口支持https协议
4、每个账户预设根目录,名字为默认分类

接口URL

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

在线API调用

请求方式

POST

接口约束

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

请求参数描述

参数名必选类型说明

userid

true

String

保利威点播账户id,可以参考【获取密钥】获取,获取路径:官网->登录->点播(API接口)

ptime

true

Long

当前时间的毫秒级时间戳,3分钟内有效

sign

true

String

签名,为40位大写的SHA1值,生成签名的secretkey密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据【详见签名生成规则

cataid

true

String

分类id,仅能设置一级分类的属性,该参数获取自【获取分类及子分类

isSettings

false

String

是否启用设置,默认值为Y:开启 Y为开启 N为关闭

keepSource

false

String

源文件播放设置开关(仅对新上传视频有效),默认值为0:非源文件播放 如果为源文件播放,encrypt、encryptLevel、isEdu、encodeAAC参数不生效 1:开启 0:关闭

encrypt

false

String

视频加密设置开关(仅对新上传视频有效),默认值为0:关闭 1:开启 0:关闭

hlslevel

false

String

移动端加密设置(仅对新上传视频有效),默认值为open:非加密授权 open:非加密授权; web:WEB授权; app:APP授权; wxa_app:小程序授权;

isEdu

false

String

视频优化(仅对新上传视频有效),默认值为0:关闭 1:开启 0:关闭

encode_aac

false

String

生成音频文件(仅对新上传视频有效),默认为0:关闭 该功能只对部分有权限用户开放 1:开启 0:关闭

playerId

false

String

播放器id, 用于设置当前分类下的视频使用哪个播放器进行播放

示例

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

表单参数:

isEdu=1&encode_aac=1&encrypt=1&isSettings=Y&keepSource=0&sign=726E92932FA8EB35E4BD6B01E3F740CF512FBD86&cataid=1617160372987&userid=1b448be323&ptime=1617235796542&hlslevel=app

响应参数描述

参数名类型说明

code

Integer

响应状态码,200为成功返回,非200为失败【详见全局错误说明

status

String

响应状态文本信息

message

String

响应描述信息,当code为400或者500的时候,辅助描述错误原因

data

String

成功返回true,错误返回空字符串

Java请求示例

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

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

private static final Logger log = LoggerFactory.getLogger(VodVideoCategoryTest.class);

/**
 * 修改分类设置
 */
@Test
public void testUpdateVideoCategoryProfile() 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 + "/updateCataProfile";
        String cataId = "1617160372987";
        String isSettings = "Y";
        String keepSource = "0";
        String encrypt = "1";
        String hlsLevel = "app";
        String isEdu = "1";
        String encodeAac = "1";

        Map<String, String> requestMap = new HashMap<>();
        requestMap.put("userid", userId);
        requestMap.put("ptime", ptime);
        requestMap.put("cataid", cataId);
        requestMap.put("isSettings", isSettings);
        requestMap.put("keepSource", keepSource);
        requestMap.put("encrypt", encrypt);
        requestMap.put("hlslevel", hlsLevel);
        requestMap.put("isEdu", isEdu);
        requestMap.put("encode_aac", encodeAac);
        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": true
}

异常示例

{
    "code": 400, 
    "status": "error", 
    "message": "sign can not be empty.", 
    "data": ""
}

Last updated