目录
WPS WebOffice API 的开通不是在桌面版 WPS 中点一个开关,而是面向网站、业务系统和应用开发者的接入流程。通常需要先准备 WPS 企业账号,在开发者后台创建应用,开启在线预览编辑或文档格式转换能力,再完成服务端回调与前端 SDK 联调;若要让真实用户在生产环境使用,还需要按平台要求申请正式发布。
先看结论:你该申请哪一种能力?
| 你的情况 | 建议选择 |
|---|---|
| 想在自有网站或系统里打开、预览、编辑 Word、表格、演示或 PDF | 申请“在线预览编辑”能力 |
| 需要把办公文档批量转成 PDF、图片、TXT,或使用 OCR 识别 | 申请“文档格式转换”能力 |
| 只是个人在电脑或手机上编辑文件,不开发网站或系统 | 通常无需申请 WebOffice API,直接使用 WPS Office 即可 |
| 教育机构或企业要把在线文档能力嵌入教务、门户、OA、CRM 等系统 | 先由组织准备企业账号与可部署的技术环境,再创建应用试用 |
WebOffice 是在线文档服务;JSSDK 则是把文档界面嵌入网页并进行前端交互的开发工具。申请开通时,先确定业务究竟需要在线编辑预览,还是格式转换与识别,后续的配置和接口工作会不同。想先了解能力边界与集成场景,可阅读全面了解 WPS Office API:功能、应用及集成指南。
申请前需要准备什么?
- WPS 企业账号:官方快速上手文档将企业账号作为使用 WebOffice 服务的前提;没有企业时,需要先创建企业。
- 明确的应用类型:创建应用时需在企业自建应用或集成应用中选择适合自身业务的一类,并填写应用信息。
- 可用于联调的服务端:在线预览编辑需要由接入方提供回调服务,用于向 WebOffice 提供文件与用户等必要信息。
- 公网可访问的回调地址:进行在线编辑预览接入时,回调网关应能被 WebOffice 服务端访问;仅本机可用的地址通常无法满足这一要求。
- 上线材料与预算安排:试用联调和正式发布是不同阶段。申请发布前,平台文档说明需要满足充值或购买应用套餐等条件,并提交测试应用截图供审核。
WPS WebOffice API 申请开通步骤
1. 登录企业账号并进入开发者后台
先使用组织的 WPS 企业账号登录开放平台,再进入开发者后台。若团队尚未建立企业组织,应先完成企业创建,再由具备管理权限的成员继续操作。个人免费账号能否直接满足企业认证、额度或发布要求,应以后台当前提示为准。
2. 创建企业自建应用或集成应用
在开发者后台创建应用,并按业务实际情况填写应用名称、用途及其他必填资料。创建完成后,在应用信息中获取并妥善保存 AppID 与 AppSecret。这两项信息用于后续服务端与前端接入配置,不应直接暴露在公开网页或前端代码仓库中。
3. 在“应用能力”中开启所需服务
进入应用详情页的“应用能力”,按需求开启“在线预览编辑”或“文档格式转换”。官方文档说明,能力开启后可进入试用阶段,适合功能开发、接口调试与验收。试用额度、可用范围和限制会受企业认证状态等因素影响,应以控制台展示为准。
4. 完成在线编辑预览的回调服务配置
如果申请的是在线预览编辑,不要只完成前端嵌入。你还需要在服务端实现回调接口,并把部署到公网的回调网关配置到应用中。WebOffice 会通过回调获取文件元信息、用户信息等内容;回调接口未调通或开关配置不正确,可能造成文档无法加载或页面报错。
官方文档给出的配置位置为:应用详情页中的“应用能力”→“在线预览编辑”→“能力配置”→“回调配置”。不同账号、能力状态或后台版本的界面文字可能略有变化,请以当前控制台显示为准。
5. 集成 JSSDK,并在测试环境完成联调
回调服务具备基础可用条件后,再按照官方前端 SDK 文档下载、引用并初始化 JSSDK,将 WebOffice 文档渲染到你的业务网页内。随后根据实际需求调用文档相关 API,例如界面配置、事件监听或内容与格式操作。
示例场景(假设):一家培训机构要在课程平台中让讲师批改学员提交的 DOCX 作业。团队可创建一个集成应用,先开启在线预览编辑能力;服务端根据作业编号返回文件和讲师身份信息;前端再用 JSSDK 把文档嵌入批改页面。联调确认权限、保存和回调逻辑符合业务规则后,再准备申请正式发布。
6. 申请企业认证与正式发布
如果需要更多试用额度,或准备将能力部署到生产环境,应按后台要求完成企业认证。正式发布前,官方流程还提到企业充值或购买应用套餐,以及提交测试应用使用 WebOffice 的系统截图供平台审核。审核通过后,应用才适合面向真实用户提供相应服务。
试用、正式发布与直接使用客户端的区别
| 阶段或方式 | 主要用途 | 是否适合面向真实用户上线 |
|---|---|---|
| WPS Office 客户端或网页版常规使用 | 个人或团队直接编辑、查看、协作文件 | 不涉及把文档能力嵌入自有系统 |
| WebOffice API 试用状态 | 开发、接口调试、测试联调与验收 | 应按平台规则用于测试阶段 |
| WebOffice API 正式发布状态 | 将通过验收的应用部署到生产环境 | 适合在审核通过并满足相关条件后上线 |
申请后如何判断是否真的开通成功?
- 应用详情页能够看到已创建的应用,以及对应的 AppID 和 AppSecret。
- “应用能力”中已开启与你需求匹配的服务,并显示可用于试用或后续配置的状态。
- 在线预览编辑场景下,回调网关已保存,服务端接口可被 WebOffice 访问并正常返回业务所需信息。
- 前端页面能通过 JSSDK 初始化文档,且文件加载、权限控制和保存等关键业务链路符合预期。
- 需要上线时,后台能够进入正式发布申请流程,并按要求提交材料。
常见问题排查
为什么创建应用后仍不能直接编辑文档?
创建应用只完成了身份与应用信息的建立。在线预览编辑还需要开启对应能力、实现并配置服务端回调、集成 JSSDK,随后进行联调。若只拿到 AppID 而没有后续配置,通常无法形成完整的在线文档链路。
回调地址为什么不能填写 localhost 或内网地址?
WebOffice 的回调调用发生在服务端之间。官方说明要求接入方保证回调服务能被 WebOffice 服务器访问,因此回调网关需要部署到公网可访问的域名或公网 IP 环境。具体网络策略、证书和安全限制请由技术团队结合当前文档配置。
个人开发者或学校教师能申请吗?
若你的目标是把在线文档能力接入一个组织运营的网站、教学平台或业务系统,应先确认是否能够使用组织企业账号创建应用,并完成后续认证与发布要求。若只是自己编辑课件、作业或日常文件,则通常不需要申请 WebOffice API。
在线预览编辑和文档格式转换能同时申请吗?
可以根据实际业务分别开启所需应用能力,但应分别评估接入工作。在线预览编辑重点在回调服务、网页嵌入与文档交互;格式转换与 OCR 则应按对应能力的接入文档设计调用流程。
验证情况与使用说明
本文依据相关品牌的官方帮助资料整理。具体功能入口、规则名称和可选样式可能随系统、地区、账号与版本变化,请以当前客户端或官方页面显示为准。本页为第三方使用教程,并非相关品牌的官方帮助页面。
