保利威文档中心

幫助中心

查詢影片播放密碼

更新時間:2025-01-14 16:09:30

介面描述

1、通过视频id查询视频播放密码
2、接口URL中的{userid}为点播账号userid,具体参考菜单【使用须知】->【获取密钥】
3、接口支持https协议

介面URL

http://api.polyv.net/v2/video/{userid}/video-setting-page

線上API呼叫

請求方式

GET

介面限制

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

請求參數說明

參數名 必填 類型 說明
ptime true Long 當前時間的毫秒級時間戳,3分鐘內有效
sign true String 簽名,為40位大寫的SHA1值,產生簽名的secretkey金鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在客戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則
vids true String 影片id,多個用英文逗號隔開

範例

http://api.polyv.net/v2/video/1b448be323/video-setting-page?vids=1b448be323b452641878b54f21241188_1&sign=1304532D24F75B2209D2B3D7BE62722265E6D21B&ptime=1618281315107

回應參數說明

參數名 類型 說明
code Integer 回應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明
status String 回應狀態文字資訊
message String 回應描述資訊,當code為400或500時,輔助描述錯誤原因
data Object 回應成功時返回影片播放密碼資訊【詳見data欄位說明
data參數說明
參數名 類型 說明
questionnaire Object 問卷調查【詳見questionnaire欄位說明
isShowPassword Boolean 是否顯示密碼
true:顯示密碼
false:不顯示密碼
vids String 影片id
videoPool Object 影片資訊【詳見videoPool欄位說明
qid String 訪客資訊收集id
questionnaire參數說明
參數名 類型 說明
qid String 訪客資訊收集id
videoPool參數說明
參數名 類型 說明
describ String 影片描述
videoPoolExt Object 影片擴充資訊【詳見videoPoolExt欄位說明
tag String 影片標籤
title String 影片標題
publishUrl String 首發外鏈
videoPoolExt參數說明
參數名 類型 說明
password String 影片密碼,為空則表示沒有密碼

返回錯誤列表

序號 說明
1 找不到writetoken關聯的user
2 檔案為空或writetoken為空
3 提交的json名稱JSONRPC為null
4 提交檔案格式不正確
5 readtoken為空
6 分頁輸入錯誤
7 vid不能為空
8 找不到方法名稱

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(PasswordTest.class);
/**
 * 查询视频播放密码
 * @throws Exception
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetVideoPassword() 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+"/video-setting-page";
    String vids = "1b448be323b452641878b54f21241188_1";

    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("ptime", ptime);
    requestMap.put("vids", vids);
    requestMap.put("sign", VodSignUtil.getSign(requestMap, secretKey));
    String response = HttpUtil.get(url,requestMap);
    log.debug("测试查询视频播放密码,{}", response);
    //do somethings

}

回應範例

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

成功範例

{
    "code":200,
    "status":"success",
    "message":"success",
    "data":{
        "questionnaire":{
            "qid":""
        },
        "isShowPassword":false,
        "vids":"1b448be323b452641878b54f21241188_1",
        "videoPool":{
            "describ":"美食",
            "videoPoolExt":{
                "password":"123456"
            },
            "tag":"合并美食",
            "title":"合并美食视频",
            "publishUrl":""
        },
        "qid":""
    }
}

異常範例

{
    "code":400,
    "status":"error",
    "message":"vids为空.",
    "data":""
}
联系客服,在线咨询