查詢教材

更新時間：2025-01-14 16:02:07

介面描述

1、通过视频id获取视频关联课件信息
2、接口URL中的{userid}为点播账号userid，具体参考菜单【使用须知】->【获取密钥】
3、接口支持https协议

介面URL

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

線上API呼叫

請求方式

GET

介面限制

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

請求參數描述

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

範例

http://api.polyv.net/v2/video/1b448be323/getPPTPage?vid=1b448be3239482977934f099f2ceaa0a_1&sign=7CA059DC9F8359A0C96BAEC2E2B0A53D7772D416&ptime=1617674841740

回應參數描述

參數名	類型	說明
code	Integer	回應狀態碼，200為成功返回，非200為失敗【詳見全域錯誤說明】
status	String	回應狀態文字資訊
message	String	回應描述資訊，當code為400或500時，輔助描述錯誤原因
data	Array	回應成功時回傳教材資訊【詳見Data欄位說明】，回應失敗時回傳空

Data參數描述

參數名	類型	說明
pageNo	Integer	教材頁碼
pageTitle	String	教材頁面標題
pageImage	String	教材某頁轉碼後的圖片URL連結
pageThumbnail	String	教材某頁縮圖URL連結
showTime	Integer	影片播放到第幾秒時顯示該頁教材，單位：秒

回傳錯誤代碼列表

錯誤代碼	message	說明
400	sign can not be empty.	加密串為空
400	ptime is too old.	時間戳已過期
400	ptime is illegal.	時間戳參數格式不對或超過當前時間3分鐘
400	Could not find user by userid.	userid不存在
400	the sign is not right.	加密串不正確
400	該影片尚未關聯教材	該影片尚未關聯教材

Java請求範例

HttpUtil.java 和 VodSignUtil.java 基礎程式碼請點擊下載本地或跳轉到基礎程式碼線上取得

private static final Logger log = LoggerFactory.getLogger(VodVideoCourseWare.class);
/**
 *  查询课件
 */
@Test
public void testGetCourseWare() throws Exception, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String secretKey = super.secretKey;
    String userid = super.userId;
    String ptime = String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = String.format("https://api.polyv.net/v2/video/%s/getPPTPage", userid);
    String vid = "1b448be3239482977934f099f2ceaa0a_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": [{
        "pageNo": 1,
        "pageTitle": "hello,word",
        "pageImage": "https://doc-oss.polyv.net/images/2021/04/736cde140f73437997729a1066140cf1e6bdefb8/736cde140f73437997729a1066140cf1e6bdefb8_0000.jpeg",
        "pageThumbnail": "https://doc-oss.polyv.net/images/2021/04/736cde140f73437997729a1066140cf1e6bdefb8/736cde140f73437997729a1066140cf1e6bdefb8_0000_s.jpeg",
        "showTime": 0
    }, {
        "pageNo": 2,
        "pageTitle": "hello,word",
        "pageImage": "https://doc-oss.polyv.net/images/2021/04/736cde140f73437997729a1066140cf1e6bdefb8/736cde140f73437997729a1066140cf1e6bdefb8_0001.jpeg",
        "pageThumbnail": "https://doc-oss.polyv.net/images/2021/04/736cde140f73437997729a1066140cf1e6bdefb8/736cde140f73437997729a1066140cf1e6bdefb8_0001_s.jpeg",
        "showTime": 0
    }, {
        "pageNo": 3,
        "pageTitle": "hello,word",
        "pageImage": "https://doc-oss.polyv.net/images/2021/04/736cde140f73437997729a1066140cf1e6bdefb8/736cde140f73437997729a1066140cf1e6bdefb8_0002.jpeg",
        "pageThumbnail": "https://doc-oss.polyv.net/images/2021/04/736cde140f73437997729a1066140cf1e6bdefb8/736cde140f73437997729a1066140cf1e6bdefb8_0002_s.jpeg",
        "showTime": 0
    }]
}

異常範例

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