简介
本文档提供关于文档预览同步请求的 API 概览以及 SDK 示例代码。
API | 说明 |
文档转 HTML 功能支持对多种文档类型的文件生成 HTML 格式预览,满足 PC、App 等多个用户端的文档在线浏览需求,适用于在线教育、企业 OA、在线知识库、网盘文档预览等业务场景。 |
文档转 HTML
功能说明
支持对多种文档类型的文件生成 HTML 格式预览。
方法原型
def ci_doc_preview_html_process(self, Bucket, Key, SrcType=None, Copyable='1', DstType='html', HtmlParams=None, HtmlWaterword=None, HtmlFillStyle=None,HtmlFront=None, HtmlRotate=None, HtmlHorizontal=None, HtmlVertical=None, HtmlTitle=None, **kwargs):
请求示例
def ci_doc_preview_to_html_process(): # 文档预览同步接口(生成html) html_params = { 'commonOptions': { 'isShowTopArea': 'true', 'isShowHeader': 'true', 'isBrowserViewFullscreen': 'true', 'isIframeViewFullscreen': 'true', }, 'wordOptions': { 'isShowDocMap': 'true', 'isBestScale': 'true', 'isShowBottomStatusBar': 'true', } } html_params_json = json.dumps(html_params) response = client.ci_doc_preview_html_process( Bucket=bucket_name, Key='1.txt', SrcType='txt', DstType='html', HtmlParams=base64.urlsafe_b64encode(html_params_json.encode('utf-8')).decode('utf-8').rstrip('='), HtmlWaterword=base64.urlsafe_b64encode("watermark".encode('utf-8')).decode('utf-8').rstrip('='), HtmlFillStyle=base64.urlsafe_b64encode("rgba(192,192,192,0.6)".encode('utf-8')).decode('utf-8').rstrip('='), HtmlFront=base64.urlsafe_b64encode("bold 20px Serif".encode('utf-8')).decode('utf-8').rstrip('='), HtmlRotate="180", HtmlHorizontal="100", HtmlVertical="50", HtmlTitle=base64.urlsafe_b64encode("title".encode('utf-8')).decode('utf-8').rstrip('='), ) print(response) response['Body'].get_stream_to_file('result.html')
参数说明
名称 | 参数说明 | 类型 | 是否必选 |
Bucket | 对象所在存储桶 | String | 是 |
Key | 对象名 | String | 是 |
SrcType | String | 否 | |
Copyable | 是否可复制。默认为可复制,填入值为1;不可复制,填入值为0 | String | 否 |
DstType | 转换输出目标文件类型,文档 HTML 预览固定为 html(需为小写字母) | String | 否 |
HtmlParams | String | 否 | |
HtmlWaterword | String | 否 | |
HtmlFillStyle | String | 否 | |
HtmlFront | String | 否 | |
HtmlRotate | 水印文字旋转角度,0 - 360,默认315度 | String | 否 |
HtmlHorizontal | 水印文字水平间距,单位 px,默认为50 | String | 否 |
HtmlVertical | 水印文字垂直间距,单位 px,默认为100 | String | 否 |
HtmlTitle | 通配符包括以下两种: ${InputName}:输入文件的文件名(不包括后缀) ${InputNameAndExt}:输入文件的文件名(包括后缀) 例如:需要设置的 Title 信息为: “万象标题 ${InputName}”,则 Base64 编码为 5LiH6LGh5qCH6aKYICR7SW5wdXROYW1lfQ,HtmlTitle=5LiH6LGh5qCH6aKYICR7SW5wdXROYW1lfQ | String | 否 |
返回结果说明
response 为响应头与响应体的集合, 数据类型为 dict。
响应头
响应体
[html-content]