Skip to content
开发文档
能力中心
应用市场
WebOffice
开发者后台

开发自建应用

自建应用使用或对接 WPS 套件能力,需要在开发者后台进行相应的功能配置操作。

申请接口权限

应用开通所需权限后,才能调用 WPS 接口获取相关信息。详见调用流程

进入【权限管理】模块,查找所属权限添加申请。请注意:权限的开通,需要提交版本申请,并经过企业授权审核后才能生效。当企业管理员审核版本通过时,即视为申请开通授权成功,应用可调用获取自建应用的租户 access_token获取包含新授权权限的授权凭证。

温馨提示:应用开发者应当自觉遵循最小可用原则,仅申请实现应用功能所需的权限,否则应用可能无法通过审核。

申请接口权限

申请数据权限

应用访问部分资源数据时,需收到数据范围的控制。当前支持开发者对通讯录数据的范围进行申请:

  • 与可用范围一致:应用可获取的通讯录数据范围与可使用应用的范围保持一致。应用的可用范围变动时,通讯录的数据范围将跟随变动
  • 指定成员:应用可指定部门或成员

申请数据权限

应用可通过获取通讯录权限范围接口获取应用的通讯录权限范围,同时也可通过通讯录权限范围变更订阅通讯录权限范围的变更。

申请事件订阅

应用可通过订阅 WPS 开放平台提供的订阅事件,可以及时响应 WPS 中的变更事件。当事件发生时,开放平台会按照你配置的订阅方式发送事件消息。事件订阅说明

例如,你的应用需要及时处理离职员工的数据,那么就可以订阅用户变更事件。WPS 会在企业成员离职时触发事件消息推送至应用指定的消息接收地址,应用接收并解析消息后即可获取对应的消息内容,处理后续业务逻辑。

事件订阅步骤:

  1. 配置用于接收 WPS 事件消息推送的地址(URL)。
  2. 选择需要订阅的事件。
  3. 权限管理模块申请事件所需权限,并创建版本申请上架(部分事件无需申请权限,可跳过此步骤)。

申请事件订阅

配置安全设置

安全设置分为 5 个配置项:

  • 授权回调地址:用于用户授权时,WPS 做授权回调。即应用在构造用户授权链接时需使用此处配置的地址,使用其他地址开放平台将拒绝授权请求。
  • IP 白名单:仅白名单中的来源请求可以正常调用开放平台 API,不在白名单中的来源请求会被拒绝。该项被必须配置项,否则无法正常调用服务端 API。若不开启该功能,则开放平台不会校验请求来源 IP。
  • 接口签名:用于调用接口时做签名。若不开启该功能,则请求开放平台接口时无需签名。
  • H5可信域名:依据金山办公 WPS协作客户端安全规范,应用若需调用WPS协作提供的JSAPI,则需指定访问发起的域名。仅可信域名内发起的调用能被允许。
  • 用户使用条款:若应用有需要向用户说明的数据保护政策,则可在此配置条款。配置后会在 用户授权应用 时也会展示,用户需阅读并勾选同意才可进入下一步。该步骤非必须。

安全设置

配置应用能力

WPS 开放平台也提供了多种 WPS 套件业务的开放能力,您可按使用场景在开发者后台-应用能力模块选择使用。