开发应用
应用使用或对接 WPS 套件能力,需要在开发者后台进行相应的功能配置操作。
申请接口权限
应用开通所需权限后,才能调用 WPS 接口获取相关信息。详见调用流程
进入【权限管理】模块,查找所属权限添加申请。请注意:权限的开通,需要提交版本申请,并经过开放平台审核后才能生效。当企业安装/更新应用时,企业管理员可见对应版本的应用申请的权限,企业需同意授权应用的使用该权限,应用才可使用该权限调用接口或接收事件获取该企业的数据。该过程即为第三方企业应用授权
温馨提示:应用开发者应当自觉遵循最小可用原则,仅申请实现应用功能所需的权限,否则应用可能无法通过审核。
申请事件订阅
应用可通过订阅 WPS 开放平台提供的订阅事件,可以及时响应 WPS 中的变更事件。当事件发生时,开放平台会按照你配置的订阅方式发送事件消息。事件订阅说明
例如,你的应用需要及时处理离职员工的数据,那么就可以订阅用户变更事件。WPS 会在企业成员离职时触发事件消息推送至应用指定的消息接收地址,应用接收并解析消息后即可获取对应的消息内容,处理后续业务逻辑。
事件订阅步骤:
- 配置用于接收 WPS 事件消息推送的地址(URL)。
- 选择需要订阅的事件。
- 在
权限管理
模块申请事件所需权限,并创建版本申请上架(部分事件无需申请权限,可跳过此步骤)。
配置安全设置
安全设置分为 4 个配置项:
- 授权回调地址:用于用户授权时,WPS 做授权回调。即应用在构造用户授权链接时需使用此处配置的地址,使用其他地址开放平台将拒绝授权请求。
- IP 白名单:仅白名单中的来源请求可以正常调用开放平台 API,不在白名单中的来源请求会被拒绝。该项被必须配置项,否则无法正常调用服务端 API。若不开启该功能,则开放平台不会校验请求来源 IP。
- 接口签名:用于调用接口时做签名。若不开启该功能,则请求开放平台接口时无需签名。
- WPS Office 客户端域名灰名单:依据金山办公 WPS 客户端安全规范,应用若需在 WPS Office 端内打开,则需将使用的域名要求加入到安全名单中,不在白名单的域名默认跳转到端外打开。请填写所有需要在端内浏览器加载的主资源页面(包含首个打开的页面;包含跳转的页面;包含触发 302 跳转的链接;包含主 frame、iframe)域名,需详细到各级子域名(如:
https://wps.cn
、https://co.wps.cn
)。 - 用户使用条款:ISV 应用上架到应用市场后,企业安装和使用应用时,需了解三方服务的隐私政策和服务协议。开发者需在此处配置对应协议的在线地址。如内容发生变更,请及时联系WPS侧对接人员。
为了保障您的请求安全,建议开启 IP 白名单和签名校验,否则可能存在伪造请求的情况。
配置应用能力
WPS 开放平台也提供了多种 WPS 套件业务的开放能力,您可按使用场景在开发者后台-应用能力
模块选择使用。