金山文档开放平台

主题

回到顶部
本页内容

带临时凭证的分享链接

获取已携带临时凭证的分享链接

基本信息

请求方法：GET

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

请求主机：developer.kdocs.cn

限流频次

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

权限范围

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

注意

如果当前文件尚未分享，会返回错误。

注意

获取到分享链接后，当前用户是否有权限预览/编辑，取决于文档当前的分享权限。

Path 参数

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

Query 参数

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

返回参数

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

提示

用户临时凭证，用于在通过金山文档 jssdk 接入时，通过 setToken() 方式设置临时凭证。解决因浏览器限制导致的用户凭证丢失问题。

提示

由于此处返回的是临时凭证，实际项目中，需要结合获取临时编辑凭证接口配合使用。

前端代码示例：

// 获取 token 函数
const refreshToken = () => {
  // 自身业务处理...

  // 可以返回 Promise 或者 return { token, timeout }
  return Promise.resolve({
    token: 'yourToken', // 必需：你需要设置的 token
    timeout: 10 * 60 * 1000 //  必需：token 超时时间，以 10 分钟示例
  })
}

// 配置超时获取 token 函数
const jssdk = WebOfficeSDK.config({ refreshToken })

// 设置 token
jssdk.setToken({
  token: 'yourToken', // 根据自身的业务需求，通过异步请求或者模板输出的方式，取得 token
  timeout: 10 * 60 * 1000 // token 超时时间，可配合 refreshToken 配置函数使用，在超时前调用 refreshToken 重新刷新 token
})

示例

请求示例 

curl --request GET \
	--url 'https://developer.kdocs.cn/api/v1/openapi/personal/files/t2v4Ga8ZUYKc12KGMdEQpBh/links/with_edit_token?access_token=kvqxrspxjctdojjqdildjhonzwusaquc'

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
	.url("https://developer.kdocs.cn/api/v1/openapi/personal/files/t2v4Ga8ZUYKc12KGMdEQpBh/links/with_edit_token?access_token=kvqxrspxjctdojjqdildjhonzwusaquc")
	.get()
	.build();

Response response = client.newCall(request).execute();

package main

import (
	"fmt"
	"net/http"
	"io/ioutil"
)

func main() {

	url := "https://developer.kdocs.cn/api/v1/openapi/personal/files/t2v4Ga8ZUYKc12KGMdEQpBh/links/with_edit_token?access_token=kvqxrspxjctdojjqdildjhonzwusaquc"

	req, _ := http.NewRequest("GET", url, nil)

	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")

conn.request("GET", "/api/v1/openapi/personal/files/t2v4Ga8ZUYKc12KGMdEQpBh/links/with_edit_token?access_token=kvqxrspxjctdojjqdildjhonzwusaquc")

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/t2v4Ga8ZUYKc12KGMdEQpBh/links/with_edit_token?access_token=kvqxrspxjctdojjqdildjhonzwusaquc",
	CURLOPT_RETURNTRANSFER => true,
	CURLOPT_ENCODING => "",
	CURLOPT_MAXREDIRS => 10,
	CURLOPT_TIMEOUT => 30,
	CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
	CURLOPT_CUSTOMREQUEST => "GET",
]);

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

curl_close($curl);

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

const data = null;

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
	if (this.readyState === this.DONE) {
		console.log(this.responseText);
	}
});

xhr.open("GET", "https://developer.kdocs.cn/api/v1/openapi/personal/files/t2v4Ga8ZUYKc12KGMdEQpBh/links/with_edit_token?access_token=kvqxrspxjctdojjqdildjhonzwusaquc");

xhr.send(data);

const http = require("https");

const options = {
	"method": "GET",
	"hostname": "developer.kdocs.cn",
	"port": null,
	"path": "/api/v1/openapi/personal/files/t2v4Ga8ZUYKc12KGMdEQpBh/links/with_edit_token?access_token=kvqxrspxjctdojjqdildjhonzwusaquc",
	"headers": {}
};

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.end();

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "GET");
curl_easy_setopt(hnd, CURLOPT_URL, "https://developer.kdocs.cn/api/v1/openapi/personal/files/t2v4Ga8ZUYKc12KGMdEQpBh/links/with_edit_token?access_token=kvqxrspxjctdojjqdildjhonzwusaquc");

CURLcode ret = curl_easy_perform(hnd);

var client = new RestClient("https://developer.kdocs.cn/api/v1/openapi/personal/files/t2v4Ga8ZUYKc12KGMdEQpBh/links/with_edit_token?access_token=kvqxrspxjctdojjqdildjhonzwusaquc");
var request = new RestRequest(Method.GET);
IRestResponse response = client.Execute(request);

返回示例 

{
  "code": 0,
  "data": {
    "url": "https://appdocs.wpscdn.cn/office/s/t2v4Ga8ZUYKc12KGMdEQpBh",
    "token": {
      "value": "ExchangeToken-wenlvdhdldmnnanortdmrywrvcpwftrvfetobheumqsamdai",
      "expire_at": 1659008671
    }
  }
}

错误码

请参考错误码说明