同步模式API列表

说明：v6.0.2205版本格式处理所有string类型的限制长度为1024字节，后续版本去除该校验。

格式转换

适用版本>=v6.0.2206.20220615

文件格式进行转换，支持转换格式见《格式转换支持格式2.0》

当前格式转换支持同时转换的并发数为8
文档转换传入密码功能说明
文档转换接口不区分原文件是否支持加密，只要传入密码，密码都会传入内核。
文档转换密码功能，只应在目标文件为PDF时生效，现象如下（以下的输入密码都是用AES+Base64正确加密后传入）
1.原文件不加密，存在以下情况
①word转PDF，输入密码123，转换失败
②excel转PDF，输入密码123，XLS/CSV/UOS转换成功（打开密码123），其他失败
③wpp转PDF，输入密码123，转换成功（打开密码123）
④所有文件转为非PDF格式文件，输入密码123，转换成功，转换后文件不需要密码（符合预期）
2.原文档DOCX，打开密码123（加密后为q0rxZGJ************），编辑密码123456（加密后为q0rxZGJ************），存在以下情况
①转PDF，不输入密码，转换失败，无目标文件生成（符合预期）
②转PDF，输入打开密码123，转换成功，转换后PDF文件需要密码（打开密码123，编辑密码无）
③转PDF，输入编辑密码123456，转换失败，无目标文件生成（符合预期）
④转DOTM，输入密码123，转换失败，无目标文件生成（符合预期）
3.原文档markdown（非Office格式）不加密，转PDF，输入密码123，转换成功，转换后的PDF文件不需要密码

请求说明

请求地址： 配置域名+/open+/api/cps/sync/v1/convert
请求方法： POST
签名方式： WPS-4签名/WPS-4-GM签名

名称	是否必填	说明
Content-Type	是	固定为: `application/json`
Wps-Docs-Date	是	取当前时间, 示例: `Wed, 23 Jan 2013 06:43:08 GMT`
Wps-Docs-Authorization	是	计算方法参考签名说明

请求体（Body）

名称	类型	是否必填	说明
task_id	string	是	任务ID
doc_url	string	是	需要转换的文档下载地址
doc_filename	string	是	文件名，必须带后缀。字符串长度不超过255位。
doc_password	string	否	文档密码。不为空时，会参与转换PDF的过程加密方式：先进行AES/ECB/PKCS5Padding加密，再进行base64加密。示例：123加密后为q0rxZGJ************
target_file_format	string	是	转换后文件格式
with_download_url	bool	否	适用版本 >= v7.1.2406.20240626，是否返回结果文档下载url，默认为false。组件版该参数不生效
et_page_zoom	object	否	表格转换参数
∟ keep_pagezoom	boolean	否	表示是否保持当前客户端的缩放比，true表示保持当前缩放比打印，false表示以100%的缩放比打印，当fit_pagetall或fit_pagewide中有一个为1，或都为1时，该参数不生效(新内核不支持)
∟ fit_pagewide	integer	否	表示是否适配所有行，0表示正常分页打印，1表示不分页，所有行在一页上
∟ fit_pagetall	integer	否	表示是否适配所有列，0表示正常分页打印，1表示不分页，所有列在一页上；当fit_pagetall与fit_pagewide都为1时，表示将所有内容打印到一页上
to_png	object	否	适用版本 >= v7.1.2303.20230322，转换为png的参数
∟ long_pic	boolean	否	仅在文字、演示、PDF格式转png时生效。是否转换为长图。默认为 false，按页导出图片。当 long_pic 为 true 时，必须满足 to_page=-1 或者 from_page 和 to_page 同时非空。备注：转长图目前最大可支持转20页空白文档，在这个基础上，文档的内容越多，转换成功的范围就越小（指最终文件会出现空白页）。建议范围不超过12页。
∟ from_page	int32	否	仅在文字、演示、PDF格式转png时生效。转换起始页，从 1 开始计数。文字、演示、PDF格式转换成PDF和PNG时，能控制输出范围。
∟ to_page	int32	否	仅在文字、演示、PDF格式转png时生效。转换结束页，to_page 需要大于 from_page，to_page也可以指定为 -1，导出到最后一页（全部转换）。备注：目前最大可支持转20页文档。
∟ sheet_index	int32	否	仅在表格 Excel 转换png时生效。指定需要转换的 Sheet，从 1 开始计数。不传，表示转换所有 Sheet
∟ scale	int32	否	适用版本 >= v7.1.2407.20240724，仅在文字、演示、表格格式转png时生效。缩放系数 0 ~ 100, -1 不生效, 100（默认值）:原始比例, 200: 放大1倍
∟ quality	int32	否	适用版本 >= v7.1.2407.20240724，质量系数 0 ~ 100, 指定0可获得较小的压缩文件，指定100可获得较大的未压缩文件，指定-1（默认值）可使用默认设置
to_pdf	object	否	适用版本 >= v7.1.2303.20230322，转换为pdf的参数
∟ jpeg_quality	int32	否	适用版本 >= v7.1.2310.20231018，仅在文字转pdf时生效。设置文档中的图片转为pdf时的质量
∟ from_page	int32	否	仅在文字、演示转pdf时生效。转换起始页，从 1 开始计数。文字、演示、PDF格式转换成PDF和PNG时，能控制输出范围。
∟ to_page	int32	否	仅在文字、演示转pdf时生效。转换结束页，to_page 需要大于 from_page，to_page也可以指定为 -1，导出到最后一页（全部转换）。
∟ sheet_index	int32	否	仅在表格 Excel 转换pdf时生效。指定需要转换的 Sheet，从 1 开始计数。不传，表示转换所有 Sheet
∟ orientation	int32	否	适用版本 >= v7.1.2303.20230921，在表格 Excel 转换pdf时生效。纸张方向，选项: 2 -> 纸张横放; 1 -> 纸张竖放; 输入其他默认纸张竖放；适用版本 >= v7.1.2409.20240925，在文字 Excel 转换pdf时生效。纸张方向，选项: 2 -> 纸张横放; 1 -> 纸张竖放; 其他输入默认保留原版式输出
∟ paper_size	int32	否	适用版本 >= v7.1.2303.20230921， (仅在图片转pdf时生效)指定页面大小：0: A4, 3: A5,传无效参数，默认A4
∟ auto_rotate_paper	bool	否	适用版本 >= v7.1.2303.20230921， (仅在图片转pdf时生效)当使用paper_size指定页面大小时根据图片尺寸，自动使用横向或纵向的纸张，默认true
∟ scale_small_image	bool	否	适用版本 >= v7.1.2303.20230921， (仅在图片转pdf时生效)当使用paper_size指定页面大小时:true: 小图片放大到页面，保持纵横比；false: 小图片居中
∟ center_horizontally	bool	否	适用版本 >= v7.1.2401.20240111， et转pdf，表格部分是水平居中的，默认true
∟ center_vertically	bool	否	适用版本 >= v7.1.2401.20240111， et转pdf，表格部分是垂直居中的，默认true
∟ print_hidden_page	bool	否	适用版本 >= v7.1.2407.20240724， wpp转pdf，是否打印隐藏页，默认true
∟ show_comments	int32	否	适用版本 >= v7.1.2407.20240724， wps转pdf，是否显示评论, 传0表示false，默认为1，传入其他值均视为1
∟ show_ins_and_del	int32	否	适用版本 >= v7.1.2407.20240724， wps转pdf，是否显示插入删除，传0表示false，默认为1，传入其他值均视为1
∟ show_formatting	int32	否	适用版本 >= v7.1.2407.20240724， wps转pdf，是否显示格式修订，传0表示false，默认为1，传入其他值均视为1
∟ user_password	string	否	适用版本 >= v7.1.2407.20240724，文字、表格、演示转pdf，新增用户密码，密码需要进行加密，具体如下，加密方式：先进行AES/ECB/PKCS5Padding加密，示例：123加密后为q0rxZGJ**********（通过getBytes获取字节数组）示例：123加密后为q0rxZGJ**********
∟ calculate_formula	boolean	否	适用版本 >= v7.1.2408.20240821， (仅在表格转pdf时生效)。在导出PDF前先执行公式重算，默认为false
∟ page_setup	boolean	否	适用版本 >= v7.1.2408.20240821， (仅在表格转pdf时生效)。是否配置表格页面参数，默认为false，当to_pdf或et_page_zoom不为空，则默认置为true，否则其他参数不生效
∟ print	bool	否	适用版本 >= v7.1.2411.20241127，是否为打印，非打印请去掉这个参数
∟ revision_mode	uint32	否	适用版本 >= v7.1.2411.20241127，修订显示模式，选项: 0 -> 气泡模式;1 -> 嵌入模式;2-> 混合模式;
web_encoding	string	否	适用版本 >= v7.1.2306.20230621， word转html格式时的文档编码。10008为GB2312，65001为UTF-8。
to_img	object	否	适用版本 >= v7.1.2310.20231018，转换为图片的参数
∟ dpi	int32	否	适用版本 >= v7.1.2310.20231018，仅在pdf转图片时生效。设置转换结果图片的dpi

