設定打點資訊

更新時間：2025-01-14 15:57:02

介面說明

1、通过视频id设置单个视频的打点信息
2、接口URL中的{userid}为点播账号userid，具体参考菜单【使用须知】->【获取密钥】
3、接口仅userid、ptime、vid参与签名，其他参数不参与签名
4、接口支持https协议

介面URL

http://api.polyv.net/v2/video/{userid}/saveKeyFrame

線上API呼叫

請求方式

POST

介面限制

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

2、請求參數 seconds（打點秒數）必須小於影片時長

3、請求參數 dess（打點描述）的個數必須與 seconds（打點秒數）的個數相同

請求參數說明

參數名	必選	類型	說明
ptime	true	Long	當前時間的毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為40位大寫的SHA1值，`產生簽名的secretkey金鑰作為通訊資料安全的關鍵資訊，嚴禁儲存在用戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名產生規則】
vid	true	String	影片id
desc	true	String	打點描述，如果上傳多個打點，請用英文逗號","隔開
seconds	true	String	打點秒數，如果上傳多個打點，請用英文逗號","隔開
btnsettingswitch	false	String	打點按鈕設定開關，不傳表示關閉 Y：為開啟 N：為關閉
btndesc	false	String	按鈕描述，按鈕開關開啟時必填
btnhref	false	String	按鈕跳轉位址，按鈕開關開啟時必填

範例

http://api.polyv.net/v2/video/1b448be323/saveKeyFrame

表單參數：

vid=1b448be323a6a1a6c0c237856f555e88_1&seconds=10,20&btnsettingswitch=Y&btnhref=https://baidu.com&sign=D4F867827C100835254100FF147B1095DA29BB72&btndesc=测试打点按钮&ptime=1617258980678&desc=测试打点10s,测试打点20s

回應參數說明

參數名	類型	說明
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(VodChapterMakerTest.class);
/**
 * 设置打点信息
 * @throws Exception
 * @throws NoSuchAlgorithmException
 */
@Test
public void testAddChapterMarker() 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/saveKeyFrame", userId);
    String vid = "1b448be323a6a1a6c0c237856f555e88_1";
    String desc = "测试打点10s,测试打点20s";
    String seconds = "10,20";
    String btnsettingswitch = "Y";
    String btndesc = "测试打点按钮";
    String btnhref = "https://baidu.com";
    
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("ptime", ptime);
    requestMap.put("vid", vid);
    requestMap.put("desc", desc);
    requestMap.put("seconds", seconds);
    requestMap.put("btnsettingswitch", btnsettingswitch);
    requestMap.put("btndesc", btndesc);
    requestMap.put("btnhref", btnhref);
    
    //系统只部分参数进行签名
    Map<String, String> signMap = new HashMap<>();
    signMap.put("userid", userId);
    signMap.put("ptime", ptime);
    signMap.put("vid", vid);
    requestMap.put("sign", VodSignUtil.getSign(signMap, secretKey));
    String response = HttpUtil.postFormBody(url, requestMap);
    log.debug("测试设置打点信息,{}", response);
    //do somethings
    
}

回應範例

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

成功範例

{
    "code": 200,
    "status": "success",
    "message": "success",
    "data": "the key frame add successfully"
}

異常範例

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