【wps文档中台】接口说明[v5.1.5_x86版本].docxVIP

文档中台 接口说明书 修订记录 版本号 修订人 修改日期 修改说明 V5.1.4 高成柳 2021-03-24 创建文档 V5.1.4 高成柳 2021-4-14 添加js-sdk接入方式 V5.1.5 高成柳 2021-5-11 WPS文档中台接口说明书 目录 TOC \o 1-3 \h \u 17387 1. 使用概述 1 9068 1.1 产品概述 1 28620 1.2 服务使用 1 20984 2. 接口说明 2 32190 2.1 接入指引 2 19196 2.1.1 应用注册 3 23366 2.1.2 应用授权 3 17739 2.1.3 应用参数配置 3 28096 2.1.4 服务授权获取 3 23364 2.1.5 应用能力实现 4 20157 2.2 鉴权说明 5 11834 2.3 应用管理 5 22587 2.3.1 流程说明 5 24126 2.3.2 名词解释 6 26578 2.3.3 API列表 6 16684 2.4 应用授权 24 14345 2.4.1 流程说明 24 23335 2.4.2 授权的作用域scope 25 26977 2.4.3 授权app_token 25 27622 2.4.4 API列表 26 24814 2.5 在线编辑 27 16259 2.5.1 流程说明 28 4204 2.5.2 接入须知 29 9899 2.5.3 API列表 30 7211 2.5.4 业务方实现回调API列表 31 22881 2.6 在线预览 44 13652 2.6.1 流程说明 44 24744 2.6.2 接入须知 45 29519 2.6.3 API列表 45 18144 2.6.4 格式说明 48 3407 2.7 格式处理 53 2960 2.7.1 流程说明 53 7505 2.7.2 API列表 54 32498 2.7.3 格式说明 69 8214 3. 错误码 81 2692 4. WPS-3签名 84 16860 4.1 签名算法说明 84 22368 4.2 Go代码示例 85 17886 4.3 Python代码示例 85 PAGE 5 PAGE 5 使用概述 产品概述 WPS文档中台是WPS云办公产品中对第三方围绕文档处理、文档管理，帮助企业业务服务实现在线协同办公，提升企业办公效率的赋能平台。WPS文档中台提炼WPS产品体系中对文档和协同办公的处理能力，通过标准Oauth2.0认证授权体系将能力进行授权封装，将能力进行原子化输出，为企业提供多元化的办公新体验。 服务使用 WPS文档中台支持通过界面和接口的方式对应用进行创建、删除、授权的管理。获取到应用的aksk之后，通过WPS-3签名调用，获取应用授权token，完成开放能力的接口调用。同时服务提供Demo源码和运行的服务进行服务的验证与开发调用指导。 参考文档 《WPS文档中台使用说明书》 《WPS文档中台Demo用户使用说明书》 WPS文档中台接口说明书 PAGE 5 PAGE 5 接口说明 接入指引 （文档中台对接流程） 文档中台同时支持通过可视化界面和接口调用完成应用管理。 第三方可根据对接平台的使用需求自由定义使用交互。下面主要介绍较为核心的使用场景：应用创建、应用配置设置、获取授权信息、应用授权申请等。 应用注册 通过金山实施同学获取服务的appid和appkey后，带上密钥进行wps-3接口签名调用应用创建接口（/admin/v1/app）。 应用授权 获取应用所能申请到的能力列表（/admin/v1/function/list），完成能力申请（/admin/v1/app/{app_id:[\w=+]+}/function/{function_id:\d+}）。 应用参数配置 为所获取申请的能力设置必要的配置参数，特别注意接口必填参数： 能力模块 配置参数 接口 必须实现 在线编辑 在线编辑文件信息、权限、版本管理等接口配置 /admin/v1/app/{app_id:[\w=+]+}/online