快速接入
一.申请和上线流程如下:
1.申请Appid和SecretKey
需要前往https://open.wps.cn 注册服务商,并且申请开通金山文档在线编辑服务。
2.实现回调接口
根据本文档实现对应的回调接口,此回调接口会在用户使用金山文档服务的时候被调用,金山文档通过对应的回调接口获取对应的文件信息,这些接口都是被金山文档服务端调用,不会直接暴露给用户。
3.将回调接口服务部署到线上
回调接口开发完成之后需要部署到线上,并且需要在https://open.wps.cn 的对应金山文档在线编辑服务商修改数据回调接口的url。
4.生成带签名的访问url
根据提供的appid和secretkey和对接模块需要透传的参数,按要求生成签名,然后生成一个可以在线编辑文档的url,可以通过此url访问金山文档在线编辑服务。
5.根据文件格式生成的url
表格文件url:
文字文件url:
演示文件url:
PDF文件url:
请开发者关注:所有对接模块相关的参数都要以”_w”作为前缀,否则容易导致签名不能通过验证。
二.回调接口列表
回调地址 | 方法 | 功能 | 描述 |
---|---|---|---|
/v1/3rd/file/info | GET | 获取文件元数据 | 在预览或编辑的时候,通过接口校验权限并获取文件信息 |
/v1/3rd/user/info | POST | 获取用户信息 | 在编辑的时候获取编辑过此文件的用户信息,展示在协作记录里面 |
/v1/3rd/file/save | POST | 上传文件新版本 | 编辑完保存回对应云盘 |
/v1/3rd/file/online | POST | 通知文件有那些人在协作协作 | 通知此文件目前有那些人正在协作 |
/v1/3rd/file/version/:version | GET | 获取特定版本的文件信息 | 在回滚版本的时候需要获取历史版本的文件信息 |
/v1/3rd/file/rename | PUT | 文件重命名 | 当用户有重命名权限时,重命名时调用的接口 |
/v1/3rd/file/history | POST | 获取所有历史版本文件信息 | 显示在历史版本列表中 |
/v1/3rd/file/new | POST | 新建文件 | 通过模板新建需要提供的接口 |
注意: 详细的接口信息请移步金山文档在线编辑API介绍。
三.访问地址
1. 文档访问的url地址根据此格式生成:
https://wwo.wps.cn/office/<:type>/<:fileid>?_w_appid=xxxxxxxxxxxxxxxxxxxxxxxxxxxappid&_w_signature=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx&……(对接模块需要的自定义参数)
2. 文档访问是进入在线编辑模式还是预览模式,取决于对接模块返回的文件元数据中permission返回的值,为“write”进入编辑模式,为“read”进入预览模式,详见3.2.1。
文字文件示例:
表格文件示例:
演示文件示例:
PDF文件示例:
有任何疑问,请加入QQ群: 732130805 或者联系open@wps.cn获取帮助。