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

[TOC]

下载并打开线上文件

url：127.0.0.1:5855/download_and_open_file

method: post

请求: 参数说明

字段名称	类型	解释	示例
file_id	string	文件id
is_template	int	是否为模板文件（1=是，0=否）

示例：

{"file_id":"sgjufgsajlgdfusyag", "is_template":1}

返回：

参数说明：

字段名称	类型	解释	示例
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

启动wps插件安装服务

url：127.0.0.1:5855/start_wps_server

method: post

参数：无

响应

字段名称	类型	解释	示例
code	int	业务代码	1000：操作成功

注：

前端需要在服务启动后调用接口进行加载项安装/卸载：

接口地址 127.0.0.1:5855/deployaddons/runParams

参数示例：

{
    "data": {"cmd": "enable", "name": "jx_office", "url": "http://127.0.0.1:58890/", "addonType": "wps","online": "true"},# data字段需要使用base64编码，data中的cmd字段enable为安装/更新，disable为卸载
    
    "serverId": "aef5ac0d-d5a3-49ee-b02f-c31eeb063f9b"}

返回 成功：OK 失败：failed

获取插件状态接口：

接口地址：http://127.0.0.1:58890/deployaddons/runParams

headers：content-type=text/plain;charset=UTF-8

请求参数：

{"serverId":"aef5ac0d-d5a3-49ee-b02f-c31eeb063f9b"}

返回实例：

[
	{
		"addonType" : "wps",
		"customDomain" : "",
		"enable" : "false",
		"name" : "wpsPlugin",
		"online" : "true",
		"tagname" : "jspluginonline",
		"url" : "http://120.195.49.22:7212/",
		"version" : ""
	},
	{
		"addonType" : "wps",
		"customDomain" : "",
		"enable" : "enable_dev",
		"name" : "jx_office",
		"online" : "true",
		"tagname" : "jspluginonline",
		"url" : "http://127.0.0.1:5855/",
		"version" : ""
	}
]

下载线上文件

url：127.0.0.1:5855/download_cloud_file

method: post

请求: 参数说明

字段名称	类型	解释	示例
file_id	string	文件id
is_template	int	是否为模板文件（1=是，0=否）

示例：

{"file_id":"sgjufgsajlgdfusyag","is_template":1}

返回：

参数说明：

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

示例：

{
    "code": 1000,
    "msg": "操作完成",
    "file_path":"D:/test.docx"
}

获取用户登录信息

url：127.0.0.1:5855/get_token

method: post 参数： 无 响应：

