刷新匿名预览用户凭证

在当前使用的匿名凭证过期前，用当前凭证，换取一个新的凭证。

提示

匿名用户凭证默认过期时间为 24 小时，如果要长时间使用，请在原凭证过期前调用该接口换取一个新的凭证。

如果原凭证已经过期，只能重新生成匿名预览任务来获取新的凭证。

基本信息

请求方法：POST

请求路径：/api/v1/openapi/anonymous/token

请求主机：developer.kdocs.cn

限流频次

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

权限范围

提示

匿名凭证接口，不做权限要求。

参数	必须	类型	说明
Date	是	string	使用 `RFC1123` 时间格式的当前时间
Content-Md5	是	string	`HTTP Body` 中数据的 `MD5` 值十六进制表达方式, 必需小写, 如果是 `get` 请求一律使用 `URI` 计算 `MD5`
Content-Type	是	string	目前固定为: `application/json`
Authorization	是	string	"WPS-2:" + `app_id` + ":" + sha1( `app_key` + `Content-Md5` + `Content-Type` + `DATE`)

Body 参数

参数	必须	类型	说明
token	是	string	当前正在使用的凭证，换取新凭证后，会将该 token 过期

返回参数

参数	类型	说明
code	integer	错误码
+ data	data {}	响应数据
value	string	匿名用户凭证
expire_at	integer	匿名凭证过期时间，纪元秒

提示

用户临时凭证，用于在通过金山文档 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
})

示例

请求示例

Shell

curl --request POST \
	--url https://developer.kdocs.cn/api/v1/openapi/anonymous/token \
	--header 'Authorization: WPS-2:SX20220101ABCDEF:ac59dac1460772a04b3a97d7ef78409f28241e3a' \
	--header 'Content-Md5: d41d8cd98f00b204e9800998ecf8427e' \
	--header 'Content-Type: application/json' \
	--header 'Date: Wed, 23 Jan 2013 06:43:08 GMT' \
	--data '{"token":"kvqxrspxjctdojjqdildjhonzwusaquc"}'

Java

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"token\":\"kvqxrspxjctdojjqdildjhonzwusaquc\"}");
Request request = new Request.Builder()
	.url("https://developer.kdocs.cn/api/v1/openapi/anonymous/token")
	.post(body)
	.addHeader("Date", "Wed, 23 Jan 2013 06:43:08 GMT")
	.addHeader("Content-Md5", "d41d8cd98f00b204e9800998ecf8427e")
	.addHeader("Content-Type", "application/json")
	.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/token"

	payload := strings.NewReader("{\"token\":\"kvqxrspxjctdojjqdildjhonzwusaquc\"}")

	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", "application/json")
	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))

}

Python

import http.client

conn = http.client.HTTPSConnection("developer.kdocs.cn")

payload = "{\"token\":\"kvqxrspxjctdojjqdildjhonzwusaquc\"}"

headers = {
    'Date': "Wed, 23 Jan 2013 06:43:08 GMT",
    'Content-Md5': "d41d8cd98f00b204e9800998ecf8427e",
    'Content-Type': "application/json",
    'Authorization': "WPS-2:SX20220101ABCDEF:ac59dac1460772a04b3a97d7ef78409f28241e3a"
    }

conn.request("POST", "/api/v1/openapi/anonymous/token", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
	CURLOPT_URL => "https://developer.kdocs.cn/api/v1/openapi/anonymous/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 => "{\"token\":\"kvqxrspxjctdojjqdildjhonzwusaquc\"}",
	CURLOPT_HTTPHEADER => [
		"Authorization: WPS-2:SX20220101ABCDEF:ac59dac1460772a04b3a97d7ef78409f28241e3a",
		"Content-Md5: d41d8cd98f00b204e9800998ecf8427e",
		"Content-Type: application/json",
		"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 = JSON.stringify({
	"token": "kvqxrspxjctdojjqdildjhonzwusaquc"
});

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/token");
xhr.setRequestHeader("Date", "Wed, 23 Jan 2013 06:43:08 GMT");
xhr.setRequestHeader("Content-Md5", "d41d8cd98f00b204e9800998ecf8427e");
xhr.setRequestHeader("Content-Type", "application/json");
xhr.setRequestHeader("Authorization", "WPS-2:SX20220101ABCDEF:ac59dac1460772a04b3a97d7ef78409f28241e3a");

xhr.send(data);

Node.js

const http = require("https");

const options = {
	"method": "POST",
	"hostname": "developer.kdocs.cn",
	"port": null,
	"path": "/api/v1/openapi/anonymous/token",
	"headers": {
		"Date": "Wed, 23 Jan 2013 06:43:08 GMT",
		"Content-Md5": "d41d8cd98f00b204e9800998ecf8427e",
		"Content-Type": "application/json",
		"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(JSON.stringify({token: 'kvqxrspxjctdojjqdildjhonzwusaquc'}));
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/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: application/json");
headers = curl_slist_append(headers, "Authorization: WPS-2:SX20220101ABCDEF:ac59dac1460772a04b3a97d7ef78409f28241e3a");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\"token\":\"kvqxrspxjctdojjqdildjhonzwusaquc\"}");

CURLcode ret = curl_easy_perform(hnd);

var client = new RestClient("https://developer.kdocs.cn/api/v1/openapi/anonymous/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", "application/json");
request.AddHeader("Authorization", "WPS-2:SX20220101ABCDEF:ac59dac1460772a04b3a97d7ef78409f28241e3a");
request.AddParameter("application/json", "{\"token\":\"kvqxrspxjctdojjqdildjhonzwusaquc\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

返回示例

{
  "code": 0,
  "data": {
    "value": "Anonymous-wenlvdhdldmnnanortdmrywrvcpwftrvfetobheumqsamdai",
    "expire_at": 1659008671
  }
}

错误码

请参考错误码说明

刷新匿名预览用户凭证 #

基本信息 #

限流频次 #

权限范围 #

Header 参数 #

Body 参数 #

返回参数 #

示例 #

请求示例 #

返回示例 #

错误码 #