Api參考 · 富源文檔

# ## 1、獲得授權access_token 訪問這個接口需要提供`appid`和`secret`，這兩者需要到富源平臺注冊應用，然后在應用的右側獲得。這個`access_token`的有效時間為兩個小時，請注意管理避免過期。 # ~~~[api:notDebug] get:/v1/token *appid=a44r4aMbO7BZ1NoW#申請的appid *secret=a4474wRq9BwujRV7hM4SGH0QMyrEJF5J#申請的appsecret *grant_type=client_credential#類型 <<< success { "accessToken": "a447bdDAUeKORvmt", "expires": 7200 } <<< 403 { "status": 403, "error": "SecretIsInvalid", "message": "無效的 secret" } ~~~ # ## 2，上傳文檔將文件以指定的key值上傳，注意key不能以`/`開頭： * `/abc/e.jpg`：錯誤 * `abc/e.jpg`：正確 # ~~~[api:base] post:http://foxconn.gateway.api.liyueyun.com/api/lss/attachments *key=myFolder/secFolder/fileName.jpg#附件的Key，支持目錄格式。相同Key的文檔會被覆蓋 <<< success { "success": true } <<< 500 錯誤一 {? error:"App_Module_Not_Formal",? message:"此服務模塊還未申請正式"? } 錯誤二 { error:"Params_key_Missing", message:"參數key不能為空！" } <<< 400 { "status":?400, "error":?"FRS.0001", "message":?"輸入格式不正確" } <<< 401 錯誤一: { "status": 401, "error": "AccessTokenNoExist", "message": "必須有 accessToken" } 錯誤二: { "status": 401, "error": "AccessTokenIsInvalid", "message": "無效的?accessToken" } 錯誤三: { "status": 401, "error": "AccessTokenHasExpired", "message": "accessToken 已過期" } <<< 403 錯誤一: { "status": 403, "error": "SecretIsInvalid", "message": "無效的 secret" } 錯誤二: { "status": 403, "error": "SecretHasDisabled", "message": "secret 已被禁用" } 錯誤三: { "status": 403, "error": "SecretError", "message": "secret 狀態異常" } 錯誤四: { "status": 403, "error": "LimitExceeded", "message": "已超出用量限制" } ~~~ # # ##### C#訪問示例代碼： ~~~CSharp var client = new RestClient("http://foxconn.gateway.api.liyueyun.com/api/lss/attachments?key=myFolder/secFolder/fileName.jpg"); client.Timeout = -1; var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer a447bdDAUeKORvmt"); // 這里的a447bdDAUeKORvmt就是接口1取得的access_token request.AddParameter("application/octet-stream", "<file contents here>", ParameterType.RequestBody); IRestResponse response = client.Execute(request); Console.WriteLine(response.Content); ~~~ # ##### Java訪問示例代碼： ~~~ java OkHttpClient client = new OkHttpClient().newBuilder() .build(); MediaType mediaType = MediaType.parse("application/octet-stream"); RequestBody body = RequestBody.create(mediaType, "<file contents here>"); Request request = new Request.Builder() .url("http://foxconn.gateway.api.liyueyun.com/api/lss/attachments?key=myFolder/secFolder/fileName.jpg") .method("POST", body) .addHeader("Authorization", "Bearer a447bdDAUeKORvmt") // 這里的a447bdDAUeKORvmt就是接口1取得的access_token .build(); Response response = client.newCall(request).execute(); ~~~ # #### Nodejs訪問示例代碼 ~~~javascript var unirest = require('unirest'); var req = unirest('POST', 'http://foxconn.gateway.api.liyueyun.com/api/lss/attachments?key=myFolder/secFolder/fileName.jpg') .headers({ 'Content-Type': 'application/octet-stream', 'Authorization': 'Bearer a447bdDAUeKORvmt' // 這里的a447bdDAUeKORvmt就是接口1取得的access_token }) .send("<file contents here>") .end(function (res) { if (res.error) throw new Error(res.error); console.log(res.raw_body); }); ~~~ # # ## 3，獲得文檔的訪問權限可以取得文檔的訪問權限，如`public`,`private`或是`null`。當是`null`時表示這個文檔不存在。 # ~~~[api:base] get:http://foxconn.gateway.api.liyueyun.com/api/lss/attachments/acl *key=myFolder/secFolder/fileName.jpg#文檔的Key，支持目錄格式。 <<< 200 {? "accessControlList":{ "grant":"null" // 這里的值有三個：['public','private','null'] ，分別表示：公開，私有，不存在 } } <<< 500 錯誤一 {? error:"App_Module_Not_Formal",? message:"此服務模塊還未申請正式"? } 錯誤二 { error:"Params_key_Missing", message:"參數key不能為空！" } <<< 400 { "status":?400, "error":?"FRS.0001", "message":?"輸入格式不正確" } <<< 401 錯誤一: { "status": 401, "error": "AccessTokenNoExist", "message": "必須有 accessToken" } 錯誤二: { "status": 401, "error": "AccessTokenIsInvalid", "message": "無效的?accessToken" } 錯誤三: { "status": 401, "error": "AccessTokenHasExpired", "message": "accessToken 已過期" } <<< 403 錯誤一: { "status": 403, "error": "SecretIsInvalid", "message": "無效的 secret" } 錯誤二: { "status": 403, "error": "SecretHasDisabled", "message": "secret 已被禁用" } 錯誤三: { "status": 403, "error": "SecretError", "message": "secret 狀態異常" } 錯誤四: { "status": 403, "error": "LimitExceeded", "message": "已超出用量限制" } ~~~ # # ##### C#訪問示例代碼： ~~~CSharp var client = new RestClient("http://foxconn.gateway.api.liyueyun.com/api/lss/attachments/acl?key=myFolder/secFolder/fileName.jpg"); client.Timeout = -1; var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer a447bdDAUeKORvmt"); // 這里的a447bdDAUeKORvmt就是接口1取得的access_token IRestResponse response = client.Execute(request); Console.WriteLine(response.Content); ~~~ # ##### Java訪問示例代碼： ~~~ java OkHttpClient client = new OkHttpClient().newBuilder() .build(); Request request = new Request.Builder() .url("http://foxconn.gateway.api.liyueyun.com/api/lss/attachments/acl?key=myFolder/secFolder/fileName.jpg") .method("GET", null) .addHeader("Authorization", "Bearer a447bdDAUeKORvmt") // 這里的a447bdDAUeKORvmt就是接口1取得的access_token .build(); Response response = client.newCall(request).execute(); ~~~ # #### Nodejs訪問示例代碼 ~~~javascript var unirest = require('unirest'); var req = unirest('GET', 'http://foxconn.gateway.api.liyueyun.com/api/lss/attachments/acl?key=myFolder/secFolder/fileName.jpg') .headers({ 'Authorization': 'Bearer a447bdDAUeKORvmt' // 這里的a447bdDAUeKORvmt就是接口1取得的access_token }) .end(function (res) { if (res.error) throw new Error(res.error); console.log(res.raw_body); }); ~~~ # # ## 4，直接下載文檔獲得文檔的二進制流。 # ~~~[api:base] get:http://foxconn.gateway.api.liyueyun.com/api/lss/attachments/download *key=myFolder/secFolder/fileName.jpg#文檔的Key，支持目錄格式。 <<< <文件二進制> <<< 500 錯誤一 {? error:"App_Module_Not_Formal",? message:"此服務模塊還未申請正式"? } 錯誤二 { error:"Params_key_Missing", message:"參數key不能為空！" } <<< 400 { "status":?400, "error":?"FRS.0001", "message":?"輸入格式不正確" } <<< 401 錯誤一: { "status": 401, "error": "AccessTokenNoExist", "message": "必須有 accessToken" } 錯誤二: { "status": 401, "error": "AccessTokenIsInvalid", "message": "無效的?accessToken" } 錯誤三: { "status": 401, "error": "AccessTokenHasExpired", "message": "accessToken 已過期" } <<< 403 錯誤一: { "status": 403, "error": "SecretIsInvalid", "message": "無效的 secret" } 錯誤二: { "status": 403, "error": "SecretHasDisabled", "message": "secret 已被禁用" } 錯誤三: { "status": 403, "error": "SecretError", "message": "secret 狀態異常" } 錯誤四: { "status": 403, "error": "LimitExceeded", "message": "已超出用量限制" } ~~~ # # ##### C#訪問示例代碼： ~~~CSharp var client = new RestClient("http://foxconn.gateway.api.liyueyun.com/api/lss/attachments/download?key=myFolder/secFolder/fileName.jpg"); client.Timeout = -1; var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer a447bdDAUeKORvmt"); // 這里的a447bdDAUeKORvmt就是接口1取得的access_token IRestResponse response = client.Execute(request); ~~~ # ##### Java訪問示例代碼： ~~~ java OkHttpClient client = new OkHttpClient().newBuilder() .build(); Request request = new Request.Builder() .url("http://foxconn.gateway.api.liyueyun.com/api/lss/attachments/download?key=myFolder/secFolder/fileName.jpg") .method("GET", null) .addHeader("Authorization", "Bearer a447bdDAUeKORvmt") // 這里的a447bdDAUeKORvmt就是接口1取得的access_token .build(); Response response = client.newCall(request).execute(); ~~~ # #### Nodejs訪問示例代碼 ~~~javascript var unirest = require('unirest'); var req = unirest('GET', 'http://foxconn.gateway.api.liyueyun.com/api/lss/attachments/download?key=myFolder/secFolder/fileName.jpg') .headers({ 'Authorization': 'Bearer a447bdDAUeKORvmt' // 這里的a447bdDAUeKORvmt就是接口1取得的access_token }) .end(function (res) { if (res.error) throw new Error(res.error); //這里保存返回的文件流 }); ~~~ # # ## 5，取得文檔的臨時公開訪問地址接口可以取得文檔，但這是一個私有接口，訪問需要提供token，而在業務系統中常常需要提供一個臨時公開的文檔 # ~~~[api:base] get:http://foxconn.gateway.api.liyueyun.com/api/lss/attachments/download *key=myFolder/secFolder/fileName.jpg#文檔的Key，支持目錄格式。 <<< <文件二進制> <<< 500 錯誤一 {? error:"App_Module_Not_Formal",? message:"此服務模塊還未申請正式"? } 錯誤二 { error:"Params_key_Missing", message:"參數key不能為空！" } <<< 400 { "status":?400, "error":?"FRS.0001", "message":?"輸入格式不正確" } <<< 401 錯誤一: { "status": 401, "error": "AccessTokenNoExist", "message": "必須有 accessToken" } 錯誤二: { "status": 401, "error": "AccessTokenIsInvalid", "message": "無效的?accessToken" } 錯誤三: { "status": 401, "error": "AccessTokenHasExpired", "message": "accessToken 已過期" } <<< 403 錯誤一: { "status": 403, "error": "SecretIsInvalid", "message": "無效的 secret" } 錯誤二: { "status": 403, "error": "SecretHasDisabled", "message": "secret 已被禁用" } 錯誤三: { "status": 403, "error": "SecretError", "message": "secret 狀態異常" } 錯誤四: { "status": 403, "error": "LimitExceeded", "message": "已超出用量限制" } ~~~ # # ##### C#訪問示例代碼： ~~~CSharp var client = new RestClient("http://foxconn.gateway.api.liyueyun.com/api/lss/attachments/download?key=myFolder/secFolder/fileName.jpg"); client.Timeout = -1; var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer a447bdDAUeKORvmt"); // 這里的a447bdDAUeKORvmt就是接口1取得的access_token IRestResponse response = client.Execute(request); ~~~ # ##### Java訪問示例代碼： ~~~ java OkHttpClient client = new OkHttpClient().newBuilder() .build(); Request request = new Request.Builder() .url("http://foxconn.gateway.api.liyueyun.com/api/lss/attachments/download?key=myFolder/secFolder/fileName.jpg") .method("GET", null) .addHeader("Authorization", "Bearer a447bdDAUeKORvmt") // 這里的a447bdDAUeKORvmt就是接口1取得的access_token .build(); Response response = client.newCall(request).execute(); ~~~ # #### Nodejs訪問示例代碼 ~~~javascript var unirest = require('unirest'); var req = unirest('GET', 'http://foxconn.gateway.api.liyueyun.com/api/lss/attachments/download?key=myFolder/secFolder/fileName.jpg') .headers({ 'Authorization': 'Bearer a447bdDAUeKORvmt' // 這里的a447bdDAUeKORvmt就是接口1取得的access_token }) .end(function (res) { if (res.error) throw new Error(res.error); //這里保存返回的文件流 }); ~~~ # # ## 6，刪除文檔刪除指定key值對應的文檔 # ~~~[api:base] delete:http://foxconn.gateway.api.liyueyun.com/api/lss/attachments *key=myFolder/secFolder/fileName.jpg#文檔的Key，支持目錄格式。 <<< 200 {? success:true } <<< 500 錯誤一 {? error:"App_Module_Not_Formal",? message:"此服務模塊還未申請正式"? } 錯誤二 { error:"Params_key_Missing", message:"參數key不能為空！" } <<< 400 { "status":?400, "error":?"FRS.0001", "message":?"輸入格式不正確" } <<< 401 錯誤一: { "status": 401, "error": "AccessTokenNoExist", "message": "必須有 accessToken" } 錯誤二: { "status": 401, "error": "AccessTokenIsInvalid", "message": "無效的?accessToken" } 錯誤三: { "status": 401, "error": "AccessTokenHasExpired", "message": "accessToken 已過期" } <<< 403 錯誤一: { "status": 403, "error": "SecretIsInvalid", "message": "無效的 secret" } 錯誤二: { "status": 403, "error": "SecretHasDisabled", "message": "secret 已被禁用" } 錯誤三: { "status": 403, "error": "SecretError", "message": "secret 狀態異常" } 錯誤四: { "status": 403, "error": "LimitExceeded", "message": "已超出用量限制" } ~~~ # # ##### C#訪問示例代碼： ~~~CSharp var client = new RestClient("http://foxconn.gateway.api.liyueyun.com/api/lss/attachments?key=myFolder/secFolder/fileName.jpg"); client.Timeout = -1; var request = new RestRequest(Method.DELETE); request.AddHeader("Authorization", "Bearer a447bdDAUeKORvmt"); // 這里的a447bdDAUeKORvmt就是接口1取得的access_token IRestResponse response = client.Execute(request); Console.WriteLine(response.Content); ~~~ # ##### Java訪問示例代碼： ~~~ java OkHttpClient client = new OkHttpClient().newBuilder() .build(); Request request = new Request.Builder() .url("http://foxconn.gateway.api.liyueyun.com/api/lss/attachments?key=myFolder/secFolder/fileName.jpg") .method("DELETE", null) .addHeader("Authorization", "Bearer a447bdDAUeKORvmt") // 這里的a447bdDAUeKORvmt就是接口1取得的access_token .build(); Response response = client.newCall(request).execute(); ~~~ # #### Nodejs訪問示例代碼 ~~~javascript var unirest = require('unirest'); var req = unirest('DELETE', 'http://foxconn.gateway.api.liyueyun.com/api/lss/attachments?key=myFolder/secFolder/fileName.jpg') .headers({ 'Authorization': 'Bearer a447bdDAUeKORvmt' // 這里的a447bdDAUeKORvmt就是接口1取得的access_token }) .end(function (res) { if (res.error) throw new Error(res.error); console.log(res.raw_body); }); ~~~