{
    "access_token": "nOaPPqWxiolVN-jJWIYvyEpqPmIVUHPPxGVqL6qvOM4lLEHBE6CGpNEFc9vRYa4HFB3_O70QeienrtPPpeW3iF2IVqgMuL4iAGb5nkEfA05mlE6UPFQcN-7BkoJtrhqs",
    "expires_in": 3000000,
    "permissions": [],
    "refresh_token": "fNz8ntCsFnOMdfIeEKVQYbgiX8zMIKFzqwo8Tl5_KlZMZiWWGagzAbq1F3JuoMGMg97_9rc9yye5BOuB-ldSjYfIksugYXrgzVyY7mccliQf0jla1JB-nJCQrD6hn2i-",
    "tokenType": {
        "value": "Bearer"
    },
    "userDto": "b43444018837fff1002d608fc623b70f5617fceccc0350cc56be9e605c491cafbcaa66d2e342805082fe367c2f263c13b34097075c305547823daa6ec52a11259b676a6ce55ee055b4c93d0287fdd549adef38aec3528d40ba8dbf8a98961d7221ab2f77b87ddfd8f00a934558956d710454e860521d953b09f33f29f058e14e1c83d6018f0f9abb31511ccd14ca2d808918e395833d3cd2d17d01d68e12e9ed54185d23e3935dc5ea71990cad773260098d9b563aa99f57e33171404b236e5ba4b35ef036fca91ba34e8c817786bb13c6d5f893d23de776d3d1b118475da805b825b81e45cc5d7e949f0db11a9c1be0a90619580d0766be8c67a423d58e9e617c9a77bd1c791e7cb8594fd729a2239845ff6f4b5f52c1e71d35b6d65384f68edd12e64a65bccbc9b928c263ff3a2495c8637526224bc9443698169464ba60164b42ff896b6319e272a1fbbe5adefa2d81da59f86126e68aeb5d56c4d298756e50966704acc0699f5cc6c176bbc6d94ddcf4c4b3929f9144a64465dda49fdb7ee8622585118d50017eaef7c0fe7fc85a4f51b7f8ceee3aba0f87ca4ff56c96ccad510473c061d96a4ec23ad4bf5c26e7bcc9c1d82abc500b99b116bf504ba84862f5fcef2a728ffed818727c0d52caca5618b5a68753d79f6b490ed4f3faae000bdaba870f3f3c979969bcd72e40b05b9e64ff3e2bc6b6e77df1c1dc2bcd4851e9ba304c9ef8a7f8da7d7ed88e930aa4d808f274b7ed30004a124ec7752bcb1efc45e0178946b77671f61451cc0cae2044b10f1feca5534ff706a81d68b517a0924d3c656c725920fcab2f3fe3c9e48a621389ecb0a16bb14daf7de2f0781d184b8380c03f6c6e68cf74826249f04e4fd1d0beebdf8895db8df9dfaa5f9bb6a14e40a96cc00d351fb9be9cab107fb647e0e5f86d07193bafdc6644ab8b88f569c5852c5d1839b21d323ecdf4859e07f1f2e65f77cd34068ca7056408076b81900fc1457a7a7e6a96cc0a84f2be3179a1d5e1c89435be1ac0004bd4580d32b9c35303d9a6724a48b7380f144214ba0959de7c09e2015617696882452c56bd705212868b6fdab70dba7a56e8b09cd14ebb02894cd88d70ab2e149b9a26789e86766095e6f10dd3687c758e83e7df0a63e10bc203a86447b1a3464d9d8a611ceaec34af303a549613b7667090f574e9bb7aa9f6765cb4c259accfea7216d86f86be7e91a1768613a0d3b4b2f7f546a78ff55255abf219a1af14a46e835df565ca349dc9ece52604134a976a1d5816fb8efe9820ffb561748b3f080f122d7ab666881355c51bc7d79cee23fd33931df2c2789a55d5d7589603550aebd789365fb89d22bf11dc5a1dca8777678f157c7b52fbdeef043ff7a0f6f6ab129530e12dc3a048f661b0ac703e5ede4948c895bf99acbcc811688818ca35c602337ec9024dfbe877dae73d78693d3e912399dd5cf4c3f33f379fc02a7eedeeb7591d748cb50fb12c101d89fda2a0ce1f7e56fcde0d7e00969ebb137dd2cfd158aceff9ad38268c71f8f609c1f5f7024b39777c926d250bf35a0e958a410558b09dc36d8752d9dd92b905923a20892b15b659eefb120668890cfdbc0d259de295b6b19285cd46169635aefa66d8325fa14f40ee572f4996b358f10b561b41d30b6688905d07b3b662f3fe0dfe69b4f35683898df2f2ee4e29e39ec32b7b64738cc8814560d51b0a9dc8639ff875d42313519ded97ea173631b24f4d6a7bccb6f08a3cd07bcea426d929114ee329d0e41d450ae4a21c699e4935724244bb1180d3551afb796971c9658f46c01ded98bd73eb3a843360cbd4c4b779afe83dc4d7557ba082a481b848adc9d1b004f9c3a271fd4a6592269ad1cccb0fc4bb31b9e793339ecbdd5927f474004ee8436db5c80640f1685a5f555f743092b9177dc21c356d2c85f423742c6045e0b586f1f19cc268484dfac81fcabe3fa84fa2d2584547bfe884c834d299d847009692bc508c02fce14e6e9ef1afc0572a3c0b5175fc229ffe9bd671d7a0f200ab063b0c68a4987df1945167297abd8fa586e03cfa9b0fcaa22d251e47b910bf27e5d7f59da2b69e952e8154e950ab3adb258808783413dfaa7ac527e9af1e6d4f42e400ff8f7f5e01380c83b933fb84cec1b90b44166ca1744eadf4d7",
    "username": "admin"
}

刷新用户登录信息

url：127.0.0.1:5855/refresh_token

method: post 参数： 无 响应：