请求体示例

json

{
  "task_id": "convert1",
  "doc_filename": "filename.docx",
  "doc_url": "http://10.226.45.233/wpspreview/v1_2_100/web-preview/api/download/44af281baba548bcb778bdad2d8a8db1",
  "target_file_format": "png",
  "with_download_url": true,
  "doc_password": "q0rxZGJ************",
  "et_page_zoom": {
    "keep_pagezoom": false,
    "fit_pagewide": 0,
    "fit_pagetall": 0
  },
  "to_png": {
    "long_pic": true,
    "from_page": 1,
    "to_page": 3
  },
  "to_pdf": {
    "jpeg_quality": 70
  },
  "to_img": {
    "dpi": 96
  }
}

响应体（Response）

名称	类型	说明
data	object	返回信息体
∟ download_id	string	下载id
∟ route_key	string	请求`下载接口`时需放在header中
∟ download_url	string	文档下载链接，当with_download_url=true时生效
code	integer	错误码，参照《错误码说明》
msg	string	状态信息
request_time	long	请求时间
request_id	string	请求标识id
response_time	long	响应时间

响应体示例

json

{
  "code": 200,
  "msg": "success",
  "data": {
    "download_id": "08f29188b5c44ee1ae4b65f66ab2ee6d",
    "download_url": "http://10.226.45.233/result",
    "route_key": "0"
  },
  "request_id": "1416040cc1e51f13068f",
  "request_time": 1654792625940,
  "response_time": 1654792626410
}

多书签套用

适用版本>=v6.0.2206.20220615

模板文件支持的格式（template_filename）： DOC、DOT、WPS、WPT、DOCX、DOTX、DOCM、DOTM、RTF、XML、WORD_XML、UOF、UOT
文档样章格式（type=DOCUMENT时，sample_filename支持的格式）： DOC、DOT、WPS、WPT、DOCX、DOTX、DOCM、DOTM、RTF、MHT、MHTML、TXT、HTM、HTML、XML、WORD_XML、UOF、UOT
图片样章格式（type=IMAGE时，sample_filename支持的格式）： EMF、WMF、JPG、JPEG、JPE、PNG、BMP、GIF、TIF、TIFF、WDP、SVG、CGM

请求说明

请求地址： 配置域名+/open+/api/cps/sync/v1/wrapheader
请求方法： POST
签名方式： WPS-4签名/WPS-4-GM签名

请求头（Header）

名称	是否必填	说明
Content-Type	是	固定为: `application/json`
Wps-Docs-Date	是	取当前时间, 示例: `Wed, 23 Jan 2013 06:43:08 GMT`
Wps-Docs-Authorization	是	计算方法参考签名说明

请求体（Body）

名称	类型	是否必填	说明
task_id	string	是	任务ID
template_url	string	是	模板文件地址
template_filename	string	是	模板文件文件名，必须带后缀
expand_bookmark	boolean	否	适用版本 >= v7.1.2306.20230621强制覆盖参数，进行点书签覆盖。默认：false。
use_template_section_property	boolean	否	适用版本 >= v7.1.2307.20230719如果为true，则type为DOCUMENT时使用模板文件的节属性，否则会优先使用正文文件的节属性，默认为false
flatten_source_style	boolean	否	适用版本 >= v7.1.2307.202301123仅用于type=DOCUMENT。true: 如果样式有冲突，则使用模板样式，并将正文文档中的样式的格式差异平铺到内容上。false: 如果样式有冲突，则使用模板中的样式
keep_temple_sec_prop_in_begin	boolean	否	适用版本 >= v7.1.2407.20240724，仅use_template_section_property=false时生效，需要在前插入点使用模板节属性设置为true，默认false
keep_temple_sec_prop_in_end	boolean	否	适用版本 >= v7.1.2407.20240724，仅use_template_section_property=false时生效，需要保留正文的页眉页脚对象(页眉页脚文字、水印、页码等) 则设置为true，默认false
use_sample_header_footer	boolean	否	适用版本 >= v7.1.2407.20240724，仅use_template_section_property=false时生效，需要在后插入点使用模板节属性设置为true，默认false
sample_list	array	是	样章列表，样章数量最多支持100个，版本 >= v7.1.2505.20250626 解除100限制
∟ bookmark	string	是	模板文件中的书签名称，会将样章放到指定的书签位置
∟ type	string	是	样章类型，可选值：`DOCUMENT`：文档 `IMAGE`: 图片`TEXT`:文本
∟ sample_url	string	否	样章文件，当type为`DOCUMENT`、`IMAGE`时，必填
∟ sample_filename	string	否	文件名，当type为`DOCUMENT`、`IMAGE`时，必填，必须带后缀
∟ text	string	否	样章文本，当type是TEXT时，必填

请求体示例

json

{
  "task_id": "wrapheader1",
  "template_url": "http://10.226.45.233/wpspreview/v1_2_100/web-preview/api/download/44af281baba548bcb778bdad2d8a8db1",
  "template_filename": "filename.docx",
  "sample_list": [
    {
      "bookmark": "正文",
      "type": "TEXT",
      "sample_url": "mock",
      "sample_filename": "filename.docx",
      "text": "mock"
    }
  ]
}

响应体（Response）

名称	类型	说明
data	object	返回信息体
∟ download_id	string	下载id
∟ route_key	string	请求`下载接口`时使用
code	integer	错误码，参照《错误码说明》
msg	string	状态信息
request_time	long	请求时间
request_id	string	请求标识id
response_time	long	响应时间

响应体示例

json

{
  "code": 200,
  "msg": "success",
  "data": {
    "download_id": "08f29188b5c44ee1ae4b65f66ab2ee6d",
    "route_key": "0"
  },
  "request_id": "1416040cc1e51f13068f",
  "request_time": 1654792625940,
  "response_time": 1654792626410
}

内容操作

适用版本>=v6.0.2206.20220615

内容操作提供为文档清稿、加文字水印、加图片水印操作的能力：

「清稿」操作支持的文件格式（operate=OFFICE_CLEAN）： DOC、DOT、WPS、WPT、DOCX、DOTX、DOCM、DOTM、RTF、XML、WORD_XML、UOF、UOT
「加水印」操作支持的文档格式（operate=OFFICE_WATERMARK）： DOC、DOT、WPS、WPT、DOCX、DOTX、DOCM、DOTM、RTF、XML、WORD_XML、UOF、UOT、PDF、XLS、XLSX、ET(适用版本 >= v7.1.2409.20240925)
「加水印」操作支持的图片水印格式（operate=OFFICE_WATERMARK时，watermark_filename支持的格式）： EMF、WMF、JPG、JPEG、JPE、PNG、BMP、GIF、TIF、TIFF
「删除水印」操作支持的文档格式（operate=DELETE_WATERMARK）(适用版本 >= v7.1.2409.20240925)： DOC、DOT、WPS、WPT、DOCX、DOTX、DOCM、DOTM、RTF、XML、WORD_XML、UOF、UOT
「控制修订模式」操作支持的文档格式（operate=SET_TRACK_REVISIONS）(适用版本 >= v7.1.2411.20241127)： DOC、DOT、WPS、WPT、DOCX、DOTX、DOCM、DOTM、RTF、XML、WORD_XML、UOF、UOT

当存在多个操作时，原文件格式必须为所有操作支持都支持的格式.

请求说明

请求地址： 配置域名+/open+/api/cps/sync/v1/content/operate
请求方法： POST
签名方式： WPS-4签名/WPS-4-GM签名

请求头（Header）

名称	是否必填	说明
Content-Type	是	固定为: `application/json`
Wps-Docs-Date	是	取当前时间, 示例: `Wed, 23 Jan 2013 06:43:08 GMT`
Wps-Docs-Authorization	是	计算方法参考签名说明

