文档整理以及分支保护测试
This commit is contained in:
parent
c50a5d2d37
commit
115638f3b8
|
|
@ -0,0 +1,234 @@
|
|||
|
||||
|
||||
吉大正元统一身份管理系统
|
||||
应用接入规范
|
||||
|
||||
V1.0
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
吉 大 正 元 信 息 技 术 股 份 有 限 公 司
|
||||
Jilin University Information
|
||||
Technologies Co., Ltd.
|
||||
|
||||
目 次
|
||||
统一身份管理系统应用接入规范 2
|
||||
1 系统特点 2
|
||||
1.1 意义 2
|
||||
1.2 说明 2
|
||||
2 名词解释 2
|
||||
3 属性说明 2
|
||||
3.1 基本属性 3
|
||||
3.2 其他属性 3
|
||||
4 应用接入框架 3
|
||||
5 应用接入类别 3
|
||||
6 接入方式描述 4
|
||||
6.1 WebService接入方式 4
|
||||
6.1.1 接入说明 4
|
||||
6.1.2 接入条件 4
|
||||
6.1.3 接入过程 4
|
||||
6.2 Restful接入方式 6
|
||||
6.2.1 接入说明 6
|
||||
6.2.2 接入条件 7
|
||||
6.2.3 接入过程 7
|
||||
|
||||
|
||||
|
||||
统一身份管理系统应用接入规范
|
||||
|
||||
|
||||
1. 系统特点
|
||||
|
||||
1. 意义
|
||||
统一身份管理系统（以下简称IMS）为4A项目建设过程中的核心身份管理服务，此文
|
||||
档描述IMS产品机构、用户维护接口的集成规范，IMS产品支持将机构、用户信息推送给
|
||||
第三方应用服务端；本文档将指导第三方应用开发Restful、WebService服务接口。
|
||||
|
||||
2. 说明
|
||||
统一身份管理系统提供https接口，使用安全加密通道，保证数据传输的安全性。
|
||||
|
||||
例：https://身份服务地址/接口uri
|
||||
|
||||
|
||||
2. 名词解释
|
||||
|
||||
|序号 |名词 |说明 |
|
||||
|1 |IMS |统一身份管理系统Identity Management System，以下简称IMS|
|
||||
|2 |Restful |RESTFUL是一种网络应用程序的设计风格和开发方式，基于HTTP|
|
||||
| | |，可以使用XML格式定义或JSON格式定义。RESTFUL适用于移动 |
|
||||
| | |互联网厂商作为业务使能接口的场景，实现第三方OTT调用移动|
|
||||
| | |网络资源的功能，动作类型为新增、变更、删除所调用资源。 |
|
||||
|3 |Web Service|Web |
|
||||
| | |Service是一个平台独立的，低耦合的，自包含的、基于可编程|
|
||||
| | |的web的应用程序，可使用开放的XML（标准通用标记语言下的 |
|
||||
| | |一个子集）标准来描述、发布、发现、协调和配置这些应用程 |
|
||||
| | |序，用于开发分布式的交互操作的应用程序。 |
|
||||
|4 |MDM |主数据 |
|
||||
| | | |
|
||||
| | | |
|
||||
|
||||
|
||||
|
||||
|
||||
3. 属性说明
|
||||
|
||||
1. 基本属性
|
||||
基本属性由MDM统一维护，确保数据一致性。
|
||||
1. 机构基本属性
|
||||
机构id(orgId)、机构编码(orgCode)、机构名称(orgName)、上级机构id(orgPid)、
|
||||
状态(status)
|
||||
2. 用户基本属性
|
||||
所属机构(orgId)、用户id(userId)，用户编号(userCode)、姓名(name)、状态(sta
|
||||
tus)、手机号(mobilePhone)、邮箱(email)、职级(rank)、岗位(post)、性别(sex)
|
||||
、密码(password)
|
||||
|
||||
|
||||
注：用户编号标准格式：标准用户
|
||||
8位数字编号，临时用户W035+5位数字，即W035*****
|
||||
3. 人像
|
||||
MDM提供接口，应用系统可根据员工号查询头像信息，具体接口可向MDM索要
|
||||
|
||||
|
||||
2. 其他属性
|
||||
1. 统一身份平台未提供的属性，若应用需要，则可从MDM查询接口获取
|
||||
2. 由业务系统自行维护，使用范畴仅限于本系统
|
||||
|
||||
4. 应用接入框架
|
||||
|
||||
[pic]
|
||||
|
||||
5. 应用接入类别
|
||||
|
||||
IMS管理系统提供以下应用接入方式，
|
||||
webservice接口、restful接口，可根据应用自身架构采用适合本应用的接入方式
|
||||
|
||||
|
||||
6. 接入方式描述
|
||||
|
||||
IMS_7.X版本以上支持该功能。
|
||||
|
||||
|
||||
1. WebService接入方式
|
||||
|
||||
|
||||
1. 接入说明
|
||||
IMS系统作为webservice通讯的客户端，向应用服务器发送指定格式的报文内容，传
|
||||
递机构、用户信息和账号信息。
|
||||
|
||||
|
||||
2. 接入条件
|
||||
1.
|
||||
应用系统有标准的webservice服务接口，IMS通过webservice协议向应用系统推送数据
|
||||
|
||||
|
||||
2.
|
||||
应用系统没有标准的webservice接口，但应用系统自定义的webservice接口，IMS系统
|
||||
需对应用接口适配改造
|
||||
3. 应用系统没有webservice接口，IMS提供接入示例供应用厂商改造
|
||||
4. 新增、修改用户使用同一个接口
|
||||
5.
|
||||
推送的数据需要应用根据唯一标识（机构编码、人员编码）自行判断新增或修改，若唯
|
||||
一标识不存在则做新增操作，若存在则做修改操作
|
||||
|
||||
3. 接入过程
|
||||
|
||||
|
||||
人员信息接口以 Web Service方式的接口作为接口规范。由IMS服务提供方提供Web
|
||||
Service接口规范，第三方应用系统遵循该规范实现Web
|
||||
Service接口，实现人员帐号信息同步。
|
||||
1) 触发动作
|
||||
当IMS平台新增人员账号信息时，通过Web
|
||||
Service方式发将发生变化的人员账号信息同步给第三方应用，应用厂商的服务根
|
||||
据员工编号自行判断人员的新增和修改。
|
||||
2) 推荐技术
|
||||
Apache CXF
|
||||
3) 报文类型
|
||||
WebService
|
||||
4) 方法名
|
||||
addOrUpdateUser（新增/修改）、removeUser（删除）、addOrUpdateOrg（新增
|
||||
/修改）、removeOrg（删除）
|
||||
5) 接口返回参数
|
||||
String(XML格式)
|
||||
6) 用户状态项与账号状态项
|
||||
当用户状态与账号状态都在使用中时，该账号才生效
|
||||
7) 注意事项
|
||||
a)
|
||||
第三方应用在与IMS系统接口联调前，需要使用SOAPUI工具对服务端进行测试，
|
||||
测试通过后提供IMS系统webservice服务地址和XML测试报文
|
||||
b)
|
||||
应用返回的报文中需要指明哪一个字符串是代表数据接收成功/失败，便于IMS
|
||||
判断本次同步结果
|
||||
c) 此报文适用于所有应用系统
|
||||
8) 调用示例
|
||||
URL地址说明：http://服务地址/service/功能模块/功能定义
|
||||
用户示例：http://localhost:8003/service/ims/userWebService
|
||||
[pic]
|
||||
|
||||
URL地址说明：http://服务地址/service/功能模块/功能定义
|
||||
用户示例：http://localhost:8003/service/ims/orgWebService
|
||||
[pic]
|
||||
|
||||
2. Restful接入方式
|
||||
1. 接入说明
|
||||
IMS将机构、用户基本属性信息及账号的对应关系以键值对（JSON）的方式推送至应
|
||||
用开发的restful接口，应用根据接收到的数据进行后续的定制化开发。
|
||||
|
||||
2. 接入条件
|
||||
1.
|
||||
应用系统需具备访问restful接口的能力，IMS将机构、用户数据通过调用restful接口
|
||||
的方式推送至应用。
|
||||
2. 新增、修改、删除用户使用一个接口；新增、修改、删除机构使用一个接口。
|
||||
3.
|
||||
推送的数据根据type字段确定用户或机构的新增、修改或删除；其中type为test表示测
|
||||
试连接（仅传递type），type为add表示新增或修改，type为delete为删除。
|
||||
4.
|
||||
推送的数据需要应用根据唯一标识（机构编码、人员编码）自行判断新增或修改，若唯
|
||||
一标识不存在则做新增操作，若存在则做修改操作
|
||||
5. 接口返回值的数据编码格式为 application/json
|
||||
|
||||
6. 当传递type为test时，需要应用方返回{"code": "0","message": "success"}
|
||||
|
||||
3. 接入过程
|
||||
1. 人员或机构信息通过json的方式进行传递，调用restful接口实现数据传输
|
||||
|
||||
|
||||
人员示例：
|
||||
URL地址说明：POST http(s)://服务地址/版本/功能模块/功能定义
|
||||
POST http://appserver/v1/user/userSynchronous
|
||||
|{ |
|
||||
| "type": "add", |
|
||||
| "userId": "0001", |
|
||||
| "orgId": "root", |
|
||||
|"username": "张三", |
|
||||
|…… |
|
||||
|} |
|
||||
|
||||
|
||||
[pic]
|
||||
|
||||
|
||||
机构示例：
|
||||
URL地址说明：POST http(s)://服务地址/版本/功能模块/功能定义
|
||||
POST http://appserver/v1/org/orgSynchronous
|
||||
|{ |
|
||||
| "type": "add", |
|
||||
| "orgId": "0001", |
|
||||
|"orgName": "测试机构", |
|
||||
|…… |
|
||||
|} |
|
||||
|
||||
|
||||
[pic]
|
||||
|
||||
|
||||
2. 接口返回参数推荐使用如下格式
|
||||
| { |
|
||||
|"code": "0", |
|
||||
| "message": "success" |
|
||||
|} |
|
||||
|
||||
|
||||
Binary file not shown.
Loading…
Reference in New Issue