{
    "access_token": "nOaPPqWxiolVN-jJWIYvyEpqPmIVUHPPxGVqL6qvOM4lLEHBE6CGpNEFc9vRYa4HFB3_O70QeienrtPPpeW3iF2IVqgMuL4iAGb5nkEfA05mlE6UPFQcN-7BkoJtrhqs",
    "expires_in": 3000000,
    "permissions": [],
    "refresh_token": "fNz8ntCsFnOMdfIeEKVQYbgiX8zMIKFzqwo8Tl5_KlZMZiWWGagzAbq1F3JuoMGMg97_9rc9yye5BOuB-ldSjYfIksugYXrgzVyY7mccliQf0jla1JB-nJCQrD6hn2i-",
    "tokenType": {
        "value": "Bearer"
    },
    "userDto": "b43444018837fff1002d608fc623b70f5617fceccc0350cc56be9e605c491cafbcaa66d2e342805082fe367c2f263c13b34097075c305547823daa6ec52a11259b676a6ce55ee055b4c93d0287fdd549adef38aec3528d40ba8dbf8a98961d7221ab2f77b87ddfd8f00a934558956d710454e860521d953b09f33f29f058e14e1c83d6018f0f9abb31511ccd14ca2d808918e395833d3cd2d17d01d68e12e9ed54185d23e3935dc5ea71990cad773260098d9b563aa99f57e33171404b236e5ba4b35ef036fca91ba34e8c817786bb13c6d5f893d23de776d3d1b118475da805b825b81e45cc5d7e949f0db11a9c1be0a90619580d0766be8c67a423d58e9e617c9a77bd1c791e7cb8594fd729a2239845ff6f4b5f52c1e71d35b6d65384f68edd12e64a65bccbc9b928c263ff3a2495c8637526224bc9443698169464ba60164b42ff896b6319e272a1fbbe5adefa2d81da59f86126e68aeb5d56c4d298756e50966704acc0699f5cc6c176bbc6d94ddcf4c4b3929f9144a64465dda49fdb7ee8622585118d50017eaef7c0fe7fc85a4f51b7f8ceee3aba0f87ca4ff56c96ccad510473c061d96a4ec23ad4bf5c26e7bcc9c1d82abc500b99b116bf504ba84862f5fcef2a728ffed818727c0d52caca5618b5a68753d79f6b490ed4f3faae000bdaba870f3f3c979969bcd72e40b05b9e64ff3e2bc6b6e77df1c1dc2bcd4851e9ba304c9ef8a7f8da7d7ed88e930aa4d808f274b7ed30004a124ec7752bcb1efc45e0178946b77671f61451cc0cae2044b10f1feca5534ff706a81d68b517a0924d3c656c725920fcab2f3fe3c9e48a621389ecb0a16bb14daf7de2f0781d184b8380c03f6c6e68cf74826249f04e4fd1d0beebdf8895db8df9dfaa5f9bb6a14e40a96cc00d351fb9be9cab107fb647e0e5f86d07193bafdc6644ab8b88f569c5852c5d1839b21d323ecdf4859e07f1f2e65f77cd34068ca7056408076b81900fc1457a7a7e6a96cc0a84f2be3179a1d5e1c89435be1ac0004bd4580d32b9c35303d9a6724a48b7380f144214ba0959de7c09e2015617696882452c56bd705212868b6fdab70dba7a56e8b09cd14ebb02894cd88d70ab2e149b9a26789e86766095e6f10dd3687c758e83e7df0a63e10bc203a86447b1a3464d9d8a611ceaec34af303a549613b7667090f574e9bb7aa9f6765cb4c259accfea7216d86f86be7e91a1768613a0d3b4b2f7f546a78ff55255abf219a1af14a46e835df565ca349dc9ece52604134a976a1d5816fb8efe9820ffb561748b3f080f122d7ab666881355c51bc7d79cee23fd33931df2c2789a55d5d7589603550aebd789365fb89d22bf11dc5a1dca8777678f157c7b52fbdeef043ff7a0f6f6ab129530e12dc3a048f661b0ac703e5ede4948c895bf99acbcc811688818ca35c602337ec9024dfbe877dae73d78693d3e912399dd5cf4c3f33f379fc02a7eedeeb7591d748cb50fb12c101d89fda2a0ce1f7e56fcde0d7e00969ebb137dd2cfd158aceff9ad38268c71f8f609c1f5f7024b39777c926d250bf35a0e958a410558b09dc36d8752d9dd92b905923a20892b15b659eefb120668890cfdbc0d259de295b6b19285cd46169635aefa66d8325fa14f40ee572f4996b358f10b561b41d30b6688905d07b3b662f3fe0dfe69b4f35683898df2f2ee4e29e39ec32b7b64738cc8814560d51b0a9dc8639ff875d42313519ded97ea173631b24f4d6a7bccb6f08a3cd07bcea426d929114ee329d0e41d450ae4a21c699e4935724244bb1180d3551afb796971c9658f46c01ded98bd73eb3a843360cbd4c4b779afe83dc4d7557ba082a481b848adc9d1b004f9c3a271fd4a6592269ad1cccb0fc4bb31b9e793339ecbdd5927f474004ee8436db5c80640f1685a5f555f743092b9177dc21c356d2c85f423742c6045e0b586f1f19cc268484dfac81fcabe3fa84fa2d2584547bfe884c834d299d847009692bc508c02fce14e6e9ef1afc0572a3c0b5175fc229ffe9bd671d7a0f200ab063b0c68a4987df1945167297abd8fa586e03cfa9b0fcaa22d251e47b910bf27e5d7f59da2b69e952e8154e950ab3adb258808783413dfaa7ac527e9af1e6d4f42e400ff8f7f5e01380c83b933fb84cec1b90b44166ca1744eadf4d7",
    "username": "admin"
}