请求体（Body）

名称	类型	是否必填	说明
task_id	string	是	任务ID，不能重复
doc_url	string	是	文档地址
doc_filename	string	是	文件名，必须带后缀
∟ operate	string	是	操作类型，可选值：`OFFICE_CLEAN`：清稿 `OFFICE_WATERMARK`：加水印 `DELETE_WATERMARK`：删除水印(适用版本 >= v7.1.2409.20240925) `SET_TRACK_REVISIONS`：控制修订模式(适用版本 >= v7.1.2411.20241127)
∟ args	object	否	操作参数
∟ clean_options	array	否	清稿可选项，操作类型为`OFFICE_WATERMARK`时，可选填。 `accept_all_revisions`：指定接受所有修订； `delete_all_comments`：删除所有批注； `delete_all_ink`：删除所有墨迹；默认所有参数都存在:`accept_all_revisions`,`delete_all_comments`,`delete_all_ink`
∟ text_watermark	object	否	文字水印，操作类型为OFFICE_WATERMARK时，才有该字段
∟ content	string	是	文字水印时必填文字水印内容
∟ size	integer	否	文字水印字体大小，可取值5到500
∟ color	string	否	文字水印字体颜色十六进制颜色值，例如：`#CC00FF`
∟ transparent	float	否	文字水印透明度取值范围0-1的小数，`0`：完全透明，`1`：不透明默认值：0.5
∟ tilt	boolean	否	是否倾斜45度，默认false
∟ position	string	否	水印位置（对表格 Excel文件不生效），可选值：`TOP_LEFT`：顶部靠左 `TOP_CENTER`：顶部中间 `TOP_RIGHT`：顶部靠右 `CENTER_LEFT`：中间靠左 `CENTER`：正中 `CENTER_RIGHT`：中间靠右 `BOTTOM_LEFT`：底部靠左 `BOTTOM_CENTER`：底部中间 `BOTTOM_RIGHT`：底部靠右 `CUSTOM`：自定义坐标位置（适用版本 >= v7.1.2412.20241226）默认值：`CENTER`
∟ tiled	boolean	否	水印是否平铺，默认false（对表格 Excel文件不生效，默认为true）
∟ text_font_name	string	否	适用版本 >= v7.1.2305.20230529pdf文字水印支持自定义字体，默认：汉仪楷体KW
∟ bold	boolean	否	适用版本 >= v7.1.2305.20230529pdf文字水印支持字体加粗，默认：false
∟ text_h_coord	float	否	适用版本 >= v7.1.2412.20241226当`postion`为CUSTOM时生效。水平方向坐标单位（cm），默认值为0；输入参数范围±56.30（不同纸张大小下一样），仅文字组件生效
∟ text_v_coord	float	否	适用版本 >= v7.1.2412.20241226当`postion`为CUSTOM时生效。垂直方向坐标单位（cm），默认值为0；输入参数范围±56.30（不同纸张大小下一样），仅文字组件生效
∟ image_watermark	object	否	图片水印，操作类型为`OFFICE_WATERMARK`时，才有该字段
∟ watermark_url	string	是	图片水印时必填水印图片地址
∟ watermark_filename	string	是	图片水印时必填图片水印的文件名，必须带后缀
∟ no_washout	boolean	否	是否取消冲蚀，WPS水印的冲蚀效果参数为：亮度0.85，对比度0.15，默认true
∟ tilt	boolean	否	是否倾斜45度，默认false（对表格 Excel文件不生效）
∟ position	string	否	水印位置（对表格 Excel文件不生效），可选值：`TOP_LEFT`：顶部靠左 `TOP_CENTER`：顶部中间 `TOP_RIGHT`：顶部靠右 `CENTER_LEFT`：中间靠左 `CENTER`：正中 `CENTER_RIGHT`：中间靠右 `BOTTOM_LEFT`：底部靠左 `BOTTOM_CENTER`：底部中间 `BOTTOM_RIGHT`：底部靠右 `CUSTOM`：自定义坐标位置（适用版本 >= v7.1.2412.20241226）默认值：`CENTER`
∟ transparent	float	否	适用版本>=v7.1.2307.20230719图片水印透明度取值范围0-1的小数，`0`：完全透明，`1`：不透明（只适用于pdf文件，默认1）
∟ tiled	boolean	否	水印是否平铺，默认false（对表格 Excel文件不生效，默认为true）
∟ scale	float	否	水印图片缩放比例，0.1-5，默认：1（对表格 Excel文件不生效）
∟ image_h_coord	float	否	适用版本 >= v7.1.2412.20241226当`postion`为CUSTOM时生效。水平方向坐标单位（cm），默认值为0；输入参数范围±56.30（不同纸张大小下一样），仅文字组件生效
∟ image_v_coord	float	否	适用版本 >= v7.1.2412.20241226当`postion`为CUSTOM时生效。垂直方向坐标单位（cm），默认值为0；输入参数范围±56.30（不同纸张大小下一样），仅文字组件生效
∟ set_track_revisions	bool	否	控制修订模式可选项，操作类型为`SET_TRACK_REVISIONS`时，可选填。 `set_track_revisions`为true时开启修订，false关闭修订

请求体示例

json

{
  "task_id": "officeoperate_1",
  "scene_id": "app_scene_id",
  "doc_url": "http://10.226.20.105/wpsupdate/%E6%A0%B7%E7%AB%A0/%E6%96%87%E4%BB%B6/%E7%BA%A2%E5%A4%B4%E6%A8%A1%E6%9D%BF%EF%BC%88%E5%85%AC%E6%96%87%EF%BC%89.docx",
  "doc_filename": "filename.docx",
  "steps": [
    {
      "operate": "OFFICE_CLEAN",
      "args": {
        "clean_options": ["accept_all_revisions"]
      }
    },
    {
      "operate": "OFFICE_WATERMARK",
      "args": {
        "text_watermark": {
          "content": "水印",
          "size": 25,
          "color": "#CC00FF",
          "transparent": 0.4,
          "tilt": true,
          "position": "TOP_CENTER",
          "tiled": true
        },
        "image_watermark": {
          "watermark_url": "http://10.226.20.105/wpsupdate/%E6%A0%B7%E7%AB%A0/%E5%9B%BE%E7%89%87/%E6%B0%B4%E5%8D%B0_%E9%95%BF%E6%96%B9%E5%BD%A2.png",
          "watermark_filename": "水印.jpg",
          "no_washout": false,
          "tilt": true,
          "position": "CENTER",
          "tiled": true,
          "scale": 2
        }
      }
    }
  ]
}

响应体（Response）

名称	类型	说明
data	object	返回信息体
∟ download_id	string	下载id
∟ route_key	string	请求`下载接口`时使用
code	integer	错误码，参照《错误码说明》
msg	string	状态信息
request_time	long	请求时间
request_id	string	请求标识id
response_time	long	响应时间

响应体示例

json

{
  "code": 200,
  "msg": "success",
  "data": {
    "download_id": "08f29188b5c44ee1ae4b65f66ab2ee6d",
    "route_key": "0"
  },
  "request_id": "1416040cc1e51f13068f",
  "request_time": 1654792625940,
  "response_time": 1654792626410
}

文档合并

适用版本>=v6.0.2206.20220615

文档合并只支持同类型文档合并，合并后文档格式默认以第一个文件格式为准（存在XLSX文件时，默认以XLSX文件格式为准）

文档类型	格式
文字	`DOC`、`DOCX`、`WPS`
表格	`XLS`、`XLSX`
演示	`PPT`、`PPTX`
版式	`PDF`、`OFD`

一次最大合并文档数为10，不支持相同doc_url文件合并

请求说明

请求地址： 配置域名+/open+/api/cps/sync/v1/merge
请求方法： POST
签名方式： WPS-4签名/WPS-4-GM签名

请求头（Header）

名称	是否必填	说明
Content-Type	是	固定为: `application/json`
Wps-Docs-Date	是	取当前时间, 示例: `Wed, 23 Jan 2013 06:43:08 GMT`
Wps-Docs-Authorization	是	计算方法参考签名说明

请求体（Body）

名称	类型	是否必填	说明
task_id	string	是	任务ID
separator	string	否	适用版本 >= v7.1.2408.20240821，仅在文字组件生效，只能填写paragraph_break，section_break，section_break_continuous，line_break以及page_break，默认page_break
merged_file_list	array	是	待合并文档列表，文档数必须在2-10之间
∟ doc_url	string	是	文档地址，暂不支持相同文件合并
∟ doc_filename	string	是	文件名，必须带后缀
∟ start	integer	否	待合并文档的起始页码，从1开始。默认从文档第一页开始
∟ end	integer	否	待合并文档的结束页码，默认取文档最后一页

