快速接入

一.申请和上线流程如下:

1.申请Appid和SecretKey

需要前往https://open.wps.cn 注册服务商,并且申请开通金山文档在线编辑服务。

2.实现回调接口

根据本文档实现对应的回调接口,此回调接口会在用户使用金山文档服务的时候被调用,金山文档通过对应的回调接口获取对应的文件信息,这些接口都是被金山文档服务端调用,不会直接暴露给用户。

3.将回调接口服务部署到线上

回调接口开发完成之后需要部署到线上,并且需要在https://open.wps.cn 的对应金山文档在线编辑服务商修改数据回调接口的url。

4.生成带签名的访问url

根据提供的appid和secretkey和对接模块需要透传的参数,按要求生成签名,然后生成一个可以在线编辑文档的url,可以通过此url访问金山文档在线编辑服务。

5.根据文件格式生成的url

表格文件url:

https://wwo.wps.cn/office/s/:file_id?_w_appid=xxxxxxxxxxx&_w_param1=xxxx&_w_param2=xxxxxx&_w_signature=xxx

文字文件url:

https://wwo.wps.cn/office/w/:file_id?_w_appid=xxxxxxxxxxx&_w_param1=xxxx&_w_param2=xxxxxx&_w_signature=xxx

演示文件url:

https://wwo.wps.cn/office/p/:file_id?_w_appid=xxxxxxxxxxx&_w_param1=xxxx&_w_param2=xxxxxx&_w_signature=xxx

PDF文件url:

https://wwo.wps.cn/office/f/:fileid?_w_appid=xxxxxxxxxxx&_w_param1=xxxx&_w_param2=xxxxxx&_w_signature=xxx

请开发者关注:所有对接模块相关的参数都要以”_w”作为前缀,否则容易导致签名不能通过验证。


二.回调接口列表

回调地址方法功能描述
/v1/3rd/file/infoGET获取文件元数据在预览或编辑的时候,通过接口校验权限并获取文件信息
/v1/3rd/user/infoPOST获取用户信息在编辑的时候获取编辑过此文件的用户信息,展示在协作记录里面
/v1/3rd/file/savePOST上传文件新版本编辑完保存回对应云盘
/v1/3rd/file/onlinePOST通知文件有那些人在协作协作通知此文件目前有那些人正在协作
/v1/3rd/file/version/:versionGET获取特定版本的文件信息在回滚版本的时候需要获取历史版本的文件信息
/v1/3rd/file/renamePUT文件重命名当用户有重命名权限时,重命名时调用的接口
/v1/3rd/file/historyPOST获取所有历史版本文件信息显示在历史版本列表中
/v1/3rd/file/newPOST新建文件通过模板新建需要提供的接口

注意: 详细的接口信息请移步金山文档在线编辑API介绍

三.访问地址

1. 文档访问的url地址根据此格式生成:

https://wwo.wps.cn/office/<:type>/<:fileid>?_w_appid=xxxxxxxxxxxxxxxxxxxxxxxxxxxappid&_w_signature=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&……(对接模块需要的自定义参数)

2. 文档访问是进入在线编辑模式还是预览模式,取决于对接模块返回的文件元数据中permission返回的值,为“write”进入编辑模式,为“read”进入预览模式,详见3.2.1。

文字文件示例:

https://wwo.wps.cn/office/w/471eba50307c1f9dc540?_w_fname=%E4%BC%9A%E8%AE%AE%E7%BA%AA%E8%A6%81.docx&_w_userid=33&_w_appid=d8f99daa999e47965f4b9727e32ddaa8&_w_permission=read&_w_signature=I%2BnTsXn8F5wp%2FBqzOP4fX6E2s2M%3D

表格文件示例:

https://wwo.wps.cn/office/s/56922f98b164afbd0daf?_w_fname=%E8%80%83%E5%8B%A4%E8%A1%A8.xlsx&_w_userid=33&_w_appid=d8f99daa999e47965f4b9727e32ddaa8&_w_permission=read&_w_signature=g4fJKz5GToEV2UpekVytveCI8oI%3D

演示文件示例:

https://wwo.wps.cn/office/p/b08631b2e65b0c1b8fb6?_w_fname=%E5%B7%A5%E4%BD%9C%E6%80%BB%E7%BB%93.pptx&_w_userid=31&_w_appid=d8f99daa999e47965f4b9727e32ddaa8&_w_permission=read&_w_signature=JlUqYGu5eyPhIAaa4kRNp1Q8yEo%3D

PDF文件示例:

https://wwo.wps.cn/office/f/548c695ebac24f746a91?_w_fname=%E7%BA%A2%E5%A4%B4%E6%96%87%E4%BB%B6.pdf&_w_userid=0&_w_appid=d8f99daa999e47965f4b9727e32ddaa8&_w_permission=write&_w_signature=9E8gQ4myphpfqB5tIGbrVFn6b1Q%3D

有任何疑问,请加入QQ群: 732130805 或者联系open@wps.cn获取帮助。