金山文档开放平台

主题

回到顶部
本页内容

匿名预览本地文档 (Beta)

在已取得应用文档权限的情况下，对本地文档进行匿名预览

基本信息

请求方法：POST

请求路径：/api/v1/openapi/anonymous/preview/local/with_token

请求主机：developer.kdocs.cn

限流频次

应用类型限额
测试应用
500 次/天
正式应用
100,000 次/天

权限范围

注意

匿名预览文档接口，需要应用已经具备使用应用文档的权限。应用文档的权限，需要联系我们单独申请。

参数必须类型说明
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" 如果存在该请求头，会使用该值作为 filename，否则使用 form 中的 filename 字段做文档名

Body 参数

提示

该请求为 multipart/form-data 类型请求

参数必须类型说明
file
是
file
目标文档，文档本身
filename
否
string
文档名，要求包含扩展名。例如：demo.doc
download
否
boolean
是否允许用户下载该文档

提示

如果请求头中包含 Content-Disposition 值，优先使用该值做为文档名。否则使用 form 中的 filename 字段作为文档名。

如果两个地方都未取到文档名，会返回 10001 InvalidArgument 错误。

返回参数

参数类型说明
code
integer
错误码
+
data
data {}
响应数据

提示

该接口会创建一个匿名预览应用文档的任务，任务执行结果请通过查询匿名任务接口查询。

示例

请求示例 

curl --request POST \
	--url https://developer.kdocs.cn/api/v1/openapi/anonymous/local/with_token \
	--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 filename=example.pdf

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=\"filename\"\r\n\r\nexample.pdf\r\n-----011000010111000001101001--\r\n");
Request request = new Request.Builder()
	.url("https://developer.kdocs.cn/api/v1/openapi/anonymous/local/with_token")
	.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/anonymous/local/with_token"

	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=\"filename\"\r\n\r\nexample.pdf\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=\"filename\"\r\n\r\nexample.pdf\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/anonymous/local/with_token", 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/anonymous/local/with_token",
	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=\"filename\"\r\n\r\nexample.pdf\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("filename", "example.pdf");

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/anonymous/local/with_token");
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/anonymous/local/with_token",
	"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=\"filename\"\r\n\r\nexample.pdf\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/anonymous/local/with_token");

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=\"filename\"\r\n\r\nexample.pdf\r\n-----011000010111000001101001--\r\n");

CURLcode ret = curl_easy_perform(hnd);

var client = new RestClient("https://developer.kdocs.cn/api/v1/openapi/anonymous/local/with_token");
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=\"filename\"\r\n\r\nexample.pdf\r\n-----011000010111000001101001--\r\n", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

返回示例 

{
  "code": 0,
  "data": {
    "task_id": "open:kvqxrspxjctdojjqdildjhonzwusaquc"
  }
}

错误码

请参考错误码说明