请求体示例

json

{
  "task_id": "merge1",
  "merged_file_list": [
    {
      "doc_url": "http://10.226.45.233/wpspreview/v1_2_100/web-preview/api/download/45a392629ce944adbebd6369a04bf2a9",
      "doc_filename": "filename.docx",
      "start": 1,
      "end": 12
    },
    {
      "doc_url": "http://10.226.45.233/wpspreview/v1_2_100/web-preview/api/download/45a392629ce944adbebd6369a04bf2a9",
      "doc_filename": "filename.docx",
      "start": 1,
      "end": 12
    }
  ]
}

响应体（Response）

名称	类型	说明
data	object	返回信息体
∟ download_id	string	下载id
∟ route_key	string	请求`下载接口`时使用
code	integer	错误码，参照《错误码说明》
msg	string	状态信息
request_time	long	请求时间
request_id	string	请求标识id
response_time	long	响应时间

响应体示例

json

{
  "code": 200,
  "msg": "success",
  "data": {
    "download_id": "08f29188b5c44ee1ae4b65f66ab2ee6d",
    "route_key": "0"
  },
  "request_id": "1416040cc1e51f13068f",
  "request_time": 1654792625940,
  "response_time": 1654792626410
}

文档拆分

适用版本>=v6.0.2206.20220615

文档拆分支持的文件格式： DOC、DOCX、WPS、PPT、PPTX、XLS、XLSX、PDF

请求说明

请求地址： 配置域名+/open+/api/cps/sync/v1/split
请求方法： POST
签名方式： WPS-4签名/WPS-4-GM签名

请求头（Header）

名称	是否必填	说明
Content-Type	是	固定为: `application/json`
Wps-Docs-Date	是	取当前时间, 示例: `Wed, 23 Jan 2013 06:43:08 GMT`
Wps-Docs-Authorization	是	计算方法参考签名说明

请求体（Body）

名称	类型	是否必填	说明
task_id	string	是	任务ID
doc_url	string	是	文档地址
doc_filename	string	是	文件名，必须带后缀
type	string	是	拆分类型，枚举：AVERAGE：平均拆分 RANGE：范围拆分
average	object	否	type=AVERAGE时必填，平均拆分，每几页拆分成一个文档
∟ size	integer	否	平均多少页拆分成一个文档，默认1
∟ split_range	object	否	拆分范围，默认全文档
∟ start	integer	否	开始页码，从1开始
∟ end	integer	否	结束页码，需要大于开始页码
ranges	array	否	type=RANGE时必填，范围拆分，多少范围拆分成一个文档
∟ start	integer	否	开始页码，从1开始
∟ end	integer	否	结束页码，需要大于开始页码

请求体示例

json

{
  "task_id": "split1", //类型：String  必有字段  备注：任务id
  "doc_url": "http://10.226.45.233/wpspreview/v1_2_100/web-preview/api/download/45a392629ce944adbebd6369a04bf2a9", //类型：String  必有字段  备注：文档地址
  "doc_filename": "filename.docx", //类型：String  必有字段  备注：文件名，必须带后缀
  "type": "AVERAGE", //类型：String  必有字段  备注：拆分类型，枚举：AVERAGE, RANGE
  "average": {
    //类型：Object  可有字段  备注：type=AVERAGE时必填，平均拆分
    "size": 1, //类型：Number  必有字段  备注：平均多少页拆分成一个文档
    "split_range": {
      //类型：Object  可有字段  备注：拆分范围
      "start": 1, //类型：Number  可有字段  备注：开始页码，从1开始
      "end": 12 //类型：Number  可有字段  备注：结束页码
    }
  },
  "ranges": [
    //类型：Array  可有字段  备注：type=RANGE时必填，范围拆分
    {
      //类型：Object  可有字段  备注：无
      "start": 1, //类型：Number  必有字段  备注：开始页码，从1开始
      "end": 2 //类型：Number  必有字段  备注：结束页码
    },
    {
      //类型：Object  可有字段  备注：无
      "start": 3, //类型：Number  必有字段  备注：开始页码，从1开始
      "end": 4 //类型：Number  必有字段  备注：结束页码
    }
  ]
}

响应体（Response）

名称	类型	说明
data	object	返回信息体
∟ download_id	string	下载id
∟ route_key	string	请求`下载接口`时使用
code	integer	错误码，参照《错误码说明》
msg	string	状态信息
request_time	long	请求时间
request_id	string	请求标识id
response_time	long	响应时间

响应体示例

json

{
  "code": 200,
  "msg": "success",
  "data": {
    "download_id": "08f29188b5c44ee1ae4b65f66ab2ee6d",
    "route_key": "0"
  },
  "request_id": "1416040cc1e51f13068f",
  "request_time": 1654792625940,
  "response_time": 1654792626410
}

限制编辑

适用版本>=v6.0.2206.20220615

支持格式： DOCX、DOTM、DOCM

请求说明

请求地址： 配置域名+/open+/api/cps/sync/v1/set/bookmarkpermissions
请求方法： POST
签名方式： WPS-4签名/WPS-4-GM签名

请求头（Header）

名称	是否必填	说明
Content-Type	是	固定为: `application/json`
Wps-Docs-Date	是	取当前时间, 示例: `Wed, 23 Jan 2013 06:43:08 GMT`
Wps-Docs-Authorization	是	计算方法参考签名说明

请求体（Body）

名称	类型	是否必填	说明
task_id	string	是	任务ID
doc_filename	string	是	文件名，必须带后缀
doc_url	string	是	文件下载地址，支持`DOCX`、`DOTM`、`DOCM`格式
all_editable	boolean	否	设置所有存在的书签可编辑或不可编辑，bookmark_permissions和all_editable选项只能二选一，且必须设置其中一个值
bookmark_permissions	array	否	设置书签可编辑或不可编辑，bookmark_permissions和all_editable选项只能二选一，且必须设置其中一个值
∟ name	string	是	书签名
∟ editable	boolean	否	是否可编辑,true为可编辑，false为不可编辑，默认为false

请求体示例

json

{
  "task_id": "convert1",
  "doc_filename": "filename.docx",
  "doc_url": "http://10.226.45.233/wpspreview/v1_2_100/web-preview/api/download/44af281baba548bcb778bdad2d8a8db1",
  "all_editable": true,
  "bookmark_permissions": [
    {
      "name": "bookmark name1",
      "editable": true
    },
    {
      "name": "bookmark name2",
      "editable": false
    }
  ]
}

响应体（Response）

名称	类型	说明
data	object	返回信息体
∟ download_id	string	下载id
∟ route_key	string	请求`下载接口`时使用
code	integer	错误码，参照《错误码说明》
msg	string	状态信息
request_time	long	请求时间
request_id	string	请求标识id
response_time	long	响应时间

响应体示例

json

{
  "code": 200,
  "msg": "success",
  "data": {
    "download_id": "08f29188b5c44ee1ae4b65f66ab2ee6d",
    "route_key": "0"
  },
  "request_id": "1416040cc1e51f13068f",
  "request_time": 1654792625940,
  "response_time": 1654792626410
}

查询书签

适用版本>=v6.0.2206.20220615

tip:书签内容如果有对象，会导致查询到的书签内容存在特殊字符。最终生成的目标文件是个json文件。

支持格式： DOC、DOT、WPS、WPT、DOCX、DOTX、DOCM、DOTM、RTF、XML、WORD_XML、UOF、UOT

请求说明

请求地址： 配置域名+/open+/api/cps/sync/v1/query/bookmark
请求方法： POST
签名方式： WPS-4签名/WPS-4-GM签名

请求头（Header）

名称	是否必填	说明
Content-Type	是	固定为: `application/json`
Wps-Docs-Date	是	取当前时间, 示例: `Wed, 23 Jan 2013 06:43:08 GMT`
Wps-Docs-Authorization	是	计算方法参考签名说明

请求体（Body）

