HiDocs - 预览服务API

预览服务接入API

Hidocs > 预览服务接入 > 详情

文档预览服务参数说明

URL参数（Parameters）

URL参数指以 {参数名}={参数值} 形式拼接到 URL 上的键值对。它以 ? 开头，不同参数之间使用 & 连接。形如 ?p1=v1&p2=v2


参数名参数定义数据类型允许值参数说明
copy定义：是否可复制
适用：word、excel		integer0,10：不可复制
1：可复制(默认)
wmrepeat定义：水印模式
适用：office、pdf、ofd		integer0,10：单行文字水印(默认)
1：平铺水印
wm定义：自定义水印内容string水印内容设置水印文字内容
wmalpha自定义文字水印透明度float0.1-1默认值：0.1
wmfont自定义文字水印大小和字体string60px SimSun默认值：60px SimSun
wmangle自定义文字水印旋转度integer0-360默认值：45
plimit试读页数integer0,N0：不开启试读功能(默认)
填入数值：只显示设置的数值页面
title是否显示标题栏integer0,10：不显示
1：显示(默认)
print是否显示打印按钮integer0,10：不显示
1：显示(默认)
cmenu禁止右键integer0,10：禁止
1：不禁止(默认)
pvtppt预览模式integer0,1,2,30：自适应预览(默认)

1：手机预览模式

2：页面双栏展示预览模式

3：快速播放模式
pdf转为PDF文档预览模式integer0,10：不转为pdf文档预览(默认)
1：转为pdf文档格式预览
pptremotePPT大文件缓存预览模式integer0,10：不启用缓存预览模式(默认)
1：启用缓存预览模式
decrypt文件加密预览模式integer0,10：不启用文件加密预览模式(默认)
1：启用文件加密预览模式
comment是否显示批注内容integer0,10：不显示批注内容(默认)
1：显示批注内容
ver文档版本号string1.0.2对于多版本的文档通过传入文档版本号来保持预览的文档为最新的版本
示例：var=1.0.2
dur预览地址有效期string
设置预览有效期后生成的文档预览地址在超过有效期后将无法访问，有效期支持秒和天
示例：dur=60s；dur=1d
returnurl获取文档预览地址integer0,10：正常预览(默认)
1：返回目标预览地址
此参数可以获取到文档的目标预览地址，防止前端调用的时暴露文档的真实地址


注：文档加密预览与ppt缓存预览 这个两个参数不能同时使用

参数调用示例

https://api.hidocs.cn/api?copy=0&title=0&furl=https://www.hidocs.cn/testfiles/hidocs产品白皮书.docx