获取预览链接
适用版本>=v7.0.2412a.20241212
接口说明:获取预览链接
请求说明
| 请求地址 | 配置域名+/openapi+/v7/drives/{drive_id}/files/{file_id}/preview_url |
|---|---|
| 请求方法 | GET |
| 签名方式 | KSO-1(配置域名+/openapi不参与签名) |
| 权限要求 | 应用身份管理文档(应用授权) kso.appfile.readwrite |
请求头(Header)
| Header | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| X-Kso-Date | string | 是 | RFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT |
| X-Kso-Authorization | string | 是 | KSO-1 签名值,详见《签名方法》 |
| Authorization | string | 是 | 授权凭证,格式为:Bearer {access_token} |
路径参数(Path)
| 名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| drive_id | string | 是 | 驱动盘id,长度不超过1024位 |
| file_id | string | 是 | 文件id,长度不超过1024位 |
查询参数(Query)
| 名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 文件格式(w:文字文件,s:表格文件,p:演示文件,f:PDF文件,x:图片或压缩包,d:多维表格,o:轻文档) |
| expire_time | integer | 否 | 过期时间,默认值60分钟(单位:秒) |
| preview_mode | string | 否 | 适用版本 >= v7.0.2406a.20240613 预览模式,可选值: high_definition:高清预览ordinary:普通预览cache:缓存预览official:公文极速预览(不传默认high_definition) |
| wpsPreview | string | 否 | 高清预览支持控制修订痕迹、评论是否显示等参数。高清预览参数wpsPreview=1111111从左到右依次代表: 第0位:格式修订:0不显示;1:显示 第1位:插入和删除:0不显示;1:显示 第2位:评论 0不显示;1:显示 第3位:以嵌入模式显示修订 第4位:以气泡模式显示修订 第5位:0不显示标记;1:显示标记 第6位:0最终状态;1:原始状态 注:(第3、4位组合:01及11为批注框方式;10是嵌入方式 00是批注框显示修订者) |
| _w_tokentype | int | 否 | 适用版本>=v7.0.2406a.20240613 是否透传token,传1时透传,传0时不透传(默认透传) |
| _w_third_* | object | 否 | 合作方自定义参数, w_third作为前缀,_w_third_appid,_w_third_file_id 字段已被使用,对接方请合理避开 |
响应体(Response)
| 名称 | 类型 | 说明 |
|---|---|---|
| data | object | 返回信息 |
| ∟ expiration | string | 过期时间 |
| ∟ url | string | 预览链接 |
| code | int | 错误码 |
| msg | string | 状态信息 |
| detail | string | 详细信息 |
响应体示例
json
{
"code": 0,
"detail": "string",
"msg": "string",
"data": {
"expiration": "string",
"url": "string"
}
}