名称	类型	是否必填	说明
task_id	string	是	任务ID
doc_url	string	是	文件地址
doc_filename	string	是	文件名，必须带后缀
bookmark_type	string	否	书签类型，枚举：`all`-所有书签 `range`-范围书签 `insertpoint`-插入点书签，默认`all`。
bookmark_name	string	否	书签名称，精确匹配。校验规则：必须由字母、数字、中文或下划线组成，首字母不能为数字或下划线。匹配时会忽略前后空格，匹配正则`^(?!(\d

请求体示例

json

{
  "task_id": "officeoperate_1",
  "doc_url": "mock",
  "doc_filename": "mock",
  "bookmark_type": "ALL",
  "bookmark_name": "mock"
}

响应体（Response）

名称	类型	说明
data	object	返回信息体
∟ download_id	string	下载id
∟ route_key	string	请求`下载接口`时使用
code	integer	错误码，参照《错误码说明》
msg	string	状态信息
request_time	long	请求时间
request_id	string	请求标识id
response_time	long	响应时间

响应体示例

json

{
  "code": 200,
  "msg": "success",
  "data": {
    "download_id": "08f29188b5c44ee1ae4b65f66ab2ee6d",
    "route_key": "0"
  },
  "request_id": "1416040cc1e51f13068f",
  "request_time": 1654792625940,
  "response_time": 1654792626410
}

查询只读/可编辑书签

适用版本>=v6.0.2206.20220615

支持格式： DOCX、DOTX、DOCM

请求说明

请求地址： 配置域名+/open+/api/cps/sync/v1/query/bookmarkpermissions
请求方法： POST
签名方式： WPS-4签名/WPS-4-GM签名

请求头（Header）

名称	是否必填	说明
Content-Type	是	固定为: `application/json`
Wps-Docs-Date	是	取当前时间, 示例: `Wed, 23 Jan 2013 06:43:08 GMT`
Wps-Docs-Authorization	是	计算方法参考签名说明

请求体（Body）

名称	类型	是否必填	说明
task_id	string	是	任务ID
doc_filename	string	是	文件名，必须带后缀
doc_url	string	是	文件下载地址
is_editable	boolean	是	查询文档的书签是否可编辑,true为可编辑，false为不可编辑

请求体示例

json

{
  "task_id": "bookmarkpermissions",
  "doc_filename": "filename.docx",
  "doc_url": "http://10.226.45.233/wpspreview/v1_2_100/web-preview/api/download/44af281baba548bcb778bdad2d8a8db1",
  "is_editable": true
}

响应体（Response）

名称	类型	说明
data	object	返回信息体
∟ download_id	string	下载id
∟ route_key	string	请求`下载接口`时使用
code	integer	错误码，参照《错误码说明》
msg	string	状态信息
request_time	long	请求时间
request_id	string	请求标识id
response_time	long	响应时间

响应体示例

json

{
  "code": 200,
  "msg": "success",
  "data": {
    "download_id": "08f29188b5c44ee1ae4b65f66ab2ee6d",
    "route_key": "0"
  },
  "request_id": "1416040cc1e51f13068f",
  "request_time": 1654792625940,
  "response_time": 1654792626410
}

文档加解密

适用版本>=v6.0.2206.20220629

文件加解密是经由WPS客户端内核加解密处理，和OFFICE存在一定兼容性问题，详细见下表：

文件格式	加密后支持WPS打开	加密后支持OFFICE打开
DOC	支持	支持
DOCX	支持	不支持
DOT	支持	支持
WPT	支持	/
DOTX	支持	不支持
DOCM	支持	不支持
DOTM	支持	不支持
WPS	支持	/
XLS	支持	支持
XLT	支持	支持
ET	支持	/
ETT	支持	/
XLSX	支持	支持
XLTX	支持	支持
XLSM	支持	支持
XLTM	支持	支持
PPTX	支持	支持
PPT	支持	不支持
POT	支持	支持
POTX	支持	不支持
PPS	支持	支持
PPSX	支持	不支持
DPS	支持	/
DPT	支持	/
PPTM	支持	不支持
POTM	支持	不支持
PPSM	支持	不支持

1、文字格式经接口加密后使用office客户端打开失败，可以更改后缀为doc，输入密码后格式可以打开成功 2、表格格式经接口加密后使用office客户端打开失败，可以更改后缀为xls，输入密码后格式可以打开成功 3、演示格式经接口加密后使用office客户端打开失败，可以更改后缀为ppt格式，输入密码后可以打开成功 4、“/”表示微软客户端自身不支持打开该类型文件

请求说明

请求地址： 配置域名+/open+/api/cps/sync/v1/password
请求方法： POST
签名方式： WPS-4签名/WPS-4-GM签名

请求头（Header）

名称	是否必填	说明
Content-Type	是	固定为: `application/json`
Wps-Docs-Date	是	取当前时间, 示例: `Wed, 23 Jan 2013 06:43:08 GMT`
Wps-Docs-Authorization	是	计算方法参考签名说明

请求体（Body）

名称	类型	是否必填	说明
task_id	string	是	任务ID
doc_filename	string	是	文件名，必须带后缀
doc_url	string	是	文件下载地址
origin_open_password	string	否	文档打开密码，不能超过128位。如果文档有打开密码，则该项必填，且密码必须正确，否则将导致任务失败。密码需要进行加密，具体如下，加密方式：先进行AES/ECB/PKCS5Padding加密，示例：123加密后为q0rxZGJ************
new_open_password	string	否	为文档设置新的打开密码，不能超过128位，为空或空字符串时表示不修改密码。密码需要进行加密，具体如下，加密方式：先进行AES/ECB/PKCS5Padding加密，示例：123加密后为q0rxZGJ**********（通过getBytes获取字节数组）示例：123加密后为q0rxZGJ**********
new_edit_password	string	否	为文档设置新的编辑密码，不能超过15位，为空或空字符串时表示删除编辑密码。密码需要进行加密，具体如下，加密方式：先进行AES/ECB/PKCS5Padding加密，示例：123加密后为q0rxZGJ************
remove_open_password	boolean	否	是否删除打开密码，如果为true，则忽略new_open_password
remove_edit_password	boolean	否	是否删除编辑密码，如果为true，则忽略new_edit_password

请求体示例

json

{
  "task_id": "convert1",
  "doc_filename": "filename.docx",
  "doc_url": "http://10.226.45.233/wpspreview/v1_2_100/web-preview/api/download/44af281baba548bcb778bdad2d8a8db1",
  "origin_open_password": "q0rxZGJ************",
  "new_open_password": "q0rxZGJ************",
  "new_edit_password": "q0rxZGJ************",
  "remove_open_password": true,
  "remove_edit_password": true
}

响应体（Response）

名称	类型	说明
data	object	返回信息体
∟ download_id	string	下载id
∟ route_key	string	请求`下载接口`时需放在header中
code	integer	错误码，参照《错误码说明》
msg	string	状态信息
request_time	long	请求时间
request_id	string	请求标识id
response_time	long	响应时间

响应体示例

json

{
  "code": 200,
  "msg": "success",
  "data": {
    "download_id": "08f29188b5c44ee1ae4b65f66ab2ee6d",
    "route_key": "0"
  },
  "request_id": "1416040cc1e51f13068f",
  "request_time": 1654792625940,
  "response_time": 1654792626410
}

图片操作

适用版本>=v6.0.2206.20220615

支持的文件格式： JPEG、JPG、PNG、BMP
说明：图片操作前后的图片像素不能超过4096 _ 8640_ 2

请求说明

请求地址： 配置域名+/open+/api/cps/sync/v1/image/operate
请求方法： POST
签名方式： WPS-4签名/WPS-4-GM签名

请求头（Header）

名称	是否必填	说明
Content-Type	是	固定为: `application/json`
Wps-Docs-Date	是	取当前时间, 示例: `Wed, 23 Jan 2013 06:43:08 GMT`
Wps-Docs-Authorization	是	计算方法参考签名说明

请求体（Body）

名称	类型	是否必填	说明
task_id	string	是	任务ID，不能重复
image_url	string	是	图片地址
image_filename	string	是	图片名称，必须带后缀
scale	float	否	缩放百分比，默认1不缩放，如果高度和宽度大于0则以高度宽度等比缩放
width	integer	否	整数（小数会自动取整），图片宽度，如果宽度大于0则以图片宽度为标准等比缩放
height	integer	否	整数（小数会自动取整），图片高度，如果图片宽度小于0，高度大于0，则以高度为标准等比缩放
rotate	integer	否	图片旋转角度（大于0表示顺时针旋转），建议旋转角度为90的倍数
quality	float	否	图片质量，范围0-1，只能修改JPG/JPEG图片质量
horizontal_flip	boolean	否	水平翻转
vertical_flip	boolean	否	垂直翻转
text_watermark	object	否	文字水印
∟ content	string	是	文字水印时必填文字水印内容
∟ font_name	string	否	字体名称
∟ bold	boolean	否	是否加粗
∟ italic	boolean	否	是否斜体
∟ size	integer	否	字体大小，取值5-500，默认：`25`
∟ color	string	否	字体颜色，16进制颜色值，例如：`#AAAAAA`，默认：`#000000`
∟ transparent	float	否	透明度 0-1，0完全透明，默认：`1`
∟ rotate	integer	否	旋转角度，单位`°`，默认：`+45`
∟ position	string	否	水印位置，可选值：`TOP_LEFT`：顶部靠左 `TOP_CENTER`：顶部中间 `TOP_RIGHT`：顶部靠右 `CENTER_LEFT`：中间靠左 `CENTER`：正中 `CENTER_RIGHT`：中间靠右 `BOTTOM_LEFT`：底部靠左 `BOTTOM_CENTER`：底部中间 `BOTTOM_RIGHT`：底部靠右默认值：`CENTER`
∟ tiled	boolean	否	水印是否平铺，平铺时水印位置无效，默认false
image_watermark	object	否	图片水印
∟ watermark_url	string	是	图片水印时必填水印图片地址
∟ watermark_filename	string	是	图片水印时必填图片水印的文件名，必须带后缀
∟ transparent	float	否	透明度 0-1，0完全透明，默认：`1`
∟ rotate	integer	否	旋转角度，单位`°`，默认：`+45`
∟ position	string	否	水印位置，可选值：`TOP_LEFT`：顶部靠左 `TOP_CENTER`：顶部中间 `TOP_RIGHT`：顶部靠右 `CENTER_LEFT`：中间靠左 `CENTER`：正中 `CENTER_RIGHT`：中间靠右 `BOTTOM_LEFT`：底部靠左 `BOTTOM_CENTER`：底部中间 `BOTTOM_RIGHT`：底部靠右默认值：`CENTER`
∟ tiled	boolean	否	水印是否平铺，平铺时水印位置无效，默认：false
∟ scale	float	否	水印图片缩放比例，0.1-5，默认：1。tiled为true时，该参数无效。

