0文章
0评论
0获赞

supOS 2.7 集成指南

名词解析 #

APP:以下APP均指ISV自行开发或改造后集成到supOS中的应用。

版本要求 #

supOS版本:V2.7

开发、测试、发布流程 #

supOS基于容器化技术,并不限定使用何种开发语言来编写APP,但APP需要遵循supOS的《APP安装包标准规范》。

开发者可以使用自己所喜欢的IDE来编写纯代码,然后按照《APP安装包标准规范》来编写APP相关声明文件,也可以利用supOS所提供的Maven插件(针对JAVA Maven项目)或CLI来自动生成APP声明文件,编辑修改后再利用CLI制作APP安装包。

开发者可以自行搭建一个jenkins用来做CICD。可以在jenkins的流水线中执行CLI来制作APP安装包,调用CLI部署APP到指定的supOS以便测试。

测试通过后的APP可以按照《APPs上架及分发流程规范管理说明》发布到应用市场,以供其他用户使用。

Open API #

对在深度集成过程中,ISV如果需要用到supOS的一些接口能力,例如OAuth2授权登陆认证、用户同步、通知中心等。

supOS对外提供了基于RESTful风格的Open API 接口,点击查看【接口文档】

Open API 所提供的接口能力 #

(1)用户管理

(2)角色管理

(3)对象管理

(4)对象属性管理

(5)对象模板管理

(6)功能集合管理

(7)数据集合管理

(8)标签管理

(9)报警管理

(19)运行时

(11)工作流

(12)通知中心

(13)生产架构管理

(14)datatable管理

集成工具包SDK #

为了更好的帮助企业开发者进行系统集成,减轻开发者对接OpenAPI的难度,蓝卓提供了基于JAVA语言的集成工具包SDK(后续将陆续支持多种开发语言)。

具体使用方法请移步 【supOS SDK for Java 开发指南】

统一认证(单点登录) #

supOS作为一个平台,登录supOS后能够实现单点登录到各个集成进来的APP,实现APP统一登录和统一管理。

supOS提供SSO,支持只登录一次就可以访问各个APP。

各个APP需支持以下认证标准之一:OpenID ConnectOAuth2.0 SAML 2.0

OAuth2认证授权请移步:【supOS OAuth 2.0 授权说明】

改造示例代码请移步:【APP 对接 supOS OAuth2.0 案例】

用户权限集成 #

用户权限 #

1、登录方式通过OAuth2授权码模式接入supOS。

2、关闭原型系统的登录入口、修改密码入口,用户只允许在supOS界面上登录。

3、关闭原型系统的用户管理入口,允许保留查询用户的页面。

4、supOS用户管理的增、删、改操作会通过消息分发的方式发送给ISV,收到supOS的用户同步消息后,ISV需要进行增删改操作。

5、如果收到的supOS用户信息不满足ISV的数据要求,ISV需要做字段默认化处理,或者进入ISV系统后,通过引导页引导用户完善信息。

6、用户的数据权限,功能权限以ISV为准。

ISV原型系统新增用户时调用supOS接口的代码参考:

ISV需要调用OpenAPI相关接口:basePath:/openapi

角色、菜单权限 #

角色、菜单权限在supOS平台进行维护,首先创建角色,然后再对角色分配APP的菜单权限。角色设置完成后,可以在用户管理中,给用户设定相应的角色。

创建角色
为角色分配菜单
为用户分配角色
集成说明 #

1、如果ISV是单页应用(SPA)且菜单还是保留在原有页面中,那么保留APP原有的权限管理,初始化时需要将APP的用户同步到supOS,后期用户的维护在APP页面中来操作,同时同步到supOS。

2、如果是多页应用(MPA)且每页菜单是逐一配置到supOS的APP菜单中去的,那么菜单权限可以由supOS来控制。

普通用户同步到supOS后,需要由supOS的管理员账号来给普通用户分配权限(包括APP的菜单权限)。

由于ISV原有的账号密码体系与supOS的不一致,当前supOS版本只能新增用户,不能获取用户的密码,主要是需要将登录用户的账号同步过来,真实密码可以不同步过来,可以约定好一个初始密码(第一次登录supOS会要求改密码),OAuth2认证成功后获取当前登录supOS的用户,以获取用户名来再次认证ISV原型系统的授权。

提供接口支撑 #
新增人员 #

删除人员 #

新增用户 #

查询用户 #

查询用户接口-返回结果
修改用户 #

删除用户 #

完整接口代码示例下载 #

下载地址:【用户权限集成接口示例】

菜单集成 #

 对于需要通过统一菜单集成方式(对于第七章第2种集成方式)进行权限管控的APP,应遵循supOS平台提供的统一菜单管理原则,APP应提供对每个菜单可独立访问的Web地址,实现菜单级的权限管控,对于按钮及数据权限,由APP自行管理。另外需要APP集成的页面与supOS样式保持风格统一,隐藏原有用户登出入口。

APP原型页面剥掉头部栏和左侧菜单栏,只留页面内容部分来集成到supOS。

菜单集成操作内容
菜单集成后展示
菜单集成配置页面权限

ISV supOS接入 #

接入分为两种

(1)集成后的APP需要上架到蓝卓官方应用商店,后期通过APP store进行分发、销售。

(2)集成后的APP用于私有化部署,且无需上架到蓝卓APP store的。

APP上架应用商店 #

当ISV接入方式为上述第1种方式时(需上架APP store),需要进行APP的打包上架工作。

(1)APP镜像上传:ISV系统经过集成改造并完成测试之后,需要将程序的镜像上传至supOS的官方镜像库,并获取到镜像地址。如图所示:

(2)APP打包:开发者可以访问蓝卓云资源中心 【APP打包规范】,查看APP安装包规范进行自助打包。也可以通过蓝卓提供的Maven插件(针对JAVA Maven项目)来进行打包工作,详细说明参见 【APP打包插件说明】

(3)APP上架:完成APP打包之后可以将APP上架至蓝卓应用商店,上架APP需要遵循 【应用接入规范】 进行自助上架。

案例参考 #

【App 对接 supOS OAuth 2.0 开发指南】

评论 (0)
请登录以参与评论。
立即登录