• 首页
  • 产品
  • 体验一下
  • 价格
  • 客户案例
  • 开发者文档
  • 关于我们
  • 获取测试包及报价

  • 在线咨询

  • 联系我们

永中DCS接口说明
本文列举了永中DCS文档在线预览的详细接口说明及参数说明。

1.服务器上文件的转换

接口地址:/composite/convert

请求方式:POST

参数示例:

参数名参数类型必填参数释义及示例
convertTypeint转换类型
srcRelativePathString源文件相对路径,即 input 的相对路径

2.本地文件上传并转换

接口地址:/composite/upload

请求方式:POST

参数示例:

参数名参数类型必填参数释义及示例
convertTypeint转换类型
fileMultipartFile本地文件对象

3.网络文件下载并转换

接口地址:/composite/httpfile

请求方式:POST

参数示例:

参数名参数类型必填参数释义及示例
convertTypeint转换类型
fileUrlstring网络文件地址

文档格式包括word,excel,ppt三类,格式包括doc、dot、wps、wpt、docx、dotx、docm、dotm、rtf、mht,pptx、ppt、pot、potx、pps、ppsx、dps、dpt、pptm、potm、ppsm,xls、xlt、et、ett、xlsx、xltx、csv、xlsm、xltm

参数值参数值说明
0Word,excel,ppt三类文档格式到高清html页面的转换
2Word,excel,ppt三类文档格式转换成txt文本格式的文件
3Word,excel,ppt三类文档格式转换成pdf文件
5文档格式图片,图片格式包括gif、png、jpg、tiff、bmp
10pdf文档格式转换成图片,图片格式包括gif、png、jpg、tiff、bmp
14pdf文档格式转换成html页面
19压缩文件转换成html页面,压缩文档格式包括zip,rar,7z,tar,gz
20PDF文件转换成html页面
22多个文档合并,只支持office文档并且是同类型文件合并
23图片转换成html页面,图片格式包括png jpg gif bmp svg jpeg
24pdf文档格式转换成txt文本
27office文档格式获取文档页码
28获取pdf文件页码
30office文档格式文档转换成html页面
31多个pdf文档合并
32图片转换成pdf,支持图片格式png、jpg、jpeg、bmp、tiff、svg
33office文档转换成添加水印和书签的office文档
34pdf文件转成成加水印的pdf文档
43office文档转换成uof文件
44图片转换成加水印和不同后缀的图片
54获取所有word文档的书签信息
61文档格式转换成高清html页面canvas,文档格式包括office文件和文本文件
63PDF生成双层PDF
69文档转换成长图,文档包括word、ppt excel,图片格式包括JPG、PNG、BMP、TIF、GIF
71PDF删除文件中某个页面
72PDF文件中的图片提取
73压缩PDF文件
74旋转PDF文件
75PDF加页码
76pdf插入页
77pdf转换成长图,长图格式包括jpg、png
78解密pdf文件
79加密pdf文件
82拆分pdf文件
84ocr图片转word文档,图片只支持png,jpg,jpeg,bmp
85office文档中的图片提取
500html页面原样预览
680CAD文件通过浩辰转换预览,cad文件包括dwg,dwt,dxf
convertTimeOut转换超时时间
convertType转换类型
srcRelativePath源文件相对路径
callBack异步处理情况下的回调接口地址
callType调用方式
noCache是否强制重新转换
fcsCustomData客户自定义参数原样返回
allowFileSize允许转换文件大小
isDelSrc是否删除源文件
isCopy是否防复制
password加密文档密码
isShowList是否显示文档目录
acceptTracks是否显示修订记录
isShowGridline是否显示边框
isShowColWidth是否显示全单元格
allowDownload是否允许源文件下载
allowPreview是否允许预览
file本地文档上传
fileURLurl类型文件上传
num允许次数
time过期时间
wmContent水印内容
wmSize水印文字大小
wmColor水印颜色
wmFont水印字体
wmMargin水印间距
wmTransparency水印透明度
wmRotate水印旋转角度
wmPosition水印的位置px
wmPicSize图片水印大小px
wmPicPath图片水印路径
zipConvertType压缩包内文件高清标清开关
htmlName转换后的标题名称
encoding转换的源文件编码
htmlTitle转换后的html标签名称
page转换页码
pageStart转换起始页
pageEnd转换结束页
zoom缩放比例
mergeInput待合并的文档的相对路径
bookMarkJson添加书签内容
isDownload是否显示源文档下载按钮
sourceReplace源文档需要被替换的文字
targetReplace源文档需要替换成的文字
isDccAsync是否用dcc异步
destFileSuffix转换输出的文件后缀
isSignature是否进入签批模式
srcFileSuffix传入源文件后缀名(用于判断canvas模板)
isFirstImage加入图片水印,设置是否第一页加入
zoomPic高清转换是否高像素(图片是否高像素输出)
isHeaderBar是否显示头部导航栏
isShowComment是否显示备注
isImageLocationword和图片合并时,图片在上方还是下方
fileAngle文件旋转角度
isShowHideSlide是否显示隐藏页
addedScriptPath自定义js引入