请求体示例

json

{
  "task_id": "1",
  "image_url": "http://10.226.45.233/wpspreview/v1_2_100/web-preview/api/download/3702675b63b64b9dbb9acbc6c819b905",
  "image_filename": "图片.jpg",
  "scale": 0.5,
  "width": 0,
  "height": 0,
  "rotate": 0,
  "quality": 1,
  "horizontal_flip": true,
  "vertical_flip": false,
  "text_watermark": {
    "content": "文字水印",
    "font_name": "mock",
    "bold": true,
    "italic": true,
    "size": 25,
    "color": "#DC143C",
    "transparent": 0.7,
    "rotate": 0,
    "position": "CENTER",
    "tiled": true
  },
  "image_watermark": {
    "watermark_url": "http://10.226.45.233/wpspreview/v1_2_100/web-preview/api/download/66cb2d87d05f4c908c580a971a2f9843",
    "watermark_filename": "水印.jpg",
    "transparent": 0.7,
    "rotate": 0,
    "position": "CENTER",
    "tiled": true,
    "scale": 1
  }
}

响应体（Response）

名称	类型	说明
data	object	返回信息体
∟ download_id	string	下载id
∟ route_key	string	请求`下载接口`时使用
code	integer	错误码，参照《错误码说明》
msg	string	状态信息
request_time	long	请求时间
request_id	string	请求标识id
response_time	long	响应时间

响应体示例

json

{
  "code": 200,
  "msg": "success",
  "data": {
    "download_id": "08f29188b5c44ee1ae4b65f66ab2ee6d",
    "route_key": "0"
  },
  "request_id": "1416040cc1e51f13068f",
  "request_time": 1654792625940,
  "response_time": 1654792626410
}

在线解压

适用版本>=v7.1.2303.20230322

支持的文件格式： TAR、ZIP、7Z、GZ、RAR、JAR

请求说明

请求地址： 配置域名+/open+/api/cps/sync/v1/decompression
请求方法： POST
签名方式： WPS-4签名/WPS-4-GM签名

请求头（Header）

名称	是否必填	说明
Content-Type	是	固定为: `application/json`
Wps-Docs-Date	是	取当前时间, 示例: `Wed, 23 Jan 2013 06:43:08 GMT`
Wps-Docs-Authorization	是	计算方法参考签名说明

请求体（Body）

名称	类型	是否必填	说明
task_id	string	是	任务ID，不能重复
doc_url	string	是	文件下载地址
doc_filename	string	是	文件名，必须带后缀
password	string	否	压缩包打开密码，不能超过128位。如果文档有打开密码，则该项必填，且密码必须正确，否则将导致任务失败。密码需要进行加密，具体如下，加密方式：先进行AES/ECB/PKCS5Padding加密，示例：123加密后为q0rxZGJ************

请求体示例

json

{
  "task_id": "1",
  "doc_url": "http://10.226.45.233/wpspreview/v1_2_100/web-preview/api/download/3702675b63b64b9dbb9acbc6c819b905",
  "doc_filename": "图片.zip",
  "password": "q0rxZGJ************"
}

响应体（Response）

名称	类型	说明
data	object	返回信息体
∟ decompression_file_list	object[]	压缩包中的文件列表
∟ download_id	string	下载id，directory为false时返回
∟ size	string	文件大小
∟ name	string	文件/文件夹名称
∟ directory	boolean	是否文件夹
∟ modify_time	long	最后修改时间
∟ list_files	object[]	文件夹中的文件列表，directory为true时存在
∟ route_key	string	请求`下载接口`时使用
code	integer	错误码，参照《错误码说明》
msg	string	状态信息
request_time	long	请求时间
request_id	string	请求标识id
response_time	long	响应时间

响应体示例

json

{
  "code": 200,
  "msg": "success",
  "data": {
    "download_id": "b3193aaa468a4e6ab8ad2c0a3e12e4c8",
    "decompression_file_list": [
      {
        "download_id": "7b4925938e644874b187dc1dd3ccac1b",
        "path": ".project",
        "name": ".project",
        "size": 379,
        "directory": false,
        "encrypted": false,
        "modify_time": 1359237197
      },
      {
        "download_id": "4cea551ec3164d458e4f68bfea0898c8",
        "path": ".classpath",
        "name": ".classpath",
        "size": 393,
        "directory": false,
        "encrypted": false,
        "modify_time": 1359238272
      },
      {
        "path": "META-INF",
        "name": "META-INF",
        "size": 0,
        "directory": true,
        "encrypted": false,
        "modify_time": 1679391659523,
        "list_files": [
          {
            "download_id": "5b6a8846c6f54562b13c60aa7126af3a",
            "path": "META-INF/MANIFEST.MF",
            "name": "MANIFEST.MF",
            "size": 25,
            "directory": false,
            "encrypted": false,
            "modify_time": 1359238483
          }
        ]
      },
      {
        "path": "test",
        "name": "test",
        "size": 0,
        "directory": true,
        "encrypted": false,
        "modify_time": 1679391659523,
        "list_files": [
          {
            "download_id": "7f1d4f33897742b49e35ce874be9d8b4",
            "path": "test/AESUtil.class",
            "name": "AESUtil.class",
            "size": 1488,
            "directory": false,
            "encrypted": false,
            "modify_time": 1359238449
          }
        ]
      },
      {
        "path": ".settings",
        "name": ".settings",
        "size": 0,
        "directory": true,
        "encrypted": false,
        "modify_time": 1679391659523,
        "list_files": [
          {
            "download_id": "46857622436b457d87d00964ee2584c7",
            "path": ".settings/org.eclipse.jdt.core.prefs",
            "name": "org.eclipse.jdt.core.prefs",
            "size": 598,
            "directory": false,
            "encrypted": false,
            "modify_time": 1359237197
          }
        ]
      }
    ],
    "route_key": "1"
  },
  "request_id": "1416040cc1e51f13068f",
  "request_time": 1654792625940,
  "response_time": 1654792626410
}

开启/禁止文档编辑

适用版本>=v7.1.2304.20230428

支持的文件格式： DOC、DOCX

请求说明

