OfficeWeb365在线编辑接口
OfficeWeb365文档在线编辑是一款编辑插件，在不需要安装第三方插件的情况下在浏览器中查看编辑文档。支持实时编辑，完成文档编辑之后可以回调到指定的OBS服务器。支持编辑之后的文档另存为PDF、OFD等格式。
一、Word在线编辑调用方式
第一步：新建文件
请求方式：POST
请求地址：https://edit.ow365.cn/api/doc/view/createnewfile
Boby请求参数：无
返回示例：
{
"code": 200,
"data": {
"request_id": "45c39bcbf1304a859baef2d99a66a7e7",
"view_url": "https://edit.ow365.cn/api/view?file_type=doc&view_id=HHD4NiCb6c6WRuy*aIhQSGkU4cay2dOzqcT5F_KRn0lV53l0D4FunQGKz1k37LSurWkE71xHMT*fn3Ylmqrltae8PFgky8bzEg_FbNgIX8zOiVbfo*y2ug--",
"is_allow_edite": true,
"file_id": null,
"is_callback": false
},
"msg": "success"
}
第二步：上传文件
💡 请求预览编辑接口上传需要编辑的Word文件。获取文档的编辑URL地址
请求方式：POST
请求地址：https://edit.ow365.cn/api/doc/view/uploadfile
参数:【表单数据】
Content-Type:multipart/form-data数据参数如下：
Boby请求参数
file: word文件【必填】
lastModified: 时间戳，文件的末次修改时间【非必填】
返回参数
返回示例
{
"code": 200,
"data": {
"request_id": "3dab1440db474f7899ac7ef1667349ac",
"view_id": "https://edit.ow365.cn/doc/?view_id=UFq61MK61d5x*a1pMoq3mLVC_OeN0I2HXWUqvtbmQiup_HGBZvgfEBK0OdIlQ_TMkx2iDPJxc3Uoui9UU3kJyc16RnGyblJAUUTXoFuvp0AkPWDHZEEIVzHXoPK5RnwbYpxTJNUK_WOLaY807QxiB0yjKESpUjAtA4p2jRDnOsRkbuwgYROH7*X7H4VTFXySyeBFIOWYdcrISvvxxw_opEYWx7k7j6D4LmZhq0fK*Nev9Wb8g*jFLgICOuclVNq1Bf3IvH*8or7ty6JshaWg9Xb0AtX2hV4kA_YVCP*yK1_SGjjjPA6adfxCztD9olBBWzj91QheV6QblI*mQAPoPojyuLPoR9Vjq7*HtXXtCftDhWqQ0tl2C1Wzep3ORxsbgdFTpPkLX6V6_Zq4MjbYkkXfxZaLreYrQmaCOsnoCYht9GJMRiitHK8Y3abZ3hkveVn3aXqh92Su1i3WolvEEbsf70QbKO2R1ztfdu1gRoCUryqxV5S7EDFwwd6tgW6I",
"isAllowEdite": true,
"fileEditorId": null,
"fileViewId": null
},
"msg": "success"
}
第三步：开始编辑
💡 将view_id中的文档在线编辑地址，放在浏览器或者嵌入基于浏览器的WebView、Ifream中既可实现Word文件的在线编辑。
(OfficeWeb365在线编辑)
(导出编辑之后的文件，另存文件)
文档编辑为实时保存，不需要进行额外的保存操作。编辑地址中的view_id作为每一次会话的唯一标识，当刷新页面或关闭页面再次编辑这一份文件需要携带view_id值既可。 注意view_id值的有效期为2小时。
第四步：回调方式
请求地址：https://edit.ow365.cn/subunit/file/callback
参数:【表单数据】
Content-Type:multipart/form-data数据参数如下：
Boby请求参数
view_id: 文件token也就是文件id【必填】
curl: 回调地址，文件上传的地址【必填】
toli: 文件回调类型，默认为0表示上传编辑后的Word文件 【1：回调编辑后的文件转PDF;2 编辑后的文件转ofd】【非必填】
sign: 向回调地址上传文件请求头携带的参数，此参数表示此请求是OfficeWeb365发起的，而不是非法请求。【非必填】
另外用户的回调地址，也就是接受文件的地址在收到文件结束之后，必须给一个相应。即就是返回一个状态字符串success。
二、Excel在线编辑调用方式
第一步：新建文件
请求方式：Get
请求地址：https://edit.ow365.cn/OnlineEditing/GetSkipNewUrl
Boby请求参数：无
返回示例：
{
"status": true,
"message": "获取数据成功",
"data": "/api/view?file_type=xls&view_id=h43fsut5NgVu4D5_3NS5sMpXu3yOtTKoq3BwIyEIFedXVvX1li8UP8Trxk6Dnm5EuwhvpxfVFPfB6ZBIzJbjDIXQqXeBoNBqk1d5jlHa9WEp1f7cMu*tOoqNxBux_LcqsFbkY9bcTk8-"
}
上述返回的新建地址data暂时需要拼接上预览服务域名，如下所示，后续会统一。
新建文件地址：https://edit.ow365.cn/api/view?file_type=xls&view_id=h43fsut5NgVu4D5_3NS5sMpXu3yOtTKoq3BwIyEIFedXVvX1li8UP8Trxk6Dnm5EuwhvpxfVFPfB6ZBIzJbjDIXQqXeBoNBqk1d5jlHa9WEp1f7cMu*tOoqNxBux_LcqsFbkY9bcTk8-
第二步：上传文件
💡 请求预览编辑接口上传需要编辑的Excel文件。获取文档的编辑URL地址
请求方式：POST
请求地址：https://edit.ow365.cn/OnlineEditing/GetPreviewUrl
参数:【表单数据】
Content-Type:multipart/form-data数据参数如下：
Boby请求参数
file: Excel文件【必填】
lastModified: 时间戳，文件的末次修改时间【非必填】
返回示例
{
"code": 200,
"data": {
"request_id": "89b391f8-f333-4bf0-80c1-1678be673168",
"view_url": "https://edit.ow365.cn/api/view?file_type=xls&view_id=h43fsut5NgUGa7AKsMCB9x2QWIsHsAcIWCzjko4fltl5n6aSJjdeyLduQX*wreGbHoPAf69cenuIVh2xLPYt7bU2ZGvvRyn4bJ0eHJWu3s*T8QnfjOaJfMfBIQ7Ihmqkc*bFo7aFueHp3hlaIYXZ_Q--"
},
"msg": "success"
}
第三步：开始编辑
💡 将data中的文档在线编辑地址，放在浏览器或者嵌入基于浏览器的WebView、Ifream中既可实现Word文件的在线编辑。
(OfficeWeb365在线编辑)
(导出编辑之后的文件，另存文件)
文档编辑为实时保存，不需要进行额外的保存操作。
第四步：回调方式
备注：用回调可忽略第二步上传文件调用编辑地址
1、新增客户信息
请求方式：POST
请求地http(s)://edit.ow365.cn/Customer/AddCustomer?customName=test0528
参数:【表单数据】
Content-Type:multipart/form-data数据参数如下：
Query 请求参数
customName: String【必填】
返回参数
返回customId
返回示例
{
"status": true,
"message": "新客户添加成功",
"data": {
"customId": "c391f9fe-727f-40f9-8536-88cbdef11772",
"userId": "用户id为必填项",
"customName": "test0528",
"callbackUrl": "保存文件回调地址",
"isDownLoadXlsx": false,
"isEdit": true,
"isPrint": true,
"isDownLoadPdf": false,
"isDownLoadImg": false,
"isDownLoadCsv": false,
"isDownLoadJson": false,
"isDisabled": false,
"isDelete": false,
"createTime": "2024-05-28T09:50:17.2525609+08:00",
"modifyTime": "2024-05-28T09:50:17.2525617+08:00",
"deleteTime": null
}
}
2、获取在线编辑带回调权限地址
请求方式：POST
请求地http(s)://edit.ow365.cn/Preview/GetPreviewUrl
参数:【表单数据】
Content-Type:multipart/form-data数据参数如下：
Boby请求参数
viewData: String【必填】
templateFile: Excel文件【必填】上传文件
返回示例
{
"status": true,
"message": "获取数据成功",
"data": {
"url": "edit.ow365.cn/api/view?file_type=xls&file=20240527174634436333a3-afaf-488a-88a1-b2ca8f342b55.xlsx&uid=202405271746342c0fc128-a9b7-4780-93bb-8da3b1ca8c69.xlsx"
}
}
3、查看目前客户信息
请求方式：POST
请求地址:http(s)://edit.ow365.cn/ Customer/GetCustomer?authName=CHENYIFEI&password=CHENYIFEI
参数:【表单数据】
Content-Type:multipart/form-data数据参数如下：
Query 请求参数
authName: String【必填】
password: String【必填】
返回示例
{
"status": true,
"message": "数据查询成功",
"data": [
{
"customId": "2c0fc128-a9b7-4780-93bb-8da3b1ca8c69",
"customName": "测试0527",
"callbackUrl": "http://回调的网络地址/SaveFileToMinio"
},
{
"customId": "7d5aa0ce-4200-4e23-b449-18498f36aba6",
"customName": null,
"callbackUrl": "保存文件回调地址"
},
{
"customId": "c391f9fe-727f-40f9-8536-88cbdef11772",
"customName": "test0528",
"callbackUrl": "保存文件回调地址"
}
]
}
三、PPT在线编辑调用方式
第一步：新建文件
请求方式：POST
请求地址：https://edit.ow365.cn/api/ppt/view/uploadfile
Content-Type:multipart/form-data数据参数如下：
Boby请求参数：
isCreateNew：新建文档【必填】
isBlank：空白文档【必填】
返回示例：
{
"code": 200,
"data": {
"view_url": "https://edit.ow365.cn/api/view?file_type=ppt&view_id=HHD4NiCb6c6WRuy*aIhQSGkU4cay2dOzP3eCUTd2gsSnOgfDre1fRtky9oj0yzUN9x6zv0mXsrAH8w3ksgzlJ5xfHJTJBM3E3b5WjoM2QlEwujtAA8tDoaIDLcNNLyyPWqtpzvlFvwoz0RJKfICW*w--",
"view_id": "HHD4NiCb6c6WRuyaIhQSGkU4cay2dOzP3eCUTd2gsSnOgfDre1fRtky9oj0yzUN9x6zv0mXsrAH8w3ksgzlJ5xfHJTJBM3E3b5WjoM2QlEwujtAA8tDoaIDLcNNLyyPWqtpzvlFvwoz0RJKfICWw--"
},
"msg": "success"
}
第二步：上传文件
💡 请求预览编辑接口上传需要编辑的PPT文件。获取文档的编辑URL地址
请求方式：POST
请求地址：https://edit.ow365.cn/api/ppt/view/uploadfile
参数:【表单数据】
Content-Type:multipart/form-data数据参数如下：
Boby请求参数
file: ppt文件【必填】
lastModified: 时间戳，文件的末次修改时间【非必填】
返回参数
返回示例
{
"code": 200,
"data": {
"pagesize": "19",
"view_url": "https://edit.ow365.cn/api/view?file_type=ppt&view_id=HHD4NiCb6c6WRuy*aIhQSGkU4cay2dOzqcT5F_KRn0mr0uINl0iZG6ek64__*gyo1HXvlw0DWq6CrshN1ooEq8u2hpkphayA0YwuJ1RPMUCp9e*qwyTlyuuKOrMzE30wrwJ5LF7z3Fun3atqcTlbKSObT8w3Q*0jGGCRFaWUo8k-",
"view_id": "HHD4NiCb6c6WRuyaIhQSGkU4cay2dOzqcT5F_KRn0mr0uINl0iZG6ek64__gyo1HXvlw0DWq6CrshN1ooEq8u2hpkphayA0YwuJ1RPMUCp9eqwyTlyuuKOrMzE30wrwJ5LF7z3Fun3atqcTlbKSObT8w3Q0jGGCRFaWUo8k-"
},
"msg": "success"
}
第三步：开始编辑
💡 将view_id中的文档在线编辑地址，放在浏览器或者嵌入基于浏览器的WebView、Ifream中既可实现PPT文件的在线编辑。
(OfficeWeb365在线编辑)
(导出编辑之后的文件，另存文件)
文档编辑为实时保存，不需要进行额外的保存操作。编辑地址中的view_id作为每一次会话的唯一标识，当刷新页面或关闭页面再次编辑这一份文件需要携带view_id值既可。 注意view_id值的有效期为2小时。
第四步：回调方式
请求地址：https://edit.ow365.cn/subunit/file/callback
参数:【表单数据】
Content-Type:multipart/form-data数据参数如下：
Boby请求参数
view_id: 文件token也就是文件id【必填】
curl: 回调地址，文件上传的地址【必填】
toli: 文件回调类型，默认为0表示上传编辑后的PPT文件 【1：回调编辑后的文件转PDF;2 编辑后的文件转ofd】【非必填】
sign: 向回调地址上传文件请求头携带的参数，此参数表示此请求是OfficeWeb365发起的，而不是非法请求。【非必填】
另外用户的回调地址，也就是接受文件的地址在收到文件结束之后，必须给一个相应。即就是返回一个状态字符串success。