保利威文档中心

幫助中心

上傳影片封面

更新時間:2025-10-10 12:02:04

介面說明

1、通过分类id或者视频id上传视频封面图
2、接口支持https协议

介面URL

http://api.polyv.net/v2/video/upload-cover-image

請求方式

POST

介面限制

1、介面同時支援HTTP、HTTPS,建議使用HTTPS以確保介面安全,介面呼叫有頻率限制,詳細請查看

2、請求參數vids(影片id),cateIds(分類id):當傳了vids參數,以vids為準,當vids不傳,以cateIds為準,兩個參數不能同時為空。

3、請求參數imageFile(圖片檔案),imageUrl(圖片http連結),imageBase64(圖片資料的base64形式):圖片上傳形式,三者任選其一即可,傳了多個則按imageFile、imageUrl、imageBase64順序選取第一個不為空的形式,注意:圖片格式僅支援png、jpg、jpeg、gif、bmp,且圖片大小不得超過5MB。

請求參數說明

參數名 必選 類型 說明
userid true String 保利威點播帳戶id,可參考【取得金鑰】取得,取得路徑:官網->登入->點播(API介面)
ptime true Long 目前時間的毫秒級時間戳記,3分鐘內有效
sign true String 簽名,為40位大寫的SHA1值,產生簽名的secretkey金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則
vids true String 影片id,例如:1b448be3235552e5fafb16489eb01839_1,多個影片id用英文逗號隔開
cateIds false String 分類id,例如:1615536384688,該參數取得自【取得分類及子分類】,多個分類id用英文逗號隔開
imageFile false File 圖片檔案
imageUrl false String 圖片連結,支援http、https協定
imageBase64 false String 圖片資料的base64形式

範例

http://api.polyv.net/v2/video/upload-cover-image

表單參數:

vids=1b448be32336069fd567bffc04f3e137_1%2C1b448be323a6a1a6c0c237856f555e88_1&imageUrl=https%3A%2F%2Fd.lanrentuku.com%2Fdown%2Fpng%2F1410%2Fseo-icons%2Fpenguin.png&sign=25108B8B497AD6FE6F1DB979A7FA617E10CE2252&cateIds=1615536384688&userid=1b448be323&ptime=1620286028736

回應參數說明

參數名 類型 說明
code Integer 回應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明
status String 回應狀態文字資訊
message String 回應描述資訊,當code為400或500時,輔助描述錯誤原因
data Object 回應成功時返回圖片的大圖和小圖連結【詳見data欄位說明】,回應失敗時返回空

data欄位說明

欄位 類型 說明
imageUrlSmall String 圖片的小圖http連結,例如:http://img.videocc.net/uimage/1/1b448be323/first_image/645824f1-6697-4d14-b343-1ca5fdd4f574_s.png
imageUrlBig String 圖片的大圖http連結,例如:http://img.videocc.net/uimage/1/1b448be323/first_image/645824f1-6697-4d14-b343-1ca5fdd4f574_b.png

Java請求範例

快速接入基礎程式碼請下載相關依賴原始碼點擊下載原始碼 ,下載後加入到自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 VodSignUtil.java 都包含在下載檔案中。

強烈建議您使用點播Java SDK完成API的功能對接,點播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。

private static final Logger log = LoggerFactory.getLogger(VodVideoPosterTest.class);
/**
 * 上传视频封面
 */
@Test
public void testUploadPoster() 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/upload-cover-image";
    String vids = "1b448be32336069fd567bffc04f3e137_1,1b448be323a6a1a6c0c237856f555e88_1";
    String cateIds = "1615536384688";
    String filePath = getClass().getResource("/file/").getPath() + "poster.png";
    File imageFile = new File(filePath);
    String imageUrl = "https://d.lanrentuku.com/down/png/1410/seo-icons/penguin.png";

    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("userid", userid);
    requestMap.put("ptime", ptime);
    requestMap.put("vids", vids);
    requestMap.put("cateIds",cateIds);
    requestMap.put("imageUrl",imageUrl);
    Map<String,File> fileMap = new HashMap<>();
    fileMap.put("imageFile",imageFile);
    requestMap.put("sign", VodSignUtil.getSign(requestMap, secretKey));
    
    String response = HttpUtil.postFile(url,requestMap,fileMap,Constant.UTF8);
    log.debug("测试上传视频封面,{}", response);
    //do somethings
}

回應範例

系統全域錯誤說明詳見全域錯誤說明

成功範例

{
    "code": 200,
    "status": "success",
    "message": "success",
    "data": {
        "imageUrlSmall": "http://img.videocc.net/uimage/1/1b448be323/first_image/645824f1-6697-4d14-b343-1ca5fdd4f574_s.png",
        "imageUrlBig": "http://img.videocc.net/uimage/1/1b448be323/first_image/645824f1-6697-4d14-b343-1ca5fdd4f574_b.png"
    }
}

異常範例

簽名不正確

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

時間戳過期

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

內部錯誤,或傳了非法參數程式轉換異常

{
    "code": 500,
    "status": "fail",
    "message": "undefined error",
    "data": null
}
联系客服,在线咨询