请求地址： 配置域名+/open+/api/cps/sync/v1/document/editing
请求方法： POST
签名方式： WPS-4签名/WPS-4-GM签名

请求头（Header）

名称	是否必填	说明
Content-Type	是	固定为: `application/json`
Wps-Docs-Date	是	取当前时间, 示例: `Wed, 23 Jan 2013 06:43:08 GMT`
Wps-Docs-Authorization	是	计算方法参考签名说明

请求体（Body）

名称	类型	是否必填	说明
task_id	string	是	任务ID，不能重复
doc_filename	string	是	文件名，必须带后缀
doc_url	string	是	文档地址
is_editable	string	否	enable/disable开启文档编辑和禁止文档编辑。enable：开启文档编辑，disable：禁止文档编辑。非必须，默认disable
passwd	string	否	限制编辑密码，限制编辑时为设置密码，启用编辑时为启用密码。方式：先进行AES/ECB/PKCS5Padding加密，再进行base64加密。示例：123加密后为q0rxZGJ************
protection_type	string	否	限制编辑时使用，不传默认只读，保护方式为：onlyRevisions-修订，onlyComments-批注，onlyFormFields-窗体，onlyReading-只读（noProtection-不保护）

请求体示例

json

{
  "task_id": "1",
  "doc_filename": "test.docx",
  "doc_url": "http://10.226.45.233/wpspreview/v1_2_100/web-preview/api/download/3702675b63b64b9dbb9acbc6c819b905",
  "is_editable": "disable",
  "passwd": "q0rxZGJ************",
  "protection_type": "onlyReading"
}

响应体（Response）

名称	类型	说明
data	object	返回信息体
∟ download_id	string	下载id
∟ route_key	string	请求`下载接口`时使用
code	integer	错误码，参照《错误码说明》
msg	string	状态信息
request_time	long	请求时间
request_id	string	请求标识id
response_time	long	响应时间

响应体示例

json

{
  "code": 200,
  "msg": "success",
  "data": {
    "download_id": "08f29188b5c44ee1ae4b65f66ab2ee6d",
    "route_key": "0"
  },
  "request_id": "1416040cc1e51f13068f",
  "request_time": 1654792625940,
  "response_time": 1654792626410
}

查询是否为限制编辑状态

适用版本>=v7.1.2304.20230428

支持的文件格式： DOC、DOCX

请求说明

请求地址： 配置域名+/open+/api/cps/sync/v1/query/editing
请求方法： POST
签名方式： WPS-4签名/WPS-4-GM签名

请求头（Header）

名称	是否必填	说明
Content-Type	是	固定为: `application/json`
Wps-Docs-Date	是	取当前时间, 示例: `Wed, 23 Jan 2013 06:43:08 GMT`
Wps-Docs-Authorization	是	计算方法参考签名说明

请求体（Body）

名称	类型	是否必填	说明
task_id	string	是	任务ID，不能重复
doc_filename	string	是	文件名，必须带后缀
doc_url	string	是	文档地址

请求体示例

json

{
  "task_id": "1",
  "doc_filename": "test.docx",
  "doc_url": "http://10.226.45.233/wpspreview/v1_2_100/web-preview/api/download/3702675b63b64b9dbb9acbc6c819b905"
}

响应体（Response）

名称	类型	说明
data	object	返回信息体
∟ download_id	string	下载id
∟ route_key	string	请求`下载接口`时使用
code	integer	错误码，参照《错误码说明》
msg	string	状态信息
request_time	long	请求时间
request_id	string	请求标识id
response_time	long	响应时间

响应体示例

json

{
  "code": 200,
  "msg": "success",
  "data": {
    "download_id": "08f29188b5c44ee1ae4b65f66ab2ee6d",
    "route_key": "0"
  },
  "request_id": "1416040cc1e51f13068f",
  "request_time": 1654792625940,
  "response_time": 1654792626410
}

查询字体信息

适用版本>=v7.1.2310.20231018

支持格式： DOC、DOCX、WPS、XLS、XLSX、PPT、PPTX、

请求说明

请求地址： 配置域名+/open+/api/cps/sync/v1/query/fonts
请求方法： POST
签名方式： WPS-4签名/WPS-4-GM签名

请求头（Header）

名称	是否必填	说明
Content-Type	是	固定为: `application/json`
Wps-Docs-Date	是	取当前时间, 示例: `Wed, 23 Jan 2013 06:43:08 GMT`
Wps-Docs-Authorization	是	计算方法参考签名说明

请求体（Body）

名称	类型	是否必填	说明
task_id	string	是	任务ID
doc_filename	string	是	文件名，必须带后缀
doc_url	string	是	文件下载地址

请求体示例

json

{
  "task_id": "queryfonts",
  "doc_filename": "filename.docx",
  "doc_url": "http://10.226.45.233/wpspreview/v1_2_100/web-preview/api/download/44af281baba548bcb778bdad2d8a8db1"
}

响应体（Response）

名称	类型	说明
data	object	返回信息体
∟ download_id	string	下载id
∟ route_key	string	请求`下载接口`时使用
code	integer	错误码，参照《错误码说明》
msg	string	状态信息
request_time	long	请求时间
request_id	string	请求标识id
response_time	long	响应时间

响应体示例

json

{
  "code": 200,
  "msg": "success",
  "data": {
    "download_id": "08f29188b5c44ee1ae4b65f66ab2ee6d",
    "route_key": "0"
  },
  "request_id": "1416040cc1e51f13068f",
  "request_time": 1654792625940,
  "response_time": 1654792626410
}

响应文件内容说明

结果文件为json格式文本，文本中内容如下：

名称	类型	说明
usedFonts	[]string	文档中使用的字体
missingFonts	[]string	使用的字体服务器缺失的字体
fontFallbacks	[]object	缺失字体替代表
∟ key	string	缺失字体名
∟ values	string	替代字体列表，';'分隔

执行指令

适用版本>=v7.1.2406.20240626

支持格式： DOC、DOCX、WPT、DOTX、DOCM、DOTM、RTF、XML、WORD_XML、UOF、UOT、 WPS、XLS、XLSX、PPT、PPTX、POT、POTX、PPS、PPSX、DPS、DPT、PPTM、POTM、PPSM、ET、ETT、 XLT、XLTX、XLTM、XLSM、XLSB

请求说明

请求地址： 配置域名+/open+/api/cps/sync/v1/exec/script
请求方法： POST
签名方式： WPS-4签名/WPS-4-GM签名

请求头（Header）

名称	是否必填	说明
Content-Type	是	固定为: `application/json`
Wps-Docs-Date	是	取当前时间, 示例: `Wed, 23 Jan 2013 06:43:08 GMT`
Wps-Docs-Authorization	是	计算方法参考签名说明

请求体（Body）

名称	类型	是否必填	说明
task_id	string	是	任务ID
doc_filename	string	是	文件名，必须带后缀
doc_url	string	是	文件下载地址
password	string	否	文档打开密码。密码需加密，加密方式同上
script	string	是	指令脚本，多语句时以分号分割，例如 `Application.ActiveDocument.Content.InsertAfter('这只是个测试');Application.ActiveDocument.Save();`

请求体示例

json

{
  "task_id": "queryfonts",
  "doc_filename": "filename.pptx",
  "doc_url": "http://10.226.45.233/wpspreview/v1_2_100/web-preview/api/download/44af281baba548bcb778bdad2d8a8db1",
  "script": "Application.Windows.Item(1).Presentation.Slides.Item(1).Shapes.AddTextbox({Orientation: 0,Left: 500,Top: 500,Width: 1000,Height: 1000,Color: '#0000FF',Size: 50,Scale: false,Bold: false,Italic: true,StrikeThrough:true,AlignMode: 2,}).TextFrame.TextRange.Text = '文本框123'"
}

响应体（Response）

名称	类型	说明
data	object	返回信息体
∟ download_id	string	下载id
∟ route_key	string	请求`下载接口`时使用
∟ response_result	string	指令执行结果。若指令为数据获取类指令，则此字段表示获取到的数据。
code	integer	错误码，参照《错误码说明》
msg	string	状态信息
request_time	long	请求时间
request_id	string	请求标识id
response_time	long	响应时间

响应体示例

json

{
  "code": 200,
  "msg": "success",
  "data": {
    "download_id": "wwo_bd5bfc54a6524f10bfc9def91bedc1b8",
    "response_result": "文本框123"
  },
  "request_id": "docs-plugs-6973e77b-afa2-4e68-a738-d87fbf2dba65",
  "request_time": 1713172488468,
  "response_time": 1713172488917
}

