API列表
获取在线编辑链接
请求说明
请求地址: 配置域名+/open+/api/edit/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文件 |
_w_tokentype | int | 否 | 适用版本>=v7.0.2309a.20230907是否透传token,传1时透传 |
| *任意参数 | *任意类型 | 否 | 合作方自定义参数,要求以 _w_third_ 作为前缀,回调时会一并返回给开发者。 _w_third_appid 、 _w_third_file_id 字段已被使用,对接方请合理避开。 |
注意: 1.file*id 是由合作方自己生成并管理,需要保证一个 file_id 对应一个文件,也对应一个文件的多个版本; 2.file_id 建议使用字母与数字的格式,使用 #$%^&** 等与其他特殊符号会引起异常错误;3.所有参数值必须做urlencode,例如
http://xxxx:xx/api/edit/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 | 文件在线编辑链接 link规范:配置域名+/weboffice/office/{file_type}/{file_id}?_w_appid=11&用户自定义参数 |
| code | integer | 错误码,参照《错误码说明》 |
| msg | string | 状态信息 |
| request_time | long | 请求时间 |
| request_id | string | 请求标识id |
| response_time | long | 响应时间 |
响应体示例
json
{
"data": {
"link": "https://wwo.wps.cn/weboffice/office/w/471eba5030?_w_appid=d8f99da&_w_third_name=%E4%BC%9A%E8%AE%AE%E7%BA%AA%E8%A6%81.docx&_w_third_userid=33"
},
"code": 200,
"msg": "success",
"request_time": 1683858902,
"request_id": "1683858901",
"response_time": 1683858904
}