查詢影片的授權播放開關

更新時間：2025-01-14 16:08:24

介面描述

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

介面URL

http://api.polyv.net/v2/video/{userid}/authplay-status

線上API呼叫

請求方式

GET

介面限制

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

請求參數描述

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

範例

http://api.polyv.net/v2/video/1b448be323/authplay-status?vid=1b448be32303e4922a8f70d6b48220ae_1&sign=CFB9913E9B805681EF575B9BEE4C381888DA613F&ptime=1617763189875

回應參數描述

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

返回錯誤代碼列表

錯誤代碼	message	說明
400	ptime is too old.	時間戳過期
400	ptime is illegal.	ptime超出當前時間3分鐘
400	Could not find user by userid.	userid不正確
400	the sign is not right.	簽名不正確
401	vid為空.
403	用戶的影片下找不到該影片.

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(VodPlayAuthTest.class);
/**
 * 查询视频的授权播放开关
 * @throws Exception
 * @throws NoSuchAlgorithmException
 */
@Test
public void testGetPlayAuthSetting() 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/authplay-status", userId);
    String vid = "1b448be32303e4922a8f70d6b48220ae_1";
    
    Map<String, String> requestMap = new HashMap<>();
    requestMap.put("ptime", ptime);
    requestMap.put("vid", vid);
    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": 1
}

異常範例

時間戳過期

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