金山文档开放平台

主题

回到顶部
本页内容

创建或更新分享

创建和修改某个文件的分享状态

基本信息

请求方法：POST

请求路径：/api/v1/openapi/personal/files/:file_token/links

请求主机：developer.kdocs.cn

限流频次

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

权限范围

权限值显示名称权限说明
edit_personal_files
访问个人文档
访问用户个人文档列表

注意

创建或修改分享，需要用户具有文档的“编辑分享权限”，通常为文档的所有者或文档所属团队的所有者。其他无权限用户请求该 API 会返回失败（code 10003）。

Path 参数

参数必须类型说明
file_token
是
string
文档 ID

Query 参数

参数必须类型说明
access_token
是
string
访问令牌

Body 参数

参数必须类型说明
range
是
string
分享范围（目前只有一种：anyone 任何人）
status
否
string
open|close 默认为 open，close 则只分享指定人
permission
是
string
分享权限（目前有两种：read 浏览，write 编辑）
ext_perm_list
否
string[]
分享扩展权限（目前只有 comment 评论)
period
否
integer
分享时长，可选值 0/7/30（0：永久有效，7：7 天内有效，30：30 天内有效）
reset
否
boolean
是否重置当前分享（失效已有的，创建一个新的分享）

返回参数

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

示例

请求示例 

curl --request POST \
	--url 'https://developer.kdocs.cn/api/v1/openapi/personal/files/777/links?access_token=kvqxrspxjctdojjqdildjhonzwusaquc' \
	--header 'Content-Type: application/json' \
	--data '{"range":"anyone","permission":"read","period":7,"reset":false,"ext_perm_list":["comment"]}'

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"range\":\"anyone\",\"permission\":\"read\",\"period\":7,\"reset\":false,\"ext_perm_list\":[\"comment\"]}");
Request request = new Request.Builder()
	.url("https://developer.kdocs.cn/api/v1/openapi/personal/files/777/links?access_token=kvqxrspxjctdojjqdildjhonzwusaquc")
	.post(body)
	.addHeader("Content-Type", "application/json")
	.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/personal/files/777/links?access_token=kvqxrspxjctdojjqdildjhonzwusaquc"

	payload := strings.NewReader("{\"range\":\"anyone\",\"permission\":\"read\",\"period\":7,\"reset\":false,\"ext_perm_list\":[\"comment\"]}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	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 = "{\"range\":\"anyone\",\"permission\":\"read\",\"period\":7,\"reset\":false,\"ext_perm_list\":[\"comment\"]}"

headers = { 'Content-Type': "application/json" }

conn.request("POST", "/api/v1/openapi/personal/files/777/links?access_token=kvqxrspxjctdojjqdildjhonzwusaquc", 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/personal/files/777/links?access_token=kvqxrspxjctdojjqdildjhonzwusaquc",
	CURLOPT_RETURNTRANSFER => true,
	CURLOPT_ENCODING => "",
	CURLOPT_MAXREDIRS => 10,
	CURLOPT_TIMEOUT => 30,
	CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
	CURLOPT_CUSTOMREQUEST => "POST",
	CURLOPT_POSTFIELDS => "{\"range\":\"anyone\",\"permission\":\"read\",\"period\":7,\"reset\":false,\"ext_perm_list\":[\"comment\"]}",
	CURLOPT_HTTPHEADER => [
		"Content-Type: application/json"
	],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
	echo "cURL Error #:" . $err;
} else {
	echo $response;
}

const data = JSON.stringify({
	"range": "anyone",
	"permission": "read",
	"period": 7,
	"reset": false,
	"ext_perm_list": [
		"comment"
	]
});

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/personal/files/777/links?access_token=kvqxrspxjctdojjqdildjhonzwusaquc");
xhr.setRequestHeader("Content-Type", "application/json");

xhr.send(data);

const http = require("https");

const options = {
	"method": "POST",
	"hostname": "developer.kdocs.cn",
	"port": null,
	"path": "/api/v1/openapi/personal/files/777/links?access_token=kvqxrspxjctdojjqdildjhonzwusaquc",
	"headers": {
		"Content-Type": "application/json"
	}
};

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(JSON.stringify({
  range: 'anyone',
  permission: 'read',
  period: 7,
  reset: false,
  ext_perm_list: ['comment']
}));
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/personal/files/777/links?access_token=kvqxrspxjctdojjqdildjhonzwusaquc");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "Content-Type: application/json");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\"range\":\"anyone\",\"permission\":\"read\",\"period\":7,\"reset\":false,\"ext_perm_list\":[\"comment\"]}");

CURLcode ret = curl_easy_perform(hnd);

var client = new RestClient("https://developer.kdocs.cn/api/v1/openapi/personal/files/777/links?access_token=kvqxrspxjctdojjqdildjhonzwusaquc");
var request = new RestRequest(Method.POST);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\"range\":\"anyone\",\"permission\":\"read\",\"period\":7,\"reset\":false,\"ext_perm_list\":[\"comment\"]}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

返回示例 

{
  "code": 0,
  "data": {
    "expire_time": 1658904074,
    "ext_perm_list": ["comment"],
    "link_permission": "read",
    "link_url": "https://kdocs.cn/l/cgvAMCMGhZaa",
    "sid": "cgvAMCMGhZaa",
    "filename": "demo.docx"
  }
}

错误码

请参考错误码说明