金山文档开放平台

主题

回到顶部
本页内容

获取临时凭证

获取与当前用户关联的临时凭证信息

基本信息

请求方法：POST

请求路径：/api/v1/openapi/user/edit_token

请求主机：developer.kdocs.cn

注意

该临时凭证一定要与当前获取凭证的用户相匹配，使用不当会导致用户权限泄露。

提示

该接口获取的临时凭证，需要与金山文档提供的 jssdk 一起使用。在需要嵌入 iframe 中打开文档编辑页面的场景中使用。

前端代码示例：

// 获取 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
})

限流频次

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

权限范围

权限值显示名称权限说明
user_basic
用户基本信息
访问用户信息

Query 参数

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

Body 参数

参数必须类型说明
token
否
string
当前使用的临时凭证，如果传递此参数，会将该凭证设置过期

返回参数

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

示例

请求示例 

curl --request POST \
	--url 'https://developer.kdocs.cn/api/v1/openapi/user/edit_token?access_token=kvqxrspxjctdojjqdildjhonzwusaquc' \
	--data '{"token":"ExchangeToken-wenlvdhdldmnnanortdmrywrvcpwftrvfetobheumqsamdax"}'

OkHttpClient client = new OkHttpClient();

MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"token\":\"ExchangeToken-wenlvdhdldmnnanortdmrywrvcpwftrvfetobheumqsamdax\"}");
Request request = new Request.Builder()
	.url("https://developer.kdocs.cn/api/v1/openapi/user/edit_token?access_token=kvqxrspxjctdojjqdildjhonzwusaquc")
	.post(body)
	.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/user/edit_token?access_token=kvqxrspxjctdojjqdildjhonzwusaquc"

	payload := strings.NewReader("{\"token\":\"ExchangeToken-wenlvdhdldmnnanortdmrywrvcpwftrvfetobheumqsamdax\"}")

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

	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 = "{\"token\":\"ExchangeToken-wenlvdhdldmnnanortdmrywrvcpwftrvfetobheumqsamdax\"}"

conn.request("POST", "/api/v1/openapi/user/edit_token?access_token=kvqxrspxjctdojjqdildjhonzwusaquc", payload)

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/user/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 => "POST",
	CURLOPT_POSTFIELDS => "{\"token\":\"ExchangeToken-wenlvdhdldmnnanortdmrywrvcpwftrvfetobheumqsamdax\"}",
]);

$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": "ExchangeToken-wenlvdhdldmnnanortdmrywrvcpwftrvfetobheumqsamdax"
});

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/user/edit_token?access_token=kvqxrspxjctdojjqdildjhonzwusaquc");

xhr.send(data);

const http = require("https");

const options = {
	"method": "POST",
	"hostname": "developer.kdocs.cn",
	"port": null,
	"path": "/api/v1/openapi/user/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.write(JSON.stringify({token: 'ExchangeToken-wenlvdhdldmnnanortdmrywrvcpwftrvfetobheumqsamdax'}));
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/user/edit_token?access_token=kvqxrspxjctdojjqdildjhonzwusaquc");

curl_easy_setopt(hnd, CURLOPT_POSTFIELDS, "{\"token\":\"ExchangeToken-wenlvdhdldmnnanortdmrywrvcpwftrvfetobheumqsamdax\"}");

CURLcode ret = curl_easy_perform(hnd);

var client = new RestClient("https://developer.kdocs.cn/api/v1/openapi/user/edit_token?access_token=kvqxrspxjctdojjqdildjhonzwusaquc");
var request = new RestRequest(Method.POST);
request.AddParameter("undefined", "{\"token\":\"ExchangeToken-wenlvdhdldmnnanortdmrywrvcpwftrvfetobheumqsamdax\"}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

返回示例 

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

错误码

请参考错误码说明