新增影片至播放清單
更新時間:2022-09-02 18:08:07
介面說明
1、通过视频id添加视频到播放列表
2、接口支持https协议
介面URL
http://api.polyv.net/v2/play-list/add-video
請求方式
POST
介面限制
1、介面同時支援HTTP、HTTPS,建議使用HTTPS以確保介面安全,介面呼叫有頻率限制,詳細請查看
請求參數說明
| 參數名 | 必填 | 類型 | 說明 |
|---|---|---|---|
| userid | true | String | 保利威點播帳戶id,可參考【取得密鑰】取得,取得路徑:官網->登入->點播(API介面) |
| ptime | true | Long | 當前時間的毫秒級時間戳記,3分鐘內有效 |
| sign | true | String | 簽名,為40位大寫的SHA1值,產生簽名的secretkey密鑰作為通訊資料安全的關鍵資訊,嚴禁儲存在用戶端直接使用,所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料【詳見簽名產生規則】 |
| playListId | true | String | 播放清單ID |
| vid | true | String | 影片ID |
範例
http://api.polyv.net/v2/play-list/add-video
表單參數:
vid=1b448be32366f55b1422ac94a4fb7932_1&sign=BCA4C97EFC471F976B1EAFF668EB82184B0E8A2E&userid=1b448be323&ptime=1620284595522&playListId=1620281719396
回應參數說明
| 參數名 | 類型 | 說明 |
|---|---|---|
| code | Integer | 回應狀態碼,200為成功返回,非200為失敗【詳見全域錯誤說明】 |
| status | String | 回應狀態文字資訊 |
| message | String | 回應描述資訊,當code為400或500時,輔助描述錯誤原因 |
| data | String | 成功返回success,失敗返回空 |
Java請求範例
快速接入基礎程式碼請下載相關依賴原始碼, 點擊下載原始碼 ,下載後加入自己的原始碼工程中即可。測試案例中的HttpUtil.java 和 VodSignUtil.java 都包含在下載檔案中。
強烈建議您使用點播Java SDK完成API的功能對接,點播Java SDK 對API呼叫邏輯、異常處理、資料簽名、HTTP請求執行緒池進行了統一封裝和最佳化。
private static final Logger log=LoggerFactory.getLogger(VodPlaylistTest.class);
/**
* 添加视频至播放列表
* @throws Exception
* @throws NoSuchAlgorithmException
*/
@Test
public void testAddVideoToPlaylist()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-list/add-video";
String playListId="1620281719396";
String vid="1b448be32366f55b1422ac94a4fb7932_1";
Map<String, String> requestMap=new HashMap<>();
requestMap.put("userid",userId);
requestMap.put("ptime",ptime);
requestMap.put("playListId",playListId);
requestMap.put("vid",vid);
requestMap.put("sign",VodSignUtil.getSign(requestMap,secretKey));
String response=HttpUtil.postFormBody(url,requestMap);
log.debug("测试添加视频至播放列表,{}",response);
//do somethings
}
回應範例
系統全域錯誤說明詳見全域錯誤說明
成功範例
{
"code": 200,
"status": "success",
"message": "success"
}
異常範例
{
"code": 400,
"status": "error",
"message": "the sign is not right",
"data": ""
}
