上传水印
接口描述
1、设置一级分类下或用户账号下所有视频的水印,设置成功后对新上传的视频生效
2、接口URL中的{userid}为点播账号userid,具体参考菜单【使用须知】->【获取密钥】
3、接口支持https协议
接口URL
http://api.polyv.net/v2/video/{userid}/watermarkSetting
请求方式
POST
接口约束
1、接口同时支持HTTP 、HTTPS ,建议使用HTTPS 确保接口安全,接口调用有频率限制,详细请查看
2、水印图片需要为png、ass格式,png图片宽或高的尺寸超过256px时会被等比缩放
请求参数描述
ptime
true
Long
当前时间的毫秒级时间戳,3分钟内有效
sign
true
String
签名,为40位大写的SHA1值,生成签名的secretkey密钥作为通信数据安全的关键信息,严禁保存在客户端直接使用,所有API都必须通过客户自己服务器中转调用POLYV服务器获取响应数据
【详见签名生成规则】
image
true
File
上传的图片
cataid
false
String
分类id,仅给一级分类的视频设置水印。不传为设置用户级别视频的水印
watermarkLocation
false
String
水印显示的位置,动态水印此值无效。 1:左上角 2:右上角 3:左下角 4:右下角
watermarkShow
false
String
水印状态,不传默认为0 0:不显示 1:显示
示例
http://api.polyv.net/v2/video/1b448be323/watermarkSetting
表单参数:
sign=BE988CCF37B7A32B137241D8134AA57071553006&cataid=1602300731843&userId=1b448be323&ptime=1618279224027&watermarkLocation=3
响应参数描述
status
String
响应状态文本信息
message
String
响应描述信息,当code为400或者500的时候,辅助描述错误原因
data
Object
响应成功时返回true,失败时返回空字符串
Java请求示例
快速接入基础代码请下载相关依赖源码, 点击下载源代码 ,下载后加入到自己的源码工程中即可。测试用例中的HttpUtil.java 和 VodSignUtil.java 都包含在下载文件中。
强烈建议您使用点播Java SDK完成API的功能对接,点播Java SDK 对API调用逻辑、异常处理、数据签名、HTTP请求线程池进行了统一封装和优化。
private static final Logger log = LoggerFactory.getLogger(VodVideoUploadTest.class);
/**
*上传水印
* @throws Exception
* @throws NoSuchAlgorithmException
*/
@Test
public void testUploadWatermark() 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+"/watermarkSetting";
String path1 = getClass().getResource("/file/").getPath() + "cat.jpg";
File image = new File(path1);
String watermarkLocation = "3";
String cataid = "1602300731843";
//调用逻辑
Map<String, String> requestMap = new HashMap<>();
requestMap.put("userId", userId);
requestMap.put("ptime", ptime);
requestMap.put("watermarkLocation", watermarkLocation);
requestMap.put("cataid", cataid);
Map<String,File> fileMap = new HashMap<>();
fileMap.put("image",image);
requestMap.put("sign", VodSignUtil.getSign(requestMap, secretKey));
String response = HttpUtil.postFile(url,requestMap,fileMap,"utf-8");
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
Was this helpful?