秦皇岛教育统一认证系统.DOC

1、秦皇岛市教育统一认证系统接口标准（试行）2015.5秦皇岛市教育局Catalog 目 录1 概述 .31.1 范围 .31.2 规范说明及实现 .31.2.1 规范说明 .31.2.2 统一认证登陆说明 .31.2.3 统一认证登出说明 .61.2.4 接口调用说明 .62 接口定义 .82.1 权限接口(WSDL地址： http:/$ContextPath/iface/privilegeService?wsdl).82.1.1 获取平台单位(单位同步 ).82.1.2 获取角色权限 .102.1.3 获取平台角色列表 .112.2 用户接口(WSDL地址： http:/$ContextPat

2、h/iface/userService?wsdl) .132.2.1 用户列表接口(用户同步 ).132.2.2 检查用户标识 .162.2.3 查询用户信息接口 .172.2.4 用户注册接口 .182.2.5 用户信息(密码)修改接口 .212.2.6 用户删除接口 .222.2.7 用户权限接口 .232.2.8 用户角色接口 .243 接入案例( 详细请参见附件代码) .253.1 J2EE接入案例 .253.1.1 登陆模块实现案例 .253.1.2 数据接口案例 .271 概述1.1 范围本文档主要作为第三方应用平台如何接入秦皇岛市教育统一认证系统帮助说明，包括平台接入技术说明、接

3、口详细介绍、各类语言开发的应用接入案例技术性指导说明。下面的接口标准只是一个参照，具体应用系统开发或对接时需联系秦皇岛市教育局电化教育馆（0335-3865072） 。1.2 规范说明及实现1.2.1 规范说明为兼容基于各种开发语言、数据库等开发的平台，本接口规范采取通用标准的 WEB协议格式，适用于任何基于 B/S 架构的 WEB 应用系统平台与本资源平台进行整合，实现用户数据同步以及资源等其他基础数据获取与交互，详见以下章节。本接口规范基于标准 HTTP、WebService 协议结合 XML 方式进行接口通讯，其中统一认证登陆体系采用基于 XML 标准的 SAML 安全断言标语言（全称:

4、Security Assertion Markup Language）进行系统间的数据交换认证。基础数据接口集成平台需以 WebService方式附带 systemCode 向对方平台请求来交互，并且为避免各平台之间参数编码差异造成不便，本规范要求整合的各平台之间接口数据包均采用统一的 UTF-8 编码。各参与整合的平台需要根据业务需要实现对应的接口，并向资源平台提供实现该接口的请求地址。资源平台在对应功能操作时将自动向该整合平台的接口实现地址发送请求（如登陆） ，整合子平台自行在接口实现中处理相应业务（如登陆较验、session 记录等） 。1.2.2 统一认证登陆说明本集成规范采用”申请审

5、核接入”的方式，即平台接入方需在接入之前向本平台发起一个接入申请，提交平台的相关信息，审核通过后平台会为接入平台生成一个唯一的平台标识 appCode，在接入时用于验证。所有加入统一身份认证的子系统均需要添加一个验证模块（方法 action）,比如SSOAuth，该模块主要负责本系统的用户合法性验证工作（主要根据传递的统一身份认证令牌，验证令牌合法性，并获取登录的用户名、保存用户会话） 。统一身份认证系统登录成功后，将直接跳转到该模块，并传递相应的令牌信息，该模块接收到令牌后，将验证令牌合法性。1.2.2.1 用户登陆假定子系统已在统一身份认证系统中注册、审核通过，下为相关信息统一登陆认证中心

6、：名称 说明 值域名 统一认证平台地址 http:/ $ContextPath登陆地址 统一认证平台登陆地址 http:/ $ContextPath/login登出地址 统一认证平台注销地址 http:/ $ContextPath/logout待集成子系统参数:名称 说明 值域名 子系统平台地址 http:/ $ContextPathAppCode 子系统在统一认证平台申请的系统编码 clientSSOAuth 子系统按要求实现的认证模块地址 http:/ $ContextPath/SSOAuth/indexA、 平台直接登陆（从本平台登陆，登陆成功时返回本平台）1、 向统一认证平台提交本平台

7、实现的验证模块地址(申请集成时提供) ，如：http:/ $ContextPath/client/ssoauth 。2、 第三方平台在实现SSOAuth模块时，以http获取请求参数方式，获取统一认证平台回调时传递的SAMLart(ticket，非smal 模式下)、suffix 两个参数，SAMLart参数为登陆流程中产生的客户端验证码。3、 使用上一步操作获取的参数，拼接登陆请求验证地址，并以http请求方式将获取到的验证码发送回统一认证平台。请求地址拼接规则为： 统一认证平台地址 + suffix + 参数集合 , 参数集包括： 平台接入编辑(appcode)、上一步获取的 SAMLar

8、t(拼接时参数名为TARGET，参数值注意使用URLEncoder编码)等，最终结果地址形如： http:/ $ContextPath/samlValidate?TARGET=http%3A%2F%2F %2Fclient%2Fssoauth1:失败 String 8errDesc 错误描述， 按顺序执行，遇到错误接口便不会继续往下执行。 String 500message 成功执行后的响应消息 String2 接口定义2.1 权限接口(WSDL地址：http:/$ContextPath/iface/privilegeService?wsdl)2.1.1 获取平台单位(单位同步)2.1.1.1

9、 接口描述1、 根据所在地区取单位信息，可选地区或省份编码作为参数2、 单位同步，根据lastUpdated参数，获取有更新的单位2.1.1.2 接口方法 public String queryUnitByDist(String xml);2.1.1.3 输入参数eicsp9a3411a01b8839b0de2e9793dd602484admin323201151415931971586字段说明：名称 说明 数据类型 长度appCode 接口请求方程序标识 String 20appKey 接口请求鉴权码(32 位 md5 加密码 ) String 32userId 调用接口用户登陆名 Stri

10、ng 50provId单位所有省份 ID，国家省份行政编码（居民身份证前 2 位） ，如江苏省（ 32） ，该参数与 distId 任选其一提供即可、另外一个传空String 2distId单位所在地区 ID，国家地区行政编码(居民身份证前6 位 )，如江苏省南京市江宁区(320115)、该字段与provId 任选其一提供即可，同时提供两个时，优先取该字段，另外一个传空String 6lastUpdated单位同步用，最后一次成功同步时间，子平台本地自行记录该参数，每次同步获取单位信息时，传传递该参数，以获取该时间以后更新的单位信息，参数传递时以时间毫秒数传递，若不传该参数，默认取符合以Long上条件的所有单位信息。2.1.1.4 输出参数0001Test0012014-11-14 09:52:342014-11-14 10:32:22幼教N3201152.1.2 获取角色权限2.1.2.1 接口描述根据角色标识获取角色分配的所有权限信息.2.1.2.2 接口方法 public String queryRoleAuths(String xml);2.1.2.3 输入参数eicsp9a3411a01b8839b0de2e9793dd602484admin