errorcode - 返回代码,0 成功,其他失败

message - 详细信息

data - 请求需要返回的数据

返回参数说明:

返回码返回值说明
0转换成功
1找不到指定文档
2无法打开指定文档
3转换操作失败
4转换的文档为加密文档或密码有误,请重新添加password参数进行转换
5输出文档后缀错误
6DCC授权文件过期
7转换超时,请调整转换超时时间
8无效参数
9操作失败
10上传失败
11下载文件失败
12文件过大
15根据文件头信息获取文件Md5失败
16redis操作失败,请联系管理员检查redis服务
17转换类型与文件不匹配,请检查参数
18用户操作无权限
19服务器正忙
20文件操作失败,请联系管理员检查服务器
21生成转换文档md5失败
22服务器未知错误
23生成文件不存在,转换失败
24参数包含非法字符,请检查参数
25需要合并的文档不存在
26图片水印不存在或文件有误,请检查
27异步转换队列已满负荷,请稍后重新发送请求
28http请求发送失败
29MQ Producer发送消息失败
30MQ开关为关闭状态,该功能暂时无法使用
31MQ Consumer监听启动失败
32该接口不支持当前请求Method类型,请查阅API文档
33该接口不支持当前请求参数类型,请检查Content-Type头信息
34view模块文件不存在
35非法请求
36预览失败,请稍后重试
37打包成压缩包失败,请稍后重试
38vToken参数无效,请检查参数
39vToken获取失败
40Redis开关为关闭状态,该功能暂时无法使用
41链接已过期
42vToken不存在
43销毁 vToken失败,请稍后再试
44没有支持的转码服务,请联系永中技术支持
45签批生成失败
46文件已被锁住,提交失败
47fcs授权文件错误,请检查文件
48文档转换中,请稍后
49激活授权码失败
50激活码非法,请检查
51Ocr转换失败
52生成文件无内容
53缓存文件失败
54页码超出可使用范围
55pdf文件不可压缩(convertType=73)
56文件类型暂不支持智能识别,请输入正确的转换参数
58非法文件类型,请联系管理员
59授权已过期,请联系Yozo管理员
62当前无此操作权限,请升级授权
63该功能不可用
404文档里面没有对应的书签

例如:

成功状态下:{ "errorcode":0 ,data:fileInfo 信息…,"message":"转换成功" }

失败状态下: { "result":10, date:”” ,message:"上传失败" }

转换返回 data 部分数据说明:

code转换成功标识,0 表示转换成功
destFileName目标文件名
srcFileName源文件名
srcFileSize源文件大小
destFileSize目标文件大小
convertType转换类型
srcStoragePath源文件相对路径
destStoragePath目标文件的输出目录(相对路径)
convertTime转换时长,单位秒
viewUrl转换成功的预览或下载链接
fcsCustomData客户自定义数据
signaturePath签批相对路径