主题
上传本地文档
上传本地文档至应用空间,可指定上传的父目录,若不指定则自动上传至根目录
基本信息
请求方法:POST
请求路径:/api/v1/openapi/appspace/files/upload
请求主机:developer.kdocs.cn
限流频次
应用类型 | 限额 |
---|---|
测试应用 | 500 次/天 |
正式应用 | 100,000 次/天 |
权限范围
提示
应用文档不属于用户文档,不做权限要求。
Header 参数
参数 | 必须 | 类型 | 说明 |
---|---|---|---|
Date | 是 | string | 使用 RFC1123 时间格式的当前时间 |
Content-Md5 | 是 | string | HTTP Body 中数据的 MD5 值十六进制表达方式, 必需小写, 如果是 get 请求一律使用 URI 计算 MD5 |
Content-Type | 是 | string | multipart/form-data; boundary=xxxxx |
Authorization | 是 | string | "WPS-2:" + app_id + ":" + sha1( app_key + Content-Md5 + Content-Type + DATE ) |
Content-Disposition | 否 | string | 注意:该请求头不参与签名计算。示例: filename="sheets.xls" |
Body 参数
提示
该请求为 multipart/form-data
类型请求
参数 | 必须 | 类型 | 说明 |
---|---|---|---|
file | 是 | file | 目标文档,文档本身 |
parent_token | 否 | string | 所在目录 ID,与 parent_path 参数冲突 |
parent_path | 否 | string[] | 目录,可多级,如果目录不存在自动创建 |
creator | 否 | string | 创建者 ID |
返回参数
参数 | 必须 | 类型 | 说明 |
---|---|---|---|
code | 是 | integer | 错误码 |
data | 是 | data {} | 响应数据 |
示例
请求示例
curl --request POST \
--url https://developer.kdocs.cn/api/v1/openapi/appspace/files/upload \
--header 'Authorization: WPS-2:SX20220101ABCDEF:ac59dac1460772a04b3a97d7ef78409f28241e3a' \
--header 'Content-Md5: d41d8cd98f00b204e9800998ecf8427e' \
--header 'Content-Type: multipart/form-data' \
--header 'Date: Wed, 23 Jan 2013 06:43:08 GMT' \
--form file=@example.pdf \
--form 'parent_path=path1,path2' \
--form creator=xxx
OkHttpClient client = new OkHttpClient();
MediaType mediaType = MediaType.parse("multipart/form-data; boundary=---011000010111000001101001");
RequestBody body = RequestBody.create(mediaType, "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example.pdf\"\r\nContent-Type: application/pdf\r\n\r\nfileInput.files[0]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"parent_path\"\r\n\r\npath1,path2\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"creator\"\r\n\r\nxxx\r\n-----011000010111000001101001--\r\n");
Request request = new Request.Builder()
.url("https://developer.kdocs.cn/api/v1/openapi/appspace/files/upload")
.post(body)
.addHeader("Date", "Wed, 23 Jan 2013 06:43:08 GMT")
.addHeader("Content-Md5", "d41d8cd98f00b204e9800998ecf8427e")
.addHeader("Content-Type", "multipart/form-data")
.addHeader("Authorization", "WPS-2:SX20220101ABCDEF:ac59dac1460772a04b3a97d7ef78409f28241e3a")
.build();
Response response = client.newCall(request).execute();
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https://developer.kdocs.cn/api/v1/openapi/appspace/files/upload"
payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example.pdf\"\r\nContent-Type: application/pdf\r\n\r\nfileInput.files[0]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"parent_path\"\r\n\r\npath1,path2\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"creator\"\r\n\r\nxxx\r\n-----011000010111000001101001--\r\n")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Date", "Wed, 23 Jan 2013 06:43:08 GMT")
req.Header.Add("Content-Md5", "d41d8cd98f00b204e9800998ecf8427e")
req.Header.Add("Content-Type", "multipart/form-data")
req.Header.Add("Authorization", "WPS-2:SX20220101ABCDEF:ac59dac1460772a04b3a97d7ef78409f28241e3a")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
fmt.Println(res)
fmt.Println(string(body))
}
import http.client
conn = http.client.HTTPSConnection("developer.kdocs.cn")
payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example.pdf\"\r\nContent-Type: application/pdf\r\n\r\nfileInput.files[0]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"parent_path\"\r\n\r\npath1,path2\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"creator\"\r\n\r\nxxx\r\n-----011000010111000001101001--\r\n"
headers = {
'Date': "Wed, 23 Jan 2013 06:43:08 GMT",
'Content-Md5': "d41d8cd98f00b204e9800998ecf8427e",
'Content-Type': "multipart/form-data",
'Authorization': "WPS-2:SX20220101ABCDEF:ac59dac1460772a04b3a97d7ef78409f28241e3a"
}
conn.request("POST", "/api/v1/openapi/appspace/files/upload", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://developer.kdocs.cn/api/v1/openapi/appspace/files/upload",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example.pdf\"\r\nContent-Type: application/pdf\r\n\r\nfileInput.files[0]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"parent_path\"\r\n\r\npath1,path2\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"creator\"\r\n\r\nxxx\r\n-----011000010111000001101001--\r\n",
CURLOPT_HTTPHEADER => [
"Authorization: WPS-2:SX20220101ABCDEF:ac59dac1460772a04b3a97d7ef78409f28241e3a",
"Content-Md5: d41d8cd98f00b204e9800998ecf8427e",
"Content-Type: multipart/form-data",
"Date: Wed, 23 Jan 2013 06:43:08 GMT"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
const data = new FormData();
data.append("file", "fileInput.files[0]");
data.append("parent_path", "path1,path2");
data.append("creator", "xxx");
const xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.addEventListener("readystatechange", function () {
if (this.readyState === this.DONE) {
console.log(this.responseText);
}
});
xhr.open("POST", "https://developer.kdocs.cn/api/v1/openapi/appspace/files/upload");
xhr.setRequestHeader("Date", "Wed, 23 Jan 2013 06:43:08 GMT");
xhr.setRequestHeader("Content-Md5", "d41d8cd98f00b204e9800998ecf8427e");
xhr.setRequestHeader("Authorization", "WPS-2:SX20220101ABCDEF:ac59dac1460772a04b3a97d7ef78409f28241e3a");
xhr.send(data);
const http = require("https");
const options = {
"method": "POST",
"hostname": "developer.kdocs.cn",
"port": null,
"path": "/api/v1/openapi/appspace/files/upload",
"headers": {
"Date": "Wed, 23 Jan 2013 06:43:08 GMT",
"Content-Md5": "d41d8cd98f00b204e9800998ecf8427e",
"Authorization": "WPS-2:SX20220101ABCDEF:ac59dac1460772a04b3a97d7ef78409f28241e3a"
}
};
const req = http.request(options, function (res) {
const chunks = [];
res.on("data", function (chunk) {
chunks.push(chunk);
});
res.on("end", function () {
const body = Buffer.concat(chunks);
console.log(body.toString());
});
});
req.write("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example.pdf\"\r\nContent-Type: application/pdf\r\n\r\nfileInput.files[0]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"parent_path\"\r\n\r\npath1,path2\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"creator\"\r\n\r\nxxx\r\n-----011000010111000001101001--\r\n");
req.end();
CURL *hnd = curl_easy_init();
curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_URL, "https://developer.kdocs.cn/api/v1/openapi/appspace/files/upload");
struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Date: Wed, 23 Jan 2013 06:43:08 GMT");
headers = curl_slist_append(headers, "Content-Md5: d41d8cd98f00b204e9800998ecf8427e");
headers = curl_slist_append(headers, "Content-Type: multipart/form-data");
headers = curl_slist_append(headers, "Authorization: WPS-2:SX20220101ABCDEF:ac59dac1460772a04b3a97d7ef78409f28241e3a");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);
curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example.pdf\"\r\nContent-Type: application/pdf\r\n\r\nfileInput.files[0]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"parent_path\"\r\n\r\npath1,path2\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"creator\"\r\n\r\nxxx\r\n-----011000010111000001101001--\r\n");
CURLcode ret = curl_easy_perform(hnd);
var client = new RestClient("https://developer.kdocs.cn/api/v1/openapi/appspace/files/upload");
var request = new RestRequest(Method.POST);
request.AddHeader("Date", "Wed, 23 Jan 2013 06:43:08 GMT");
request.AddHeader("Content-Md5", "d41d8cd98f00b204e9800998ecf8427e");
request.AddHeader("Content-Type", "multipart/form-data");
request.AddHeader("Authorization", "WPS-2:SX20220101ABCDEF:ac59dac1460772a04b3a97d7ef78409f28241e3a");
request.AddParameter("undefined", "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"example.pdf\"\r\nContent-Type: application/pdf\r\n\r\nfileInput.files[0]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"parent_path\"\r\n\r\npath1,path2\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"creator\"\r\n\r\nxxx\r\n-----011000010111000001101001--\r\n", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
返回示例
{
"code": 0,
"data": {
"file_token": "your_new_file_token"
}
}
错误码
请参考错误码说明