Skip to content

接口文档

公共集成接口

上传文件

事项描述备注
功能上传文件
接口地址/storage/upload
请求方式POST
请求参数form-data上传文件二进制流

请求参数

json
    form-data: file: (binary)

返回结果

json
    {
        "code": 0,
        "data": "e4959e36d4132665b7307a534b600b14", //文件uuid
        "ts": 1678456430,
        "rid": null,
        "msg": "success",
        "success": true
    }

预览文件

事项描述备注
功能预览文件
接口地址/view/url
请求方式GET
请求参数url文档远程地址
请求参数name文档名称,包含后缀
请求参数uuid文档uuid,上传文件接口返回
请求参数token预览的权限token
请求参数convertType预览模式切换

返回结果

json
    预览页面

私有集成接口

私有集成接口,需要在请求header中包含token字段,token字段后台配置,服务认为此token是admin账户权限

alt text

设置权限token

事项描述备注
功能设置用户权限token
接口地址/permission/setPermission
请求方式POST
请求参数JSON
json
{
    "token": "xxxxxxx",
    "userName": "通用预览用户",
    "fileInfo": {
        "uuid": "*", // * 表示所有文件
        "url": "http://xxx",
        "name": "test.docx"
    },
    "previewConfig": {
        "enable": true, // 允许预览
        "watermarkTxt": "ok"// 自定义水印
    },
    "editConfig": {
        "enable": true, // 允许编辑
        "revision": {
            "openRevision": true, // 打开修订
            "showRevision": true// 显示修订
        },
        "disableGroups": "",
        "disableBtns": ""
    }
}

返回结果

json
{"code": 0,"data": "操作成功","ts": 1681229137,"rid": null,"msg": "success","success": true}

编辑回传

事项描述备注
功能编辑文档后回传给业务方,会请求业务方指定接口,并入参,预览服务仅校验statusCode200
接口地址业务方指定,配置到后台
请求方式POST
请求头multipart/form-data
请求参数url远程文件地址
请求参数name文件名
请求参数uuid文件uuid
请求参数file文件流