获取文档预览的URL和AccessToken。
接口说明
注意事项
当前只有华东1(杭州)、华东2(上海)、华北2(北京)、华南1(深圳)、华北3(张家口)和美国地域支持此功能。
此API不受单用户每秒调用次数不能超过十次的限制。
关于如何使用该预览地址和AccessToken实现文档预览,请参见快速入门。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
Project | string | 是 | 项目名称。 | immdoctest |
SrcUri | string | 是 | 源数据的OSS地址。 OSS地址规则为 | oss://test-bucket/mytest.doc |
SrcType | string | 否 | 源数据的后缀类型。默认根据OSS对象的后缀名确定源数据的类型。 当OSS对象没有后缀名时,可以设置此参数。 目前支持的文件类型有:
| doc |
WatermarkType | integer | 否 | 水印类型。
| 1 |
WatermarkValue | string | 否 | 文字水印的文字。 当WatermarkType设置为1时,才能设置此参数。 | imm |
WatermarkFillStyle | string | 否 | 文字水印的透明度,默认值为rgba(192, 192, 192, 0.6)。 | rgba(192, 192, 192, 0.6) |
WatermarkFont | string | 否 | 文字水印的字体,默认值为bold 20px Serif。 | bold 20px Serif |
WatermarkRotate | number | 否 | 文字水印的旋转度,默认值为-0.7853982,单位为弧度。 | -0.7853982 |
WatermarkHorizontal | integer | 否 | 文字水印水平间距,默认值为50,单位为px。 | 50 |
WatermarkVertical | integer | 否 | 文字水印垂直间距,默认值为100,单位为px。 | 100 |
返回参数
示例
正常返回示例
JSON
格式
{
"PreviewURL": "https://office-cn-hangzhou.imm.aliyuncs.com/office/f/59db14bc9e97205734b31f9880622e043175ea4f?hidecmb=1&simple=1&_w_tokentype=1",
"RefreshToken": "1eb6535cdf8a4732a7d7183891********",
"RequestId": "14580EF3-442A-4AA2-959C-1464DC255EEB",
"AccessToken": "f3a3ad0ae32a4c6fb90ed00218********",
"RefreshTokenExpiredTime": "2020-11-20T06:16:19.069Z",
"AccessTokenExpiredTime": "2020-11-19T06:46:19.069Z"
}
错误码
访问错误中心查看更多错误码。