数据万象文档编辑

功能描述
文档编辑支持支持多人实时在线编辑同一个文档，多人协作，效率更高。
授权说明
授权策略中 action 设置为 ci:EditingDocument。
服务开通
使用该功能需提前开通数据万象，并绑定存储桶。详情请参见 绑定存储桶。
使用限制
输入文件限制
演示文件：pptx、ppt、potx、ppsx、dps、dpt、pptm、potm、ppsm
文字文件：doc、dot、wps、wpt、docx、dotx、docm、dotm
表格文件：xls、xlt、et、xlsx、xltx、xlsm、xltm
pdf文件：仅支持标注，不可编辑文档内容。
支持最大的文件200MB。
支持最大的文档页数 5000 页。
禁止匿名访问。
须开启 cos 多版本，用于文档自动保存。
最多支持展示1000条协作记录。
访问凭证过期时间为30分钟，刷新凭证过期时间为1天，返回的过期时间为北京时间。
文档协作编辑的人数在50人以下体验最佳，最高支持100人，超过100人会自动变为预览模式。
请求
请求示例
GET /<ObjectKey>?ci-process=doc-preview&dstType=edit HTTP/1.1
Host: <BucketName-APPID>.cos.<Region>.myqcloud.com
Date: GMT Date
请求头
此接口仅使用公共请求头部，详情请参见 公共请求头部 文档。
请求参数
名称
描述
类型
是否必选
ObjectKey
对象文件名，例如 folder/document.pdf
String
是
ci-process
数据万象处理能力，文档 HTML 预览固定为 doc-preview
String
是
dstType
预览类型，html（预览），edit（编辑）
String
是
srcType
指定目标文件类型
String
否
sign
对象下载签名，如果预览的对象为私有读时，需要传入签名。
注意：需要进行 urlencode
String
否
htmlParams
自定义配置参数，json结构，需要经过 数据万象的 Base64 编码，默认配置为：{ commonOptions: { isShowTopArea: true, isShowHeader: true, language: "zh" }}，支持的配置参考 对象存储 配置项说明。
htmlParams 支持的特殊配置：语言切换，通过 commonOptions 的 language 参数指定预览语言，支持"zh"、"en"，默认为"zh"。
String
否
htmlwaterword
水印文字，需要经过 数据万象的 Base64 编码，默认为空。
String
否
htmlfillstyle
水印 RGBA（颜色和透明度），需要经过 数据万象的 Base64 编码，默认为：rgba(192,192,192,0.6)。
String
否
htmlfront
水印文字样式，需要经过 数据万象的 Base64 编码，默认为：bold 20px Serif。
String
否
htmlrotate
旋转角度，0 - 360，默认315度。
String
否
htmlhorizontal
水印文字水平间距，单位 px，默认为50。
String
否
htmlvertical
水印文字垂直间距，单位 px，默认为100。
String
否
readonly
预览权限。默认为可编辑，填入值为0；仅预览，填入值为1。
String
否
history
查看历史版本的权限。默认为可查看，填入值为1；不可查看，填入值为0。
String
否
export
导出PDF权限。默认为不可导出，填入值为0；可导出，填入值为1。
String
否
print
打印权限。默认为不可打印，填入值为0；可打印，填入值为1。
String
否
comment
评论权限。默认为可评论，填入值为1；不可评论，填入值为0。
String
否
copyable
复制权限。默认为可复制，填入值为1；不可复制，填入值为0。
String
否
userId
用户id，需要经过 url 安全的Base64 编码，默认为“user1”。
String
否
userName
用户昵称， 需要经过url安全的 Base64 编码，默认为“user1”。
﻿
﻿
tokenuid
是否获取 token。根据传入的 tokenuid、文件信息等生成 Token，返回 Token 和有效期；如果不传则不会返回 Token 信息。
String
否
outputPath
指定编辑保存位置,支持占位符${version}
例如 result-${version}.docx 在生成产物的时候 结果为 result-1.docx result-2.docx 按照版本号自增
String
否
请求体
该请求的请求体为空。
响应
响应头
此接口仅返回公共响应头部，详情请参见 公共响应头部 文档。
响应体
此接口请求的响应体为 html 编辑内容。
错误码
该请求无特有错误信息，常见的错误信息请参见 错误码 文档。

名称	描述	类型	是否必选
ObjectKey	对象文件名，例如 folder/document.pdf	String	是
ci-process	数据万象处理能力，文档 HTML 预览固定为 doc-preview	String	是
dstType	预览类型，html（预览），edit（编辑）	String	是
srcType	指定目标文件类型	String	否
sign	对象下载签名，如果预览的对象为私有读时，需要传入签名。注意：需要进行 urlencode	String	否
htmlParams	自定义配置参数，json结构，需要经过数据万象的 Base64 编码，默认配置为：{ commonOptions: { isShowTopArea: true, isShowHeader: true, language: "zh" }}，支持的配置参考对象存储配置项说明。 htmlParams 支持的特殊配置：语言切换，通过 commonOptions 的 language 参数指定预览语言，支持"zh"、"en"，默认为"zh"。	String	否
htmlwaterword	水印文字，需要经过数据万象的 Base64 编码，默认为空。	String	否
htmlfillstyle	水印 RGBA（颜色和透明度），需要经过数据万象的 Base64 编码，默认为：rgba(192,192,192,0.6)。	String	否
htmlfront	水印文字样式，需要经过数据万象的 Base64 编码，默认为：bold 20px Serif。	String	否
htmlrotate	旋转角度，0 - 360，默认315度。	String	否
htmlhorizontal	水印文字水平间距，单位 px，默认为50。	String	否
htmlvertical	水印文字垂直间距，单位 px，默认为100。	String	否
readonly	预览权限。默认为可编辑，填入值为0；仅预览，填入值为1。	String	否
history	查看历史版本的权限。默认为可查看，填入值为1；不可查看，填入值为0。	String	否
export	导出PDF权限。默认为不可导出，填入值为0；可导出，填入值为1。	String	否
print	打印权限。默认为不可打印，填入值为0；可打印，填入值为1。	String	否
comment	评论权限。默认为可评论，填入值为1；不可评论，填入值为0。	String	否
copyable	复制权限。默认为可复制，填入值为1；不可复制，填入值为0。	String	否
userId	用户id，需要经过 url 安全的Base64 编码，默认为“user1”。	String	否
userName	用户昵称，需要经过url安全的 Base64 编码，默认为“user1”。
tokenuid	是否获取 token。根据传入的 tokenuid、文件信息等生成 Token，返回 Token 和有效期；如果不传则不会返回 Token 信息。	String	否
outputPath	指定编辑保存位置,支持占位符${version} 例如 result-${version}.docx 在生成产物的时候结果为 result-1.docx result-2.docx 按照版本号自增	String	否

文档编辑

本页目录：

功能描述

授权说明

服务开通

使用限制

请求

请求示例

请求头

请求参数

请求体

响应

响应头

响应体

错误码