开启文件分享
适用版本>=v7.0.2308b.20230824
接口说明:开启分享
请求说明
| 请求地址 | 配置域名+/graph+/v7/drives/{drive_id}/files/{file_id}/open_link |
|---|---|
| 请求方法 | POST |
| 签名方式 | WPS-4签名/WPS-4-GM签名(配置域名+/graph不参与签名) |
| 权限要求 | 管理文件分享(用户授权) kso.file.share.write 应用管理文件分享(应用授权) kso.appdrive.file.share.write |
请求头(Header)
| 名称 | 是否必填 | 说明 |
|---|---|---|
| Content-Type | 是 | 固定为: application/json |
| Wps-Docs-Date | 是 | 取当前时间, 示例: Wed, 23 Jan 2013 06:43:08 GMT |
| Wps-Docs-Authorization | 是 | 计算方法参考签名说明 |
| Authorization | 是 | 授权凭证,格式为: Bearer {access_token} |
路径参数(Path)
| 名称 | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| drive_id | string | 是 | 驱动盘id,<= 1024 characters |
| file_id | string | 是 | 文件id,<= 1024 characters |
请求体(Body)
| 名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| opts | object | 否 | 链接选项 |
| ∟ allow_perm_apply | bool | 否 | 允许申请权限 |
| ∟ check_code | string | 否 | 访问密码,<= 1024 characters |
| ∟ close_after_expire | bool | 否 | 过期后取消分享链接 |
| ∟ expire_period | int | 否 | 过期时长,Enum: 0 7 30 |
| ∟ expire_time | int | 否 | 过期时间点 |
| role_id | string | 是 | 权限角色,<= 1024 characters。 支持仅查看 view_only、可编辑editable、可评论commentable、可管理manageable、可分享shareable、禁止访问prohibited和自定义权限角色 (自定义权限角色请通过获取文档权限角色列表获取role_id) |
| scope | string | 是 | 权限范围,users: 仅指定人;company:本企业内;login_users:本系统用户(多租户场景使用) |
请求体示例
{
"opts": {
"allow_perm_apply": true,
"check_code": "string",
"close_after_expire": true,
"expire_period": 0,
"expire_time": 0
},
"role_id": "string",
"scope": "company"
}响应体(Response)
| 名称 | 类型 | 说明 |
|---|---|---|
| code | integer | code |
| detail | string | detail |
| msg | string | msg |
| data | object | null |
响应体示例
{
"data": null,
"code": 0,
"detail": "string",
"msg": "string"
}