解析文本内容

适用版本>=v7.1.2406.20240626

支持格式： DOC、DOCX、WPT、DOTX、DOCM、DOTM、RTF、XML、WORD_XML、UOF、UOT、TXT、MHTML、MHT、HTM、HTML、WPSS、TPDOC、UOT3、UOTT3、 WPS、PPT、PPTX、POT、POTX、PPS、PPSX、DPS、DPT、PPTM、POTM、PPSM、UOPT3、UOP3、TPPPT、DPSS、ET、ETT、 XLT、XLSX、XLTX、XLTM、XLSM、XLSB、CSV、ETS、ETO、LOG、UOS3、UOST3、TPXLS、PDF、OFD、FLOW、POM、POF、OTLPOM、 OTLPOF、OTL、DBT

请求说明

请求地址： 配置域名+/open+/api/cps/sync/v1/export/invoke
请求方法： POST
签名方式： WPS-4签名/WPS-4-GM签名

请求头（Header）

名称	是否必填	说明
Content-Type	是	固定为: `application/json`
Wps-Docs-Date	是	取当前时间, 示例: `Wed, 23 Jan 2013 06:43:08 GMT`
Wps-Docs-Authorization	是	计算方法参考签名说明

请求体（Body）

名称	类型	是否必填	说明
task_id	string	是	任务ID
doc_filename	string	是	文件名，必须带后缀
doc_url	string	是	文件下载地址
password	string	否	文档打开密码。密码需加密，加密方式同上
with_download_url	bool	否	是否返回结果文档下载url，默认为false。该参数在组件版不生效

请求体示例

json

{
  "task_id": "queryfonts",
  "doc_filename": "filename.docx",
  "doc_url": "http://10.226.45.233/wpspreview/v1_2_100/web-preview/api/download/44af281baba548bcb778bdad2d8a8db1"
}

响应体（Response）

名称	类型	说明
data	object	返回信息体
∟ download_id	string	下载id
∟ route_key	string	请求`下载接口`时使用
∟ download_url	string	文档下载链接，当with_download_url为true时返回，否则为空
code	integer	错误码，参照《错误码说明》
msg	string	状态信息
request_time	long	请求时间
request_id	string	请求标识id
response_time	long	响应时间

响应体示例

json

{
  "code": 200,
  "msg": "success",
  "data": {
    "download_id": "08f29188b5c44ee1ae4b65f66ab2ee6d",
    "route_key": "0"
  },
  "request_id": "1416040cc1e51f13068f",
  "request_time": 1654792625940,
  "response_time": 1654792626410
}

查询文档是否加密

适用版本>=v7.1.2409.20240925

支持格式： DOC、DOCX、WPT、DOTX、DOCM、DOTM、RTF、XML、WORD_XML、UOF、UOT、 WPS、XLS、XLSX、PPT、PPTX、POT、POTX、PPS、PPSX、DPS、DPT、PPTM、POTM、PPSM、ET、ETT、 XLT、XLTX、XLTM、XLSM、XLSB

请求说明

请求地址： 配置域名+/open+/api/cps/sync/v1/check/encryption
请求方法： POST
签名方式： WPS-4签名/WPS-4-GM签名

请求头（Header）

名称	是否必填	说明
Content-Type	是	固定为: `application/json`
Wps-Docs-Date	是	取当前时间, 示例: `Wed, 23 Jan 2013 06:43:08 GMT`
Wps-Docs-Authorization	是	计算方法参考签名说明

请求体（Body）

名称	类型	是否必填	说明
task_id	string	是	任务ID
doc_filename	string	是	文件名，必须带后缀
doc_url	string	是	文件下载地址

请求体示例

json

{
  "task_id": "checkencryption",
  "doc_filename": "filename.pptx",
  "doc_url": "http://10.226.45.233/wpspreview/v1_2_100/web-preview/api/download/44af281baba548bcb778bdad2d8a8db1"
}

响应体（Response）

名称	类型	说明
data	object	返回信息体
∟ is_encrypted	bool	是否加密
code	integer	错误码，参照《错误码说明》
request_time	long	请求时间
request_id	string	请求标识id
response_time	long	响应时间

响应体示例

json

{
  "code": 200,
  "msg": "success",
  "data": {
    "is_encrypted": true,
    "response_result": "",
    "route_key": "0"
  },
  "request_id": "wwo-f5a0287a-43d1-4275-af81-53f7d4be656b",
  "request_time": 1728640243838,
  "response_time": 1728640244515
}

文件下载

适用版本>=v6.0.2206.20220615

请求说明

请求地址： 配置域名+/open+/api/cps/v1/download/{download_id}
请求方法： GET
签名方式： WPS-4签名/WPS-4-GM签名

请求头（Header）

名称	是否必填	说明
Content-Type	是	固定为: `application/json`
Wps-Docs-Date	是	取当前时间, 示例: `Wed, 23 Jan 2013 06:43:08 GMT`
Wps-Docs-Authorization	是	计算方法参考签名说明
Route-Key	是	格式处理接口返回的data中的route_key

路径参数(Path)

名称	类型	是否必填	说明
download_id	string	是	文档下载id

响应体（Response）

文件流

同步模式API列表 ​

格式转换 ​

请求说明 ​

请求头（Header） ​

请求体（Body） ​

请求体示例 ​

响应体（Response） ​

响应体示例 ​

多书签套用 ​

请求说明 ​

请求头（Header） ​

请求体（Body） ​

请求体示例 ​

响应体（Response） ​

响应体示例 ​

内容操作 ​

请求说明 ​

请求头（Header） ​

请求体（Body） ​

请求体示例 ​

响应体（Response） ​

响应体示例 ​

文档合并 ​

请求说明 ​

请求头（Header） ​

请求体（Body） ​

请求体示例 ​

响应体（Response） ​

响应体示例 ​

文档拆分 ​

请求说明 ​

请求头（Header） ​

请求体（Body） ​

请求体示例 ​

响应体（Response） ​

响应体示例 ​

限制编辑 ​

请求说明 ​

请求头（Header） ​

请求体（Body） ​

请求体示例 ​

响应体（Response） ​

响应体示例 ​

查询书签 ​

请求说明 ​

请求头（Header） ​

请求体（Body） ​

请求体示例 ​

响应体（Response） ​

响应体示例 ​

查询只读/可编辑书签 ​

请求说明 ​

请求头（Header） ​

请求体（Body） ​

请求体示例 ​

响应体（Response） ​

响应体示例 ​

文档加解密 ​

请求说明 ​

请求头（Header） ​

请求体（Body） ​

请求体示例 ​

响应体（Response） ​

响应体示例 ​

图片操作 ​

请求说明 ​

请求头（Header） ​

请求体（Body） ​

请求体示例 ​

响应体（Response） ​

响应体示例 ​

在线解压 ​

请求说明 ​

请求头（Header） ​

请求体（Body） ​

请求体示例 ​

响应体（Response） ​

响应体示例 ​

开启/禁止文档编辑 ​

请求说明 ​

同步模式API列表

格式转换

请求说明

请求头（Header）

请求体（Body）

请求体示例

响应体（Response）

响应体示例

多书签套用

请求说明

请求头（Header）

请求体（Body）

请求体示例

响应体（Response）

响应体示例

内容操作

请求说明

请求头（Header）

请求体（Body）

请求体示例

响应体（Response）

响应体示例

文档合并

请求说明

请求头（Header）

请求体（Body）

请求体示例

响应体（Response）

响应体示例

文档拆分

请求说明

请求头（Header）

请求体（Body）

请求体示例

响应体（Response）

响应体示例

限制编辑

请求说明

请求头（Header）

请求体（Body）

请求体示例

响应体（Response）

响应体示例

查询书签

请求说明

请求头（Header）

请求体（Body）

请求体示例

响应体（Response）

响应体示例

查询只读/可编辑书签

请求说明

请求头（Header）

请求体（Body）

请求体示例

响应体（Response）

响应体示例

文档加解密

请求说明

请求头（Header）

请求体（Body）

请求体示例

响应体（Response）

响应体示例

图片操作

请求说明

请求头（Header）

请求体（Body）

请求体示例

响应体（Response）

响应体示例

在线解压

请求说明

请求头（Header）

请求体（Body）

请求体示例

响应体（Response）

响应体示例

开启/禁止文档编辑

请求说明