公共管理门户系统用户信息同步接口集成规范

日期:2016-09-19 16:01:59  点击数:

江西省教育厅公共管理门户系统

用户同步接口集成规范

东软集团股份有限公司

总页数

正文

附录

生效日期

2015-11-10

编制

批准

变更履历

版本

时间

内容描述

1         文档说明

1.1     功能描述

本文档主要描述了江西省教育厅公共管理门户系统对外提供的用户信息同步接口规范。

1.2     业务术语

术语

描述

第三方系统

集成到教育厅管理门户实现单点登录的系统

TokenId

第三方系统从管理门户系统获取用户信息的票据

单点登录

用户只需要登录一次就可以访问所有相互信任的应用系统

用户唯一标识

第三方系统和门户系统标识用户唯一性编码

1.3     应用场景

第三方系统集成到江西省教育厅公共管理门户系统后,为了能判定单点登录的用户是否合法,用户信息需要和公共管理门户系统保持一致,应用场景流程如下:

第三方系统通过tokenId拿到用户信息之后,可以通过判断用户的唯一标识是否在本系统有效,若有效则用户单点登录成功,进入系统。

2         业务描述

用户信息同步是第三方系统和公共管理门户系统之间进行用户信息共享,实现单点登录的基础。系统单点登录集成后,第三方系统需要完成如下工作才能实现单点登录认证:

1、第一次全量用户信息同步,通过excle文件格式导入(导入门户系统用户数据)、导出 (导出用户信息给门户系统)

2、开发用户信息实时同步接口并联调通过,门户系统用户信息能实时同步到系统。

3、单点登录认证测试成功。

门户系统中的用户信息同步包括三种形式:

2.1     文件数据同步

适用于接入门户系统第一次批量用户数据同步,包括如下两种类型:

1、教育厅公共管理门户系统把信息中心已授权的用户信息导出生成exlce文档给第三方系统,第三方系统进行入库处理。

2、第三方系统把已集成系统的全量用户信息以excle文件格式导出提供给门户系统进行入库。

第三方系统导出文件格式如下

 门户系统在导入第三方系统用户信息时,需要增加一列第三方系统名称,确保导入的用户信息和第三方系统对应上。

门户系统导出文件格式如下

 第三方系统可以根据门户系统提供的字段进行有选择的入库,但是用户唯一标识字段一定要入库。

 门户系统导出用户后系统会进行更新,增加第三方系统的权限标识

2.2     实时同步接口

门户系统中用户信息进行新增、修改、删除操作时,需要通过实时接口同步到第三方接入系统,包括如下两种方式:

1、系统管理员进行用户新增、修改、删除操作时,门户系统会触发用户信息实时同步接口,把用户信息同步到对应系统。

2、用户自己注册及修改信息时不触发同步,管理员审核通过之后,门户系统才会触发用户信息实时同步接口。

3         用户信息实时同步接口规范

3.1     接口说明

江西省教育厅门户系统添加用户成功后并实时同步到具备权限的第三方系统,实现门户系统与第三方系统之间用户数据的同步。

接口名称

JxEduUserSyncService

接口地址

http://IP:PORT/JxEduUserSyncService

接口协议

Webservice    RESTful

   

接口地址需要第三方接入系统开发完成用户信息实时同步接口后,按照如下格式提供:

接口地址:http://IP:PORT/JxEduUserSyncService

其中:IP:PORT为实际的IP+端口号, JxEduUserSyncService为统一的接口名称。

3.2     HTTP请求头配置

系统调用该接口请求URL:注意开发的web service接口支持POST调用。

HTTP Header:

POST JxEduUserSyncService HTTP/1.1

Host: 10.4.124.17:8080

Accept: */*

Content-Type: application/JSON

3.3     RESQUEST结构

参数:String JSON

返回值:JSON

序列号


 
 

属性

描述

类型长度

备注

1

userNo

用户唯一标识

VARCHAR(50)

非空,两个系统间用户关联的唯一标识。

2

nameEntity

用户姓名

VARCHAR(64)

非空

3

passwordEntity

登录系统密码

VARCHAR(64)

如果长度为0或者为null,说明该用户密码不需要修改,则不用修改

4

nameSpellingEntity

姓名全拼

VARCHAR(64)

姓名全拼

5

emailEntity

邮箱

VARCHAR(64)

用户邮箱

6

phoneEntity

手机

VARCHAR(32)

手机号

7

telNoEntity

固定电话

VARCHAR(32)

固定电话

8

institutional

组织机构

VARCHAR(100)

组织结构以半角逗号分割

9

institutionalId

组织接口编码

VARCHAR(16)

组织结构ID以半角逗号分割

10

Sexy

性别

VARCHAR(2)

男或女

11

operKind

操作类型

VARCHAR(1)

1:增;2:删除;3:修改,如果系统传值为3,存在用户则修改,不存在则新增

12

CreateTime

生成时间

DATE

格式:yyyy-mm-ddhh:mm:ss

13

ModifyTime

修改时间

DATE

格式:yyyy-mm-ddhh:mm:ss

14

ifStop

是否停用

VARCHAR(1)

0:未停用;1:已停用

15

loginEntity

登录名

VARCHAR(64)

登录系统账号

Requset参数格式:

{

"INSTITUTIONALID":"360000020000",

"SEXY":"male",

"MODIFYTIME":"2017-05-2211:38:41",

"CREATETIME":"2016-03-18 11:24:14",

"PASSWORDENTITY":"18170095445",

"OPERKIND":"3",

"LOGINENTITY":"***",

"NAMEENTITY":"***",

"TELNOENTITY":"079186765183",

"IFSTOP":"0",

"USERNO":"235298",

"NAMESPELLINGENTITY":"***",

"EMAILENTITY":"zhk1160@126.coom",

"INSTITUTIONAL":"教育考试院",

"PHONEENTITY":"18170095445"

}

注意点:拼串时,所有字段均为大写。

3.4     RESPONE结构

序列号


 
 

属性

描述

类型长度

备注

1

UserNo

用户唯一标识

VARCHAR(50)

非空,两个系统间用户关联的唯一标识。

2

nameEntity

用户名

VARCHAR(64)

用户中文姓名

3

STYPE

业务操作结果

VARCHAR(10)

S:代表成功;E:代表失败

4

SMESSAGE

业务返回结果说明

VARCHAR(512)

成功或者失败

Respone返回信息格式:

{

     ”USERNO”:”201980”,

      “NAMEENTITY”:”王军岭”,

      “STYPE” :”S”,

      “SMESSAGE”:”SUCCESS”

}