概述

... 2023-5-22 大约 1 分钟

# 概述

在完成开发者认证后,根据自身产品需求,再参照输入参数说明确定回调配置、限频配置、自定义参数配置等,即可注册应用。

私有化部署时,客户需要在部署阶段提供回调地址,由腾讯文档的实施人员配置完成后提供 appID 和 appSecret 等参数。

# 输入参数

参数 类型 必填 说明
name string 应用名称
callback_endpoint string 腾讯文档后台调用的第三方系统的地址格式: scheme://host/prefix,scheme: http/https,host: 域名/IP + 端口(可为空),prefix:前缀,可为空示例:https://test.a.com/tdocgw (opens new window)与callback_polaris二选一
domain string array 接入方宿主页面的域名列表
limit_qps int64 预览请求每秒调用次数注意:这个指的是通过前端SDK 获取预览链接的次数,SDK后台会进行限频
limit_pv int64 预览请求的日调用量注意:这个指的是通过前端SDK 获取预览链接的次数,SDK后台会进行限频
custom_args map<string,string> 回调第三方后台时在URL中添加的自定义参数
custom_headers map<string,string> 回调第三方后台时在HTTP Header中添加的自定义参数
callback_polaris string 北极星服务名字,生产环境在Production namespace下,测试环境在Test与callback_polaris二选一
custom_uri struct 自定义回调uri,uri中需要用 "%s"占位符来编码file_id,例如
{
"get_file_info": "/api/websdk/docpreviewgetfiledownloadinfo?fileid=%s",
"get_file_download_info": "/open3rd/docpreviewgetfiledownloadinfo?fileid=%s"
}

# 输出参数

每个应用具有唯一一对 app_id 和 app_secret 用于接入 WebSDK 服务。

参数 类型 说明
app_id string 第三方应用 ID
app_secret stirng 第三方应用密钥
上次编辑于: 2023年8月7日 17:41
贡献者: daleshen , wilenceyao