Skip to content
本页内容

获取文档 URL

每个在线文档都有一个 URL 与之对应,在使用 SDK 打开在线文档之前,开发者需要请求业务服务端获取文档的在线地址,URL 生成规则如下:

https://o.wpsgo.com/office/:type/:fileid?_w_tokentype=1&_w_appid=xxx&&xxx(业务方自定义参数)

路径参数

字段说明是否必须描述
type
文件类型
访问的文件类型,见 文件类型说明
fileid
文件 ID
业务方自行定义的文件 ID,见 文件 ID 说明

查询参数

字段说明是否必须描述
_w_appid
应用 ID
应用唯一 ID,在 WebOffice 控制台创建应用后由系统分配
_w_tokentype
token 鉴权类型
如果您的业务场景需要进行 token 校验,则 URL 需要携带_w_tokentype=1, 否则携带 _w_tokentype=0

📢 注意

业务方可通过自定义参数传递, WebOffice 将会在回调接口通过 X-User-QueryHeader 字段中回传编辑链接上的 Query 信息

URL 举例

如果您需要访问的文件的类型为文字文件,文件 ID 为 471eba5030,申请应用的 ID 为 d8f99da,那么其访问地址应该为:

https://o.wpsgo.com/office/w/471eba5030?_w_appid=d8f99da&_w_tokentype=1

FAQ

1. 在哪里获取 APPID?

每个 WebOffice 应用都有全局唯一的 AppID 与之关联,开发者可以在 控制台-总览-应用列表中查看应用的 AppID。

控制台-应用列表

2. type 有哪些可选的值?

type 对应的是 WebOffice 支持的文件格式:word、excel、ppt 以及 pdf,有以下可选的值,详细文档格式说明请参考  WebOffice 格式支持

type格式文件后缀
w
文字文件
doc, dot, wps, wpt, docx, dotx, docm, dotm, rtf
p
演示文件
ppt, pptx, pptm, ppsx, ppsm, pps, potx, potm, dpt, dps
s
表格文件
xls, xlt, et, xlsx, xltx, csv, xlsm, xltm
f
PDF 文件
pdf

3. 生成 fileid 的规则

  • file_id 是由对接企业自己生成并管理,需要保证一个 file_id 对应一个文件,也对应一个文件的多个版本
  • file_id 建议使用字母与数字的格式,使用 #$%^&*_ 或其他特殊符号会引起异常错误