API列表
获取预览链接
请求说明
请求地址： 配置域名+/open+/api/preview/v1/files/{file_id}/link
请求方法： GET
签名方式： WPS-4签名/WPS-4-GM签名
请求头（Header）
| 名称 | 是否必填 | 说明 |
|---|---|---|
| Content-Type | 是 | 固定为: application/json |
| Wps-Docs-Date | 是 | 取当前时间, 示例: Wed, 23 Jan 2013 06:43:08 GMT |
| Wps-Docs-Authorization | 是 | 计算方法参考签名说明 |
查询参数(Path)
| 名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| file_id | string | 是 | 文件id,长度不超过64位 |
查询参数(Query)
| 名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| type | string | 是 | 文件格式，可选值： w:文字文件 s:表格文件 p:演示文件 f:PDF文件 x:文件类型（图片、压缩包、md、eml、代码、其他），传空时默认为该类型 |
| preview_mode | string | 否 | 适用版本 >= v6.0.2207.20220729 预览模式，可选值：high_definition:高清预览 ordinary:普通预览 cache:缓存预览 official:公文极速预览（>=v6.1.2302.20230220）不传默认official |
| 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.2309a.20230907是否透传token，传1时透传 |
| *任意参数 | *任意类型 | 否 | 合作方自定义参数，要求以 _w_third_ 作为前缀，回调时会一并返回给开发者。 _w_third_appid 、 _w_third_file_id 字段已被使用，对接方请合理避开。 |
注意： 所有参数值必须做urlencode，例如
http://xxxx:xx/api/preview/v1/files/471eba5030/link?type=w&_w_third_name=%E4%BC%9A%E8%AE%AE%E7%BA%AA%E8%A6%81.docx&_w_third_userid=33
响应体（Response）
| 名称 | 类型 | 说明 |
|---|---|---|
| data | object | |
| ∟ link | string | 文件在线预览链接,示例：配置域名+/weboffice/office/{file_type}/{file_id}?_w_appid=11&用户自定义参数 +&wpsPreview=1111111&simple&hidecmb |
| code | integer | 错误码，参照《错误码说明》 |
| msg | string | 状态信息 |
| request_time | long | 请求时间 |
| request_id | string | 请求标识id |
| response_time | long | 响应时间 |
响应体示例
{
"data": {
"link": "http://yun.test.cn/weboffice/office/w/777e2226783346c592f41d4b1362?_w_appid=AKVyEoaNGupKxTOA&wpsPreview=1111111&simple&hidecmb" //文件在线预览链接
},
"code": 200,
"msg": "success",
"request_time": 1653272135097,
"request_id": "1416070c674445b866fe",
"response_time": 1653272135101
}特别说明： 预览链接中重要参数含义：&simple&hidecmb表示隐藏菜单栏
公文极速预览链接中重要参数含义：&revisionView=0表示显示标记最终状态；&revisionView=1表示最终状态；&revisionView=2表示显示标记的原始状态；&revisionView=3表示原始状态；
压缩包预览默认当前页面预览。可拼接&isNew=true以此支持新页面打开压缩包内的文件进行预览。若需屏蔽压缩包内的部分文件格式，可拼接&ignore参数，如&ignore=doc,Docx，ignore参数是由文件后缀组成，表示需要屏蔽doc、docx格式类型，不区分大小写。
注意：使用缓存预览无法高清预览，不要拼接高清预览参数 缓存预览不支持pdf纯图预览
预处理接口（只支持四大组件格式）（不支持）
适用版本 >= v6.0.2207.20220729（v6.0.2209.20220920版本及之后不建议使用，请对接v2版本）
请求说明
请求地址： 配置域名+/open+/api/preview/v1/file/preload
请求方法： POST
签名方式： WPS-4签名/WPS-4-GM签名
请求头（Header）
| 名称 | 是否必填 | 说明 |
|---|---|---|
| Content-Type | 是 | 固定为: application/json |
| Wps-Docs-Date | 是 | 取当前时间, 示例: Wed, 23 Jan 2013 06:43:08 GMT |
| Wps-Docs-Authorization | 是 | 计算方法参考签名说明 |
查询参数（Path）
| 名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| file_id | string | 是 | 文件id,长度不超过64位 |
| version | int | 是 | 文件版本 |
请求体（Body）
| 名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| webhook | string | 是 | 处理结果通知地址 长度不超过1024位,回调请求为post请求，回调报文：{"file_id":"xxx","result":"Completed","version":1}，其中result：Completed-成功，Failed-失败。对接方返回200响应即可(回调接口无重试机制，不管成功失败只通知一次) |
| password | string | 否 | 文档打开密码，不能超过128位。如果文档有打开密码，则该项必填，且密码必须正确，否则将导致任务失败。密码需要进行加密，具体如下，加密方式：先进行AES/ECB/PKCS5Padding加密，在进行base64加密密钥，示例：123加密后为q0rxZGJ************ |
| force_build | bool | 否 | 是否强制更新,默认不强制更新 |
| preview_mode | string | 否 | 预览模式，可选值： cache:缓存预览 official:公文极速预览（>=v6.1.2302.20230220）不传默认cache |
| revision_view | string | 否 | 标记状态，可选值：0:显示标记最终状态1:最终状态2:显示标记的原始状态3:原始状态 |
响应体（Response）
| 名称 | 类型 | 说明 |
|---|---|---|
| data | object | |
| ∟ build_status | string | 处理状态:Completed 完成、Building 构建中 、Failed 失败 |
| code | integer | 错误码，参照《错误码说明》 |
| msg | string | 状态信息 |
| request_time | long | 请求时间 |
| request_id | string | 请求标识id |
| response_time | long | 响应时间 |
响应体示例
{
"code": 200,
"msg": "success",
"data": {
"build_status": "Building"
},
"request_id": "1416060dda6ddcba2221",
"request_time": 1659499207866,
"response_time": 1659499208003
}预处理V2接口
适用版本 >= v6.0.2209.20220920 调用此接口前需要先调用获取预览链接接口，携带预览链接的query参数。 该预处理接口仅适用于缓存预览和公文极速预览模式。
请求说明
请求地址： 配置域名+/open+/api/preview/v2/files/{file_id}/versions/{version_id}/preload
请求方法： POST
签名方式： WPS-4签名/WPS-4-GM签名
请求头（Header）
| 名称 | 是否必填 | 说明 |
|---|---|---|
| Content-Type | 是 | 固定为: application/json |
| Wps-Docs-Date | 是 | 取当前时间, 示例: Wed, 23 Jan 2013 06:43:08 GMT |
| Wps-Docs-Authorization | 是 | 计算方法参考签名说明 |
查询参数(Path)
| 名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| file_id | string | 是 | 文件id,长度不超过64位 |
| version_id | int | 是 | 文件版本，极速预览场景固定传0。 |
查询参数(Query)
| 名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| *任意参数 | *任意类型 | 是 | 携带预览链接返回的query |
请求体（Body）
| 名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| webhook | string | 是 | 处理结果通知地址 长度不超过1024位,回调请求为post请求，回调报文：{"file_id":"xxx","result":"Completed","version":1}，其中result：Completed-成功，Failed-失败。对接方返回200响应即可(回调接口无重试机制，不管成功失败只通知一次) |
| password | string | 否 | 文档打开密码，不能超过128位。如果文档有打开密码，则该项必填，且密码必须正确，否则将导致任务失败。密码需要进行加密，具体如下，加密方式：先进行AES/ECB/PKCS5Padding加密，在进行base64加密密钥，123加密后为q0rxZGJ************ |
| force_build | bool | 否 | 是否强制更新,默认不强制更新 |
响应体（Response）
| 名称 | 类型 | 说明 |
|---|---|---|
| data | object | |
| ∟ build_status | string | 处理状态:Completed 完成、Building 构建中 、Failed 失败 |
| code | integer | 错误码，参照《错误码说明》 |
| msg | string | 状态信息 |
| request_time | long | 请求时间 |
| request_id | string | 请求标识id |
| response_time | long | 响应时间 |
响应体示例
{
"code": 200,
"msg": "success",
"data": {
"build_status": "Building"
},
"request_id": "1416060dda6ddcba2221",
"request_time": 1659499207866,
"response_time": 1659499208003
}