文档转换 API‑文档转 PDF‑PDF 转文档‑异步文档处理‑文件格式迁移‑转换结果回调推送 API 接口介绍

前言

在办公系统、档案管理、OA 流程、在线文档平台业务中，经常需要实现各类办公文档与 PDF 之间的格式互相转换。不同格式的文档如果依靠本地组件做转换，容易出现排版错乱、字体丢失、兼容性差等问题，同时大文件转换消耗大量服务器资源；同步转换模式还会出现请求超时，无法处理大体积文档。文档转换采用异步处理模式，提交任务后轮询查询结果或者配置回调自动推送，稳定完成文档与 PDF 之间的双向格式转化，满足业务系统的文件处理需求。

核心能力

支持文档转 PDF、PDF 转文档双向转换能力，覆盖常见办公文档与 PDF 之间的格式迁移；
采用异步任务处理机制，提交转换任务后接口即刻返回任务标识，不会因为文件体积大造成请求超时；
提供独立的结果查询接口，可根据任务编号主动轮询获取转换进度以及最终生成的文件资源；
支持配置回调推送服务，转换任务完成后系统主动推送处理结果，无需业务端循环轮询，简化业务开发；
转换过程尽量保留原始文档排版布局、字体、图片、表格等元素，降低格式错乱风险，适配业务档案归档、在线预览等场景。

戳这里查看详情

文档转PDF

Word、Excel、PPT和txt文件转PDF 文件。

请求说明

名称	类型	必须	说明
fileUrl	String	是	源文件地址
watermarkImage	String	否	水印图片，base64或图片url，若需要在转换后的pdf加上图片水印，传入该参数即可
watermarkText	String	否	水印文字，若需要在转换后的pdf加上文字水印，传入该参数即可
watermarkFontName	String	否	文字水印字体，直接传字体的中文名称。支持：宋体、黑体、微软雅黑。默认：黑体
watermarkFontSize	Integer	否	文字水印大小，默认：20
watermarkColor	String	否	文字水印颜色，16进制值，默认：#666666
watermarkTransparency	Double	否	透明度，默认：0.4
watermarkRotation	Integer	否	内容旋转角度, 默认：0
watermarkLocation	String	否	位置，默认：LAY LAY - 平铺 TOP_LEFT - 顶部居左 TOP_CENTER - 顶部居中 TOP_RIGHT - 顶部局右 CENTER_LEFT - 中部居左 CENTER - 居中 CENTER_RIGHT - 中部局右 BOTTOM_LEFT - 底部居左 BOTTOM_CENTER - 底部居中 BOTTOM_RIGHT - 底部局右
callBackUrl	String	否	接入者接收转换结果的接口地址，通过该地址，将转换结果推送至接入者。如果未提供地址，可通过查询转换结果接口查询

返回样例

json 复制代码

{
  "code": 200,
  "msg": "成功",
  "taskNo": "41020892700032664119",
  "data": {
     "convertTaskId": ""//转换任务Id
  }
}

PDF转文档

将PDF转换为Word、PPT、Excel。

请求说明

名称	类型	必须	说明
fileUrl	String	是	目标文件类型
type	String	是	目标文档类型，可选值：docx, doc, pptx, ppt, xlsx, xls
callBackUrl	String	否	接入者接收转换结果的接口地址，通过该地址，将转换结果推送至接入者。如果未提供地址，可通过查询转换结果接口查询

返回样例

json 复制代码

{
  "code": 200,
  "msg": "成功",
  "taskNo": "41020892700032664119",
  "data": {
     "convertTaskId": ""//转换任务Id，用于查询转换结果
  }
}

结果查询

通过convertTaskId获取转换后的文本下载地址进行获取。

请求说明

名称	类型	必须	说明
convertTaskId	String	是	转换任务ID

返回样例

json 复制代码

{
  "code": 200,
  "msg": "成功",
  "taskNo": "41020892700032664119",
  "data": {
     "urls": [""] //下载地址, 有效期10天，请尽快下载
  }
}

结果推送

如果发起文档转换时，提供了参数callBackUrl，转换成功或失败后，将结果推送至接入者提供的callBackUrl。

返回样例

json 复制代码

{
  "code": "200",
  "convertTaskId": "900924122524274511",
  "urls": [
    "https://xxxx.pdf"
  ]
}