获取文档预览地址
GetOfficePreviewURL
该接口用于获取文档预览的 URL 和 AccessToken。(当前只支持上海Region)
请求参数
名称 | 类型 | 是否必填 | 描述 |
---|---|---|---|
Project | String | 是 | 项目名 |
Action | String | 是 | GetOfficePreviewURL |
SrcURI | String | 是 | 源数据的存储位置, OSS 资源采用如下格式”oss://bucket1/object” |
SrcType | String | 否 | 源数据的后缀类型,当前文档转换根据 OSS 对象的后缀名来确定源数据类型,当 OSS 对象没有后缀名时,可以设置该值 |
目前支持的 输入文件类型 包含如下格式:
- 演示文件:
ppt
、pptx
、pptm
、pptm
、ppsm
、pps
、potx
、potm
、dpt
、dps
。 - 表格文件:
et
、xls
、xlt
、xlsx
、xlsm
、xltx
、xltm
、csv
。 - 文字文件:
doc
、docx
、txt
、dot
、wps
、wpt
、dotx
、docm
、dotm
。 - pdf格式文件:
pdf
。
返回参数
名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 用户发送的每次接口调用请求,无论成功与否,系统都会返回一个唯一识别码 RequestId 给用户 |
PreviewURL | String | 文档预览地址 |
AccessToken | String | 访问文档预览服务器时的凭证 |
AccessTokenExpiredTime | String | 凭证过期时间,30分钟 |
RefreshToken | String | 凭证过期时,使用RefeshToken来刷新凭证 |
RefreshTokenExpiredTime | String | 刷新凭证的过期时间,1天 |
示例
请求示例
POST https://imm.cn-shanghai.aliyuncs.com
?Action=GetOfficePrviewURL
&Project=test
&SrcUri="oss://bucket1/test.pptx"
...
此处的示例,目的是展示关键参数,还需要其他的公共参数才能正常调用,推荐使用 SDK 来发送 API。
成功返回示例
{
"AccessTokenExpiredTime":"2020-02-04T10:53:47.999Z",
"PreviewURL":"https://office-cn-shanghai.imm.aliyuncs.com/office/w/1023210024677934_a2_3899cdbd16b3061554556d9e949bb2fe85a944030bf147f8de1d79036f5e5a25?hidecmb=1&simple=1&_w_tokentype=1",
"AccessToken":"ac80b70a70fe4c34914a12743ac3a6fb",
"RefreshTokenExpiredTime":"2020-02-05T10:23:47.999Z",
"RequestId":"F07DA595-194D-45A7-8752-ABBADBB1297F",
"RefreshToken":"44dd1a2012f5467bba1521b213e5a461"
}
版权声明
本文仅代表作者观点,不代表本站立场。
本文系作者授权发表,未经许可,不得转载。
评论