office-pc-plug/doc/桌面插件接口文档.md

下载并打开线上文件

url：127.0.0.1:5855/download_and_open_file

method: post

请求: 参数说明

字段名称	类型	解释	示例
file_id	string	文件id

示例：

{"file_id":"sgjufgsajlgdfusyag", 
}

返回：

参数说明：

字段名称	类型	解释	示例
code	int	业务代码	1000: 操作完成， 2001: 检测到文档正在被编辑，无法下载 2002: 检测到远程文件已经更新本地文件也发生改动，终止操作 3001: 不支持该类型的文件 3002: 下载文件失败
msg	string	返回消息

示例：

{
    "code": 1000,
    "msg": "操作完成"
}

获取本地文件状态

url：127.0.0.1:5855/file_state_list

method: get

请求参数：无

返回：

字段名称	类型	解释	示例
code	int	业务代码	1000 ：操作成功 3000：操作失败
msg	string
data	list[dict,]
file_name	string	文件名
cloud_update_time	string	云端文件更新时间
source_md5	string	下载文件时文件的md5值
show_name	string	展示的文件名
state	int	文件当前状态	0 正常， 1: 云端有更新 2: 本地有变动且无冲突可以上传 3: 本地文件和云端文件有冲突 4：云端文件已被删除

示例：

{
    "code": 1000,
    "msg":"操作完成",
    "data":[
        {
            "file_name":"xxx.csv",
            "cloud_update_time":"2025-06-05 12:00:00",
            "source_md5": "***********************",
            "show_name":"xxx.csv"
            "state":0
        }
    ]
}

上传本地文件

url：127.0.0.1:5855/upload_local_file

method: post

注：上传文件后会尝试删除本地文件，此接口会覆盖线上文件

请求: 参数说明

字段名称	类型	解释	示例
file_name	string	文件名

示例：

{"file_name":"aaa.csv"}

返回示例：

{
    "code":1000,
    "msg": "操作成功"
}

字段名称	类型	解释	示例
code	int	业务代码	1000：操作成功 3003：操作失败，上传文件失败 3004：操作失败，文件已被打开无法操作
msg	string	返回消息

更新本地文件

url：127.0.0.1:5855/update_local_file

method: post

注：此接口会强制覆盖本地文件

请求: 参数说明

字段名称	类型	解释	示例
file_name	string	文件名

{
    "file_name": "aaa.csv"
}

响应：

字段名称	类型	解释	示例
code	int	业务代码	1000：操作成功 3004：操作失败，文件已被打开无法操作 3005：操作失败，无权限操作本地文件
msg	string

删除本地文件

url：127.0.0.1:5855/remove_file

method: post

字段名称	类型	解释	示例
file_name	string	文件名

{
    "file_name": "aaa.csv"
}

响应

字段名称	类型	解释	示例
code	int	业务代码	1000：操作成功 3006：操作失败，文件不存在 3005：操作失败，无权限操作本地文件
msg	string

打开本地文件

url：127.0.0.1:5855/open_file

method: post

字段名称	类型	解释	示例
file_name	string	文件名

{
    "file_name": "aaa.csv"
}

响应

字段名称	类型	解释	示例
code	int	业务代码	1000：操作成功 3006：操作失败，文件不存在 3001：操作失败，不支持该类型的文件
msg	string