1. 概述

WPS Open SDK(鸿蒙)为第三方应用提供在 HarmonyOS 上拉起 WPS 打开、编辑文档的能力。SDK 以 HAR 包形式交付,对外统一入口为单例 WPSApi

1.1 核心能力

能力说明

应用注册:校验三方应用接入资格

打开文档:拉起 WPS 打开本地文件

打开模式:只读 / 可编辑

水印 / 修订:打开时配置水印、修订模式

功能开关:通过 extraOptions 控制分享、云文档、打印等 WPS 内功能

关闭回传:用户关闭文档后将编辑结果以 URI 或 FD 方式回传给三方应用

文档不落地:仅专业版 SDK 生效,控制文件是否在 WPS 侧持久化缓存

1.2 对接流程概览

① 向 WPS 申请接入凭据(appKey + appSecret)及对应版本 SDK HAR

↓② 集成 HAR,在应用启动时调用 registerApp 完成注册        

↓③ (专业版)在 registerApp 成功回调中调用 setWpsFileToken 设置激活序列号        

↓④ 构造 OpenFileRequest,调用 sendRequest 打开文档        

↓⑤ (可选)处理关闭回传结果

2. ToB 与 ToC 版本说明

ToB(专业版)与 ToC(个人版)为不同的 SDK 包,申请 SDK HAR 及接入凭据时需明确所需版本。两个版本 API 一致,但部分参数行为不同。

重要:请使用与申请版本匹配的 SDK HAR 及接入凭据,专业版与个人版凭据不可混用。凭据与三方应用包名绑定,变更包名需重新申请。


2.1 如何判断当前 SDK 版本

SDK 提供公开方法用于区分版本,无需厂商自行判断 WPS 包名:


3. 接入准备

3.1 向 WPS 申请

SDK 接入凭据(appKey / appSecret)及 HAR 包

邮件建议注明:应用名称、Bundle 包名、所需 SDK 版本(专业版 / 个人版)、联系人及用途说明。

WPS 专业版激活序列号请另行联系 WPS 商务 / 技术支持 申请,与 SDK 凭据申请渠道不同。

SDK HAR 包:@wps/wps_sdk,注明 ToB 或 ToC

appKey:接入凭据,由 WPS 签发

appSecret:接入凭据,与 appKey 配对,由 WPS 签发

绑定包名必须与最终安装的应用 Bundle 名称完全一致—

(ToB)激活序列号:WPS 专业版产品序列号,格式如 XXXXX-XXXXX-XXXXX-XXXXX-XXXXXWPS 

3.2 环境要求

HarmonyOS 版本及 API Level:以 WPS 交付说明为准

设备已安装对应版本 WPS 客户端(专业版或个人版)

三方应用需将待打开文件拷贝至本应用可访问的沙箱路径,再传给 SDK

3.3 依赖集成

在工程 oh-package.json5 中添加:

将 WPS 提供的 wps_sdk.har 放入 ./libs/ 目录,执行 ohpm install 完成依赖安装。

4. 快速接入

4.1 导入


4.2 注册应用(必须,ToB / ToC 均需要)


4.3 打开文档

5 结构介绍

亮点 1:双版本统一,一套接口通吃

专业版(ToB)与个人版(ToC)共用同一套 API 设计

统一的 registerApp → sendRequest 接入范式

统一的 OpenFileRequest 参数模型,学习一次,两处可用

配套完整厂商对接文档,差异点标注清晰,无需反复踩坑

亮点 2:个人版支持上线,二开场景显著扩容

新增 ToC 打开文档能力,突破以往仅支持专业版 WPS 的限制

个人版场景:应用注册成功后即可打开文档,流程更轻量

让面向大众用户、个人办公、轻量协作类应用也能合规接入 WPS 文档能力

亮点 3:专业版能力延续,安全可控不妥协

专业版场景下,文档不落地、水印、修订、功能开关等能力完整保留

支持关闭回传(URI / FD),编辑结果可回传至三方应用

满足政企、涉密、合规场景对文档安全与可控性的要求

亮点 4:接入简单,开箱即用

HAR 包集成,三步完成基础对接:注册 → 打开 → 处理回调

提供 Demo 参考与完整参数说明

专业版激活序列号推荐在注册回调中一次配置,全局生效,省心省力

6 应用场景

专业版(ToB)适合:

政务 OA、央企办公、金融合规系统

WeLink 等政企协作平台内嵌文档

文档不落地、水印、功能管控有明确要求的场景

个人版(ToC)适合:

面向个人用户的阅读、编辑、轻协作应用

无需专业版 WPS 安装环境的广泛覆盖场景

快速验证、轻量集成、大众市场类 App

统一版的价值:

同一家 ISV 若同时服务政企客户与个人用户,无需维护两套 SDK 集成方案,按客户场景申请对应版本 HAR 即可。

7 能力一览

Logo

作为“人工智能6S店”的官方数字引擎,为AI开发者与企业提供一个覆盖软硬件全栈、一站式门户。

更多推荐