取得影片封面

更新時間：2025-01-14 15:54:19

介面說明

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

介面URL

http://api.polyv.net/v2/video/{userid}/get-image

線上API呼叫

請求方式

GET

介面限制

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

2、sign（簽名）的拼接規則是：ptime=參數&t=參數&vid=參數，並與sign一起透過URL傳遞

請求參數說明

參數名	必選	類型	說明
ptime	true	Long	目前時間的毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為40位大寫的SHA1值，`產生簽名的secretkey金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己的伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
vid	true	String	影片ID，例如：1b448be3235552e5fafb16489eb01839_1
t	false	Integer	值為1時，表示取得影片首圖的縮圖

範例

http://api.polyv.net/v2/video/1b448be323/get-image?vid=1b448be323dec2a7bed6db61bd7d8a77_1&t=1&sign=A722F1E5307046E824C4AA857B8D2B9DEA43A6CA&ptime=1617263701543

回應參數說明

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

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(VodVideoPosterTest.class);
/**
 * 获取视频封面
 */
@Test
public void testGetPoster() throws Exception, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String secretKey = super.secretKey;
    String userid = super.userId;
    String ptime = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = String.format("http://api.polyv.net/v2/video/%s/get-image",userid);
    String vid = "1b448be323dec2a7bed6db61bd7d8a77_1";
    String t = "1";

    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("ptime", ptime);
    requestMap.put("vid", vid);
    requestMap.put("t",t);

    //系统只部分参数进行签名
    Map<String, String> signMap = new HashMap<>();
    signMap.put("ptime", ptime);
    signMap.put("vid", vid);
    signMap.put("t",t);
    requestMap.put("sign", VodSignUtil.getSign(signMap, secretKey));
    
    String response = HttpUtil.get(url, requestMap);
    log.debug("测试获取视频封面,{}", response);
    //do somethings
}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "message": "success",
    "data": "http://img.videocc.net/uimage/1/1b448be323/7/1b448be323dec2a7bed6db61bd7d8a77_0.jpg"
}

異常範例

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