设置视频的播放器

接口描述

1、通过视频id和播放器id,设置视频的播放器
2、接口支持https协议

接口URL

http://api.polyv.net/v2/play/set-video-player

在线API调用

请求方式

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,例如:1b448be3235552e5fafb16489eb01839_1,获取路径:保利威点播后台->视频列表;

playerId

true

String

播放器id,获取路径:保利威点播后台->播放器设置; 也可以获取自【查询播放器列表】; 当playerid的值为其他非法值时,视频的播放器id会设置为默认播放器id

示例

http://api.polyv.net/v2/play/set-video-player

表单参数:

vid=1b448be323d467dcf6a0f9cdde4e9ca0_1&sign=0DFE0E65139ABAEFE0DFEF776649F8BEC0F9DE7F&userid=1b448be323&ptime=1620283115760&playerId=d4b8dDzXsT

响应参数描述

参数名
类型
说明

code

Integer

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

status

String

响应状态文本信息

message

String

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

data

Array

响应成功时返回播放器列表信息【详见data字段说明】,响应失败时返回空

data字段说明

字段
类型
说明

userid

String

保利威点播账户id,例如:1b448be323

vid

String

视频的id,例如:1b448be323d467dcf6a0f9cdde4e9ca0_1

playerId

String

播放器id,例如:1b448be323

Java请求示例

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

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

private static final Logger log = LoggerFactory.getLogger(VodVideoPlayerTest.class);
/**
 * 设置视频的播放器
 */
@Test
public void testSetPlayer() throws Exception, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String secretKey = super.secretKey;
    String userId = super.userId;
    String ptime = String.valueOf(System.currentTimeMillis());

    //业务参数
    String url = "http://api.polyv.net/v2/play/set-video-player";
    String vId = "1b448be323d467dcf6a0f9cdde4e9ca0_1";
    String playerId = "d4b8dDzXsT";

    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("userid", userId);
    requestMap.put("ptime", ptime);
    requestMap.put("vid", vId);
    requestMap.put("playerId", playerId);
    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": ["userid: 1b448be323", "vid: 1b448be323d467dcf6a0f9cdde4e9ca0_1", "playerId: d4b8dDzXsT"]
}

异常示例

签名不正确


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

时间戳过期

{
    "code":400,
    "status":"error",
    "message":"ptime is too old.",
    "data":""
}

Last updated

Was this helpful?