Skip to content

自建应用集成指南

什么是企业自建应用

企业自建应用为单租户应用。顾名思义,应用的开发者、管理员和使用者都归属在一个租户内,对外部不可见。

自建应用可通过应用可见性对其他租户分享可见

企业自建应用适用于企业将自研或外采的系统,通过标准对接的方式,接入WPS 365提供的数据和功能能力,并将应用上架。用户可通过路由或者协作工作台入口访问应用

应用开发上架

开发流程

企业自建应用的开发流程如下图所示,本文将按照该流程依次介绍相关操作

1_Development_process

一、创建企业自建应用

企业自建应用面向企业内所有成员可创建使用,开发者可根据自身需求创建应用并对接WPS 365开放能力,满足办公场景中的个性化需求。

​ 企业成员通过访问地址(域名+/developer/console/home)访问开发者后台,或通过开发文档站的快捷入口访问开发者后台。

​ 如果你是平台管理员,管理员账号(默认wpsadmin账号)登录(域名+/c/manage/#/)访问应用管理平台后,通过【集成管理】菜单跳转到开发者后台。

1、 在开发者后台,点击创建应用

2_New_application.2、填写应用基础信息,包括应用名称、应用描述、应用图标

3_Createapplications

二、配置应用信息

应用创建完成后,可在应用详情页中配置应用信息。包括基础信息、应用能力、应用权限、数据权限、事件等。

1、开启应用能力

WPS 365支持的应用能力有:

  • 协作与会话:机器人、工作台小组件、网页应用
  • web能力:web组件
  • 多维表格:仪表盘插件、字段插件、数据连接器插件、自动化插件、视图插件、记录卡片插件
  • 文档中台:文档中台能力使用统计

根据应用场景开启对应应用能力,具体应用能力使用,可见应用能力的描述。

注意:开启应用能力后,需完成能力的必填项配置,并且需要新增应用版本,待新版本的应用审核发布后,已开启的能力才能在线上生效。

4_Application_ability

2、开通应用权限

为 OpenAPI 接口调用、部分事件订阅和 SDK 的接口调用配置所需要的权限。如下图所示,调用各 API 前需开通的权限列表可参考具体的 API 文档说明,可查看全量的Scope列表API列表。

5_Ability_authority

3、配置通讯录数据权限(可选)

应用的数据权限是指以应用身份访问业务资源时可获取的数据范围。当应用申请了部分 API 的权限(例如,通讯录)后,还需要配置相应的数据权限并提交审核。待审核通过后权限生效,才可以成功调用 API 获取数据,否则调用 API 时会返回权限错误。

配置范围可选择“与可用范围一致”或者“指定成员”。

6_Data_permission

4、多语言配置(可选)

在基础信息中配置应用名称和描述需展示的多语言。

5、成员管理(可选)

邀请成员协作开发和管理应用,成员角色:所有者、管理员和开发人员。

Member_Managemen

6、事件订阅(可选)

事件订阅功能可以满足应用及时响应WPS 365 事件变更的需求。在使用事件订阅功能时,需要先配置请求地址,并添加订阅事件。

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

事件订阅步骤:

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

若未填写回调地址或申请对应权限,事件无法订阅。

EventSubscription

7、配置安全设置(可选)

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

  • 用户授权回调配置:用于用户授权时,WPS 做授权回调。即应用在构造用户授权链接时需使用此处配置的地址,使用其他地址开放平台将拒绝授权请求。
  • 应用证书回调配置:配置应用证书回调后,应用证书的权益信息变化后,将推送给回调地址
  • IP 白名单:仅白名单中的来源请求可以正常调用开放平台 API,不在白名单中的来源请求会被拒绝。该项被必须配置项,否则无法正常调用服务端 API。若不开启该功能,则开放平台不会校验请求来源 IP。
  • 接口签名:用于调用接口时做签名。处于安全考虑,开放平台这里会默认开启接口签名。若不开启该功能,则请求开放平台接口时无需签名。
  • H5可信域名:依据金山办公 WPS协作客户端安全规范,应用若需调用WPS协作提供的JSAPI,则需指定访问发起的域名。仅可信域名内发起的调用能被允许。

SafetySettings

三、开发自建应用

自建应用使用或对接 WPS 应用能力,需要在应用能力模块进行相应的功能配置操作。

四、申请应用上架

企业自建应用发布到独立访问路由或WPS协作工作台,或要获取企业的接口数据授权,需要经过上架审核。租户管理员审核通过后,应用即可正常使用。

企业自建应用的信息配置和修改,需要经过版本发布,并由企业审核才可生效。

1、敏感项说明

WPS 开放平台支持配置的应用能力,根据内容的使用属性和影响范围,定义为 3 种敏感类型,不同敏感类型的定义及使用区分如下:

  • 版本敏感项:敏感度最高。每次修改,都需要创建版本并上架才可生效。生效后,仅在对应版本生效,历史版本无响应。
  • 全局敏感项:敏感度中等。每次修改,都需要创建版本并上架才可生效。生效后,对所有生效版本响应。
  • 非敏感项:敏感度最低。每次修改保存后,即时生效
能力项版本敏感项全局敏感项非敏感项
用基础信息(logo、名称、介绍、主页)
应用能力-能力版本或敏感配置更新
成员管理
安全设置
权限申请-接口权限
权限申请-数据权限
事件订阅(含订阅地址和订阅事件)
版本管理-可用范围

2、版本管理与发布

WPS 开放平台企业自建应用的上架,需要以“版本”为单位进行创建和申请,版本会读取最新修改的全局敏感项、版本敏感项作为该版本的上架内容。版本提交发布后由企业管理员进行审核。开发者可在开发者后台-应用发布-版本管理模块创建和管理版本。

Version_management

版本分为“待申请”、“审核中”、“审核不通过”、“已发布”4 个状态。 一个应用当前仅可有一个版本在“待申请”、“审核中”、“审核不通过”状态中。

查看版本详情,当版本处于“审核中”,版本的敏感信息不可修改,若要修改敏感数据,可撤销申请后继续编辑。

VersionDetails

可用范围修改:可用范围当前仅支持在版本中修改。

AvailableRange

应用审核

租户管理员可在 企业管理后台-企业应用-应用审核处进行审核。

当前版本不支持通过WPS协作进行审核,后续提供该功能

企业自建应用的版本需由企业管理员审核才可生效。企业管理员需具备以下两个管理后台的权限之一,才可收到审核:

  • 应用审核
  • 应用管理

Enterprise_application

当开发者在开发者后台-版本管理申请版本发布后,管理后台-企业应用-应用审核-待处理 模块会收到申请发布的数据。具备该菜单的管理员可对数据进行审核。同时可查看申请版本的修改详情。

UnprocessedDetails

管理员可通过或者拒绝版本,拒绝需提交拒绝理由,以便开发者改进。

应用审核后,审核数据可在管理后台-企业应用-应用审核-已处理 模块查看。

1ProcessedDetails

应用审核后,在应用可用范围内的成员可通过应用链接访问;若配置了网页应用 ,可用范围内的成员可在WPS协作工作台查看该应用。

xzWorkbench

应用管理

应用发布后,可在管理后台-企业应用-应用管理模块进行管理。

应用管理分为应用开发者对应用进行管控和企业管理员对应用进行管控。

  • 应用开发者:

应用所有者、管理员都可对应用进行管控。所有者可转让应用,所有者和管理员均可删除开启禁用应用。

删除应用属于高危操作,删除后不可恢复,需谨慎!!

TransferApplication

  • 企业管理员:

企业管理员可对已发布的应用管控,可管控应用(开启和禁用)、修改通讯录数据权限范围和回收应用权限。

后续会增加更多管理员的操作权限,如修改应用的可用范围等。

ApplicationManagementDetails

若管理员已禁用应用,即【管理员已禁用】,则应用开发者在开发者后台是无法开启应用的,管理员操作权限高于开发者的权限。

ApplicationManagementDetails-disable

ApplicationManagementDetails-disable1