文档预览

本节介绍文档预览相关的接口，接入方必须全部实现才能正常打开并预览文档。

GetPermission

获取用户对文件的操作权限；鉴权场景需要实现该接口，非鉴权场景不会调用 接口: GET /open3rd/files/{file_id}/permission

请求参数

字段	位置	必填	说明
file_id	Path	是	第三方存储系统文件ID，需要能够被编码的URL中，只允许由数字、字母、下划线、中划线组成，且不能以下划线开头

响应参数

字段	必须	类型	说明
user_id	否	string	当前操作的用户 ID，长度100字符以内
read	是	bool	当前用户是否具有读权限
copy	是	bool	当前用户是否具有拷贝文档内容权限
comment	是	bool	当前用户是否具有查看评论权限
print	是	bool	当前用户是否具有打印文档权限

示例

{
    "code": 0,
    "message": "",
    "data": {
        "user_id": "test-user1",
        "read": true,
        "copy": false,
        "comment": false,
        "print": false
    }
}

GetFileInfo

获取文件的信息 接口： GET /open3rd/files/{file_id}

请求参数

字段	位置	必填	说明
file_id	Path	是	第三方存储系统文件ID，需要能够被编码的URL中，只允许由数字、字母、下划线、中划线组成，且不能以下划线开头

响应参数

字段	必须	类型	说明
id	是	string	文件ID
name	是	string	文件名称
version	否	int64	文件版本，从0开始，每次编辑保存后递增
create_time	否	int64	文件创建的 Unix 时间戳，秒
update_time	否	int64	文件最后更新的 Unix 时间戳，秒
creator_id	否	string	文档创建者用户 ID
size	是	uint64	文件大小，byte

示例

{
  "code": 0,
  "message": "",
  "data": {
    "id": "pdf-1m-0",
    "name": "1M-pdf.pdf",
    "size": 1050527
  }
}

GetFileDownloadInfo

获取文件的下载链接和请求参数 接口：GET /open3rd/files/{file_id}/download

请求参数

字段	位置	必填	说明
file_id	Path	是	第三方存储系统文件ID，只允许由数字、字母、下划线、中划线组成，且不能以下划线开头

响应参数

字段	必须	类型	说明
url	是	string	文件下载链接，如需鉴权则需要带上鉴权参数；需要支持分片下载，协议参考HTTP 请求范围 (opens new window)
digest	否	string	文件 checksum
digest_algorithm	否	string	md5/sha1

示例

{
    "code": 0,
    "message": "",
    "data": {
        "url": "https://docs-web-sdk-1307749480.cos.ap-nanjing.myqcloud.com/pdf/1M-pdf.pdf",
        "digest": "",
        "digest_algorithm": ""
    }
}

GetWatermark

获取文件的水印 接口： GET /open3rd/files/{file_id}/watermark

请求参数

字段	位置	必填	说明
file_id	Path	是	第三方存储系统文件ID，只允许由数字、字母、下划线、中划线组成，且不能以下划线开头

响应参数

字段	必须	类型	说明
type	是	integer	水印类型，0表示无水印，1表示文字水印
value	是	string	水印显示的文字内容

示例

{
    "code": 0,
    "message": "",
    "data": {
        "type": 1,
        "value": "测试水印"
    }
}