設定影片的播放器

更新時間：2022-09-02 18:08:07

介面說明

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":""
}