获取文件编辑信息(包含水印、权限等)
请求说明
| 请求地址 | 回调地址 + uri(默认为:/v1/3rd/edit/info) |
|---|---|
| 请求方法 | GET |
| 签名方式 | 无 |
请求头(Header)
| 名称 | 是否必填 | 说明 |
|---|---|---|
| Content-Type | 是 | 固定为: application/json |
| X-Weboffice-File-Id | 是 | 文件id |
| X-Wps-Weboffice-Token | 否 | 开发者通过JSSDK设置用于用户鉴权TOKEN |
查询参数(Query)
| 名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| _w_third_* | object | 否 | 合作方自定义参数, _w_third_作为前缀,_w_third_appid,_w_third_file_id 字段已被使用,对接方请合理避开 |
响应体(Response)
正常返回
| 名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| file | object | 是 | 文件信息 |
| ∟ id | string | 是 | 文件id,字符串长度小于64 |
| ∟ preview_pages | integer | 是 | 限制预览页数。 1. 用户操作权限 user.permission 为 write 时,限制不生效; 2. 用户操作权限 user.permission 为 read 时:previewPages 默认值为 0,不限制预览页数;previewPages >= 1 时,限制生效,限制的页数为 previewpages 字段的值 |
| ∟ user_acl | object | 否 | 用户权限 |
| ∟ ∟ rename | integer | 否 | 重命名权限,1为打开该权限,0为关闭该权限,默认为0 |
| ∟ ∟ history | integer | 否 | 历史版本权限,1为打开该权限,0为关闭该权限,默认为1 |
| ∟ ∟ copy | integer | 否 | 复制权限,1为打开该权限,0为关闭该权限, |
| ∟ ∟ export | integer | 否 | 导出权限,1为打开该权限,0为关闭该权限, |
| integer | 否 | 打印权限,1为打开该权限,0为关闭该权限, | |
| ∟ ∟ comment | integer | 否 | 只读情况下的可评论权限,1为打开该权限,0为关闭该权限, |
| ∟ ∟ copy_control | integer | 否 | 限制在当前系统内复制粘贴,1为打开该权限,0为关闭该权限 |
| ∟ ∟ manage_perm | integer | 否 | 轻维表甘特图设置权限,1为打开该权限,0为关闭该权限 |
| ∟ ∟ saveas | integer | 否 | 另存权限,1为打开该权限,0为关闭该权限 |
| ∟ watermark | object | 否 | 水印参数 |
| ∟ ∟ type | integer | 否 | 水印类型, 0为无水印; 1为文字水印 |
| ∟ ∟ value | string | 否 | 文字水印的文字,支持通过\r\n换行,支持emoji表情当type为1时此字段必选 |
| ∟ ∟ fillstyle | string | 否 | 水印的颜色(含透明度),非必选,有默认值。格式为:rgba( 192, 192, 192, 0.6 ) |
| ∟ ∟ font | string | 否 | 水印的字体,非必选,有默认值,格式为bold 20px Serif |
| ∟ ∟ rotate | float | 否 | 水印的旋转度(弧度),非必选,有默认值,默认为-0.7853982 |
| ∟ ∟ horizontal | integer | 否 | 水印水平间距,非必选,有默认值,默认为50 |
| ∟ ∟ vertical | integer | 否 | 水印垂直间距,非必选,有默认值,默认为100 |
| user | object | 是 | 用户信息 |
| ∟ id | string | 是 | 用户id,长度小于32 |
| ∟ name | string | 是 | 用户名称 |
| ∟ permission | string | 是 | 用户操作权限,write:可编辑,read:预览 |
| ∟ avatar_url | string | 否 | 用户头像地址,支持url和base64 |
| collaboration_switch | string | 否 | 协作开关:"open"表示协作开关开启,"closed"表示协作开关关闭,默认为"closed" |
正常返回示例
json
{
"file": {
"id": "132aa30a87064",
"preview_pages": 3,
"user_acl": {
"rename": 1,
"history": 1,
"copy": 1,
"export": 1,
"print": 1,
"comment": 1,
"copy_control": 1,
"manage_perm": 1,
"saveas": 1
},
"watermark": {
"type": 1,
"value": "禁止传阅",
"fillstyle": "rgba( 192, 192, 192, 0.6 )",
"font": "bold 20px Serif",
"rotate": -0.7853982,
"horizontal": 50,
"vertical": 100
}
},
"user": {
"id": "id1000",
"name": "wps-1000",
"permission": "read",
"avatar_url": "http://xxx.cn/id=1000"
},
"collaboration_switch":"closed"
}异常返回
| 名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| code | integer | 是 | 错误码,同预览编辑回调错误码 |
| message | string | 是 | 错误提示 |
| details | string | 是 | 错误提示详细信息 |
| hint | string | 否 | 自定义错误信息,当code为40007错误码时必填 |
异常返回示例
json
{
"code": 40005,
"message":"InvalidArgument",
"details": "参数错误",
"hint": "自定义错误提示"
}