简介
本文档提供关于文档预览相关请求的 API 概览以及 SDK 示例代码。
API | 说明 |
文档转 HTML 功能支持对多种文档类型的文件生成 HTML 格式预览,满足 PC、App 等多个用户端的文档在线浏览需求,适用于在线教育、企业 OA、在线知识库、网盘文档预览等业务场景 | |
通过直接请求获取在线文档预览地址 |
文档转 HTML
功能说明
支持对多种文档类型的文件生成 HTML 格式预览。
请求示例
function getDocHtmlUrl() {var config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', /* 存储桶,必须 */Region: 'COS_REGION', /* 存储桶所在地域,必须字段 */};cos.getObjectUrl({Bucket: config.Bucket,Region: config.Region,Key: '文档.docx',Query: {'ci-process': 'doc-preview', /* 必须,数据万象处理能力,文档预览固定为 doc-preview */dstType: 'html',},}, function(err, data) {if (err) {console.log(err);} else {// 使用浏览器打开 url 即可预览var url = data.Url;console.log(url);}});}getDocHtmlUrl();
参数说明
名称 | 参数说明 | 类型 | 是否必选 |
dstType | 转换输出目标文件类型,文档 HTML 预览固定为 html(需为小写字母) | String | 是 |
srcType | String | 否 | |
sign | String | 否 | |
copyable | 是否可复制。默认为可复制,填入值为1;不可复制,填入值为0 | String | 否 |
htmlParams | String | 否 | |
htmlwaterword | String | 否 | |
htmlfillstyle | String | 否 | |
htmlfront | String | 否 | |
htmlrotate | 水印文字旋转角度,0 - 360,默认315度 | String | 否 |
htmlhorizontal | 水印文字水平间距,单位 px,默认为50 | String | 否 |
htmlvertical | 水印文字垂直间距,单位 px,默认为100 | String | 否 |
返回结果说明
function(err, data) { ... }
参数名 | 参数描述 | 类型 |
err | Object | |
- statusCode | 请求返回的 HTTP 状态码,例如200、403、404等 | Number |
- headers | 请求返回的头部信息 | Object |
data | 请求成功时返回的对象,如果请求发生错误,则为空 | Object |
- RequestId | 请求的唯一 ID | String |
- Url | 文档预览的 Url | String |
获取在线文档预览地址
功能说明
通过直接请求的方式获取在线文档预览地址。
示例代码
// 获取在线文档预览地址function getDocHtmlPreviewUrl() {var config = {// 需要替换成您自己的存储桶信息Bucket: 'examplebucket-1250000000', /* 存储桶,必须 */Region: 'COS_REGION', /* 存储桶所在地域,必须字段 */};var key = 'test.pdf';var host = config.Bucket + '.cos.' + config.Region + '.myqcloud.com/' + key;var url = 'https://' + host;cos.request({Method: 'GET',Key: key,Url: url,RawBody: true,Query: {'ci-process': 'doc-preview', /* 必须,预览固定参数,值为 doc-preview */'dstType': 'html', /* 必须,预览类型,如需预览生成类型为 html 则填入 html */'weboffice_url': 1, /* 非必须,是否获取预览链接。填入值为1会返回预览链接和Token信息;填入值为2只返回Token信息;不传会直接预览 */},},function(err, data){// 从响应数据中解析出在线文档预览地址let body = {};if (data && data.Body) {body = JSON.parse(data.Body) || {};}if(body && body.PreviewUrl) {data.PreviewUrl = body.PreviewUrl;}logger.log(err || data);});}getDocHtmlPreviewUrl();
参数说明
请求参数描述如下:
参数名称 | 描述 | 是否必选 |
ci-process | 预览固定参数,值为 doc-preview | 是 |
dstType | 预览类型,如需预览生成类型为 html 则填入 html | 是 |
weboffice_url | 是否获取预览链接。填入值为1会返回预览链接和Token信息;填入值为2只返回Token信息;不传会直接预览 | 否 |
tokenuid | 是否获取token。根据传入的tokenuid、文件信息等生成Token,返回Token和有效期;如果不传则不会返回Token信息 | 否 |
sign | 否 | |
copyable | 是否可复制。默认为可复制,填入值为1;不可复制,填入值为0 | 否 |
htmlwaterword | 水印文字,需要经过 URL 安全 的 Base64 编码,默认为空 | 否 |
htmlfillstyle | 水印 RGBA(颜色和透明度),需要经过 URL 安全 的 Base64 编码,默认为:rgba(192,192,192,0.6) | 否 |
htmlfront | 水印文字样式,需要经过 URL 安全 的 Base64 编码,默认为:bold 20px Serif | 否 |
htmlrotate | 旋转角度,0 - 360,默认315度 | 否 |
htmlhorizontal | 水印文字水平间距,单位 px,默认为50 | 否 |
htmlvertical | 水印文字垂直间距,单位 px,默认为100 | 否 |