上傳文件到某個課節

更新時間：2024-10-21 09:33:43

接口描述

1、上传课节文档接口
2、（lessonId, type, docName, callbackUrl, url, timestamp, appId）参与sign签名，并和sign一起通过post表单传递，文件通过二进制流提交到服务器端。
3、接口支持https协议

接口URL

http://api.polyv.net/hi-class-api/open/file/v1/upload-doc

請求方式

POST

接口約束

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

2、上傳的文件不超過50M，格式限制為（ppt， pdf，pptx，doc，docx，wps）。

3、file和url只需要傳遞其中一個，如果傳遞了url和file，以file欄位為準

請求參數描述

參數名	必選	類型	說明
appId	true	String	帳號appId【詳見取得密鑰】
timestamp	true	Long	當前13位毫秒級時間戳，3分鐘內有效
sign	true	String	簽名，為32位大寫的MD5值，`生成簽名的appSecret密鑰作為通訊資料安全的關鍵資訊，嚴禁保存在客戶端直接使用，所有API都必須透過客戶自己伺服器中轉呼叫POLYV伺服器取得回應資料`【詳見簽名生成規則】
lessonId	true	String	課節號
file	false	File	上傳的文件不超過50M，格式限制為（ppt， pdf，pptx，doc，docx，wps），file和url只需要傳遞其中一個，如果傳遞了url和file，以file欄位為準
type	false	String	轉換類型，預設不傳轉普通，因為只有ppt，pptx可以轉動畫，其他類型文件會自動轉成普通；文件轉動畫轉失敗會直接把類型轉為普通 common：轉普通圖片 animate：轉動畫效果
docName	false	String	文件名稱，預設不傳使用ppt上傳的文件取得的文件名作為文件名稱，文件名稱不得超過100個字元
callbackUrl	false	String	文件上傳轉換成功回調地址
url	false	String	文件地址url（需要可訪問的地址），file和url只需要傳遞其中一個，如果傳遞了url和file，以file欄位為準

範例

http://api.polyv.net/hi-class-api/open/file/v1/upload-doc

表單參數：

docName=test&appId=frlr1zazn3&sign=FC2296E942D2DB118C64C11AD941445D&callbackUrl=http%3A%2F%2Fwww.baidu.com&type=common&lessonId=1965681&timestamp=1621842842327

回應參數描述

參數名	類型	說明
code	Integer	回應狀態碼，200為成功返回，非200為失敗【詳見全域錯誤說明】
status	String	回應狀態文字資訊
message	String	回應描述資訊，當code為400或500的時候，輔助描述錯誤原因
data	Object	請求成功時為上傳文件的相關資訊【詳見Data參數描述】，請求失敗時為空

Data參數描述

參數名	類型	說明
type	String	轉換類型，預設不傳轉普通，因為只有ppt，pptx可以轉動畫，其他類型文件會自動轉成普通；文件轉動畫轉失敗會直接把類型轉為普通 common：轉普通圖片 animate：轉動畫效果
fileId	String	文件ID，成功時返回
status	String	文件狀態 normal：正常 waitUpload：等待上傳 failUpload：上傳失敗 waitConvert：轉換PPT中 failConvert：轉換PPT失敗

回調說明

ppt轉換圖片、動畫等結果即時資訊回調，可以及時通知使用者上傳、轉換任務的結果。

原理

透過HTTP接口（設定的callbackUrl）向使用者伺服器發送GET請求，將合併結果推送給使用者伺服器。

舉例說明

舉例如下：http://abc.com/test.do?status=normal&timestamp=1603506240000&lessonId=xxxx&fileId=xxx&sign=xxdxxxxx

參數名	類型	說明
status	String	文件轉換狀態（"normal" ：正常，"failConvert":轉換PPT失敗）
fileId	String	文件ID，成功時返回
lessonId	String	課節號
timestamp	Long	13位毫秒級時間戳
sign	String	校驗的加密字串，生成的規則md5(lessonId+timestamp)

Java請求範例

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

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

private static final Logger log = LoggerFactory.getLogger(LessonDocTest.class);
/**
 * 上传文档到某个课节
 * @throws IOException
 */
@Test
public void testUploadDoc() throws IOException, NoSuchAlgorithmException {
    //公共参数,填写自己的实际参数
    String appId=super.appId;
    String appSecret=super.appSecret;
    String userId = super.userId;
    String timestamp=String.valueOf(System.currentTimeMillis());
    //业务参数
    String url = "http://api.polyv.net/hi-class-api/open/file/v1/upload-doc";
    String lessonId = "1965681";
    String type = "common";
    String docName = "test";
    String callbackUrl = "http://www.baidu.com";
    String path = getClass().getResource("/file/").getPath() + "report.pdf";
    File file = new File("D:/test.pdf");

    //http 调用逻辑
    Map<String,String> requestMap = new HashMap<>();
    requestMap.put("appId", appId);
    requestMap.put("timestamp",timestamp);
    requestMap.put("lessonId",lessonId);
    Map<String,File> fileMap = new HashMap<>();
    fileMap.put("file",file);
    requestMap.put("type",type);
    requestMap.put("docName",docName);
    requestMap.put("callbackUrl",callbackUrl);
    requestMap.put("sign",LiveSignUtil.getSign(requestMap, appSecret));
    String response = HttpUtil.postFile(url, requestMap,fileMap,"utf-8");
    log.info("测试上传文档到某个课节：{}",response);
    //do somethings

}

回應範例

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

成功範例

{
    "code":200,
    "status":"success",
    "message":"",
    "data":{
        "type":"common",
        "fileId":"39e6bd3fe674c952815ad1a09c66e1061965681common",
        "status":"waitConvert"
    }
}

異常範例

{
    "code": 400,
    "status": "error",
    "message": "invalid signature.",
    "data": ""
}