金仕达卫宁统一认证及单点登录接口规范.docx
《金仕达卫宁统一认证及单点登录接口规范.docx》由会员分享，可在线阅读，更多相关《金仕达卫宁统一认证及单点登录接口规范.docx（19页珍藏版）》请在冰点文库上搜索。
金仕达卫宁统一认证及单点登录接口规范
金仕达卫宁单点登录及统一认证接口规范
文档修订
日期
版本
描述
作者
2014-05-20
1.0
初稿
黄龙
第一章单点登录
一、概述
用户只需登录一次，即可通过单点登录系统，访问医院的多个应用系统，二次登陆时无需重新输入用户名和密码。
二、业务流程说明
登录单点登录系统：
用户首先启动单点登录系统，并输入平台用户名和密码进入单点登录系统。
平台用户名及密码的维护可在平台管理界面中进行维护。
带参启动业务系统：
单点登录系统启动业务系统的程序，并传入相应的参数。
业务系统可以是C/S或者B/S结构的程序，分别采用启动EXE带参和调用URL地址的方式。
具体的参数如下：
序号
参数符号
参数值
备注
1
ptflag
PTSSO
固定值
2
appid
业务系统的ID
业务系统在单点登录系统中注册时分配的程序ID,由单点登录系统管理员提供
3
userid
单点登录系统中用户ID
4
loginid
业务系统中用户登录ID
5
captcha
验证码
6
loginflag
登录标志
首次登录时为1，非首次登录为2
7
extendparam
可扩展参数
XML格式，key、value的形式实现,空的参数会传入‘-’符号。
暂空
判断loginflag值：
业务系统读取参数中的loginflag值，根据不同的值进行不同的业务流转。
验证本地用户名和密码:
业务系统根据loginflag判断是否弹出登录界面，当loginflag为1时弹出登录界面。
用户输入业务系统本地的用户名和密码，业务系统按照本地的验证逻辑验证成功后进入下面的步骤。
不成功则再次弹出登录界面。
调用注册用户信息：
首次登录时，业务系统验证本地系统的用户名和密码成功后，将登录的用户ID和用户名称通过服务注册到平台。
如果业务系统采用的用户信息和单点登录系统是同一套则此过程可以省略。
详见注册用户信息服务。
调用登录安全验证：
业务系统被启动之后需调用认证服务的验证服务，以确保此次启动是合法的。
详见登录安全验证服务。
调用通知关闭服务：
业务系统关闭前需要调用平台服务关闭通知服务通知单点登录系统。
详见关闭通知服务。
关闭程序：
单点登录系统根据通知进行相应处理，并返回结果。
业务系统根据此结果选择关闭系统与否。
第二章统一认证
一、概述
对用户的用户名进行统一的管理和维护，对各个业务系统的用户名和密码的管理。
同时能够提供服务的方式与各业务系统进行数据交换。
注意：
本章节只考虑从业务系统直接登录的情况，如果采用单点登录方式登录请参考第一章。
二、交互流程图
平台用户维护：
平台管理员在平台管理界面中对平台的用户进行维护，包括新增、修改和删除。
业务系统信息注册：
业务系统通过调用平台的业务系统信息注册服务将业务系统的信息注册到平台统一认证系统中。
业务系统用户登录（平台用户名和密码）：
在业务系统弹出的登录界面中输入平台用户名和密码。
注意缓存平台的用户名。
调用平台认证服务：
业务系统通过调用平台的统一认证服务验证用户名及密码。
调用此服务可能有三种返回值的情况，详见服务描述。
当业务系统的用户与平台用户采用同一套时，返回值中是不会出现AR的情况，接下来的流程可以省略。
业务系统用户登录（业务系统用户名和密码）：
业务系统再次弹出登录界面，但是与“业务系统用户登录（平台用户名和密码）”情况不同。
在此登录界面输入业务系统的用户名和密码，并且验证是业务系统本地的验证。
本地验证：
业务系统采用本系统的用户名和密码验证逻辑。
调用用户注册服务：
业务系统调用平台的业务系统用户注册服务上传本地用户并与平台用户进行绑定。
进入业务系统：
业务系统通过验证后加载数据。
修改平台密码：
业务系统调用平台的统一修改密码服务，修改平台中的密码。
修改本地密码：
业务系统修改平台密码成功后修改本地密码，保持本地密码与平台密码同步。
第三章统一权限管理
一、概述
对业务系统的所有权限点进行统一的管理和维护，业务系统通过平台服务进行权限点信息的交互。
二、交互流程图
上传权限点:
业务系统调用平台的业务系统权限信息注册服务，将业务系统的权限信息上传到平台中进行统一管理。
角色与权限点维护：
平台管理员通过管理程序对角色和权限的信息进行维护。
用户与角色维护：
平台管理员通过管理程序对角色和权限的信息进行维护。
调用用户权限信息：
业务系统在成功通过平台的统一验证之后，调用获取用户权限服务来加载权限信息。
具体详见获取用户在业务系统的权限服务
第四章服务接口说明
采用WEBSERVICE的方式提供服务。
有如下服务：
业务系统信息注册
业务系统权限信息注册
业务系统用户注册
获取用户在业务系统的权限
登录安全验证
获取已注册的业务系统列表
获取已注册的业务系统权限列表
统一认证时登录验证
关闭单点登录窗口
修改用户密码
平台服务主要分为三大类：
注册服务：
1、业务系统信息注册。
函数名
ApplicationRegister（stringinputdata）
应用场景
启用统一登录及统一认证前，业务系统将系统信息注册到平台。
输入参数说明
appid
varchar（30）
业务系统ID。
可由医院预先分配好
appname
varchar（40）
业务系统的名称
appversion
varchar（10）
业务系统的版本
companyname
varchar（50）
所属公司的名称
decription
varchar（100）
系统的描述信息
格式
xmlversion="1.0"encoding="GB2312"standalone="yes"?
>
业务系统ID
系统名称
系统版本号
公司名称
系统的描述信息
程序架构0:
C/S1:
B/S
返回值参数
retcode
String
状态码，AA：
成功AE:
失败
msg
string
失败原因
格式
xmlversion="1.0"encoding="GB2312"standalone="yes"?
>
状态码
失败原因
2、业务系统权限信息注册。
函数
PermissionRegister（stringinputdata）
应用场景
启用统一登录及统一认证前，业务系统将系统的权限信息注册到平台。
便于平台统一维护用户权限。
输入参数说明
appid
varchar（30）
业务系统注册后被分配的ID
permissionid
varchar（30）
业务系统分配的权限ID
permissionname
varchar（255）
权限名称
permissiondesc
varchar（255）
权限描述
permissiontype
varchar（20）
权限类型，由业务系统自己定义，如菜单、
控件等。
parentid
varchar（20）
父权限ID
无父权限时传空
havechildpermission
Varchar
（1）
是否有子权限，0：
无1：
有
operationtype
Varchar
（1）
操作类别：
0增加1修改2删除
格式
xmlversion="1.0"encoding="GB2312"standalone="yes"?
>
业务系统ID
权限ID
权限名称
权限描述
权限类型
父权限ID
是否有子权限
操作类别
返回值参数
retcode
String
状态码，AA：
成功AE:
失败
msg
string
失败原因
格式
xmlversion="1.0"encoding="GB2312"standalone="yes"?
>
状态码
失败原因
3、业务系统用户注册。
函数
LoginInfoRegister（stringinputdata）
应用场景
首次使用单点登录系统登录业务系统时调用。
目的是映射业务系统用户与平台用户
输入参数说明
Appid
varchar（30）
业务系统注册后被分配的ID
Userid
varchar（20）
平台中统一用户的ID
Loginid
varchar（20）
业务系统中登录的ID。
Loginname
Varchar（40）
业务系统中的用户名
Password
varchar（40）
暂不用，传空
格式
xmlversion="1.0"encoding="GB2312"standalone="yes"?
>
系统ID
平台用户ID
业务系统的用户ID
业务系统的用户名称
密码
返回值参数
Retcode
String
状态码，AA：
成功AE:
失败
Msg
string
失败原因
格式
xmlversion="1.0"encoding="GB2312"standalone="yes"?
>
状态码
失败原因
4、用户密码修改
函数
UpdatePassword（stringinputdata）
应用场景
业务系统修改平台用户密码时调用此方法。
输入参数说明
appid
varchar（30）
业务系统注册后被分配的ID
loginid
varchar（20）
业务系统中登录的ID。
oldpassword
varchar（40）
newpassword
varchar（40）
格式
xmlversion="1.0"encoding="GB2312"standalone="yes"?
>
系统ID
业务系统的用户ID
旧密码
新密码
返回值参数
Retcode
String
状态码，AA：
成功AE:
失败
Msg
string
失败原因
格式
xmlversion="1.0"encoding="GB2312"standalone="yes"?
>
状态码
失败原因
查询服务：
1、获取用户在业务系统的权限。
函数
QueryUserPermissionList（stringinputdata）
应用场景
通过单点登录系统登录业务系统后，调用此函数获取用户在本系统的权限。
例如：
登录HIS系统后，可先获取最顶层权限（用户能进入哪些子系统）；进入子系统时，再获取用户能进入哪些菜单的权限。
传入参数说明
applicationid
varchar（30）
业务系统注册后被分配的ID
userid
varchar（10）
业务系统的用户ID
parentid
Varchar（30）
父权限ID
-1是返回所有权限、为空时返回第一级权限、其他则返回其对应的子权限
permissiontype
Varchar（20）
权限类别ID
为空时返回所有权限
格式
xmlversion="1.0"encoding="GB2312"standalone="yes"?
>
系统ID
业务系统的用户ID
父权限ID
权限类别ID
返回值参数
retcode
String
状态码，AA：
成功AE:
失败
msg
string
失败原因
格式
xmlversion="1.0"encoding="GB2312"standalone="yes"?
>
状态码
失败原因
|
权限ID
权限名称
权限描述
父权限ID
权限类型ID
|
权限ID
权限名称
权限描述
父权限ID
权限类型ID
……
2、获取已注册的业务系统列表。
函数
QueryApplicationList（stringinputdata）
应用场景
查询本系统是否已注册，获取所有已注册的系统。
输入参数说明
格式
xmlversion="1.0"encoding="GB2312"standalone="yes"?
>
返回值参数
retcode
String
状态码，AA：
成功AE:
失败
msg
String
失败原因
格式
xmlversion="1.0"encoding="GB2312"standalone="yes"?
>
状态码
失败原因
|
系统ID
系统名称
系统描述
版本号
公司名称
|
系统ID
系统名称
系统描述
版本号
公司名称
……
3、获取已注册的业务系统权限列表。
函数
QueryPermissionList（stringinputdata）
应用场景
查询本系统已注册过的权限，在不确定已注册过哪些权限的情况下可调用本服务。
传入参数说明
applicationid
varchar（30）
业务系统注册的ID
格式
xmlversion="1.0"encoding="GB2312"standalone="yes"?
>
系统ID
返回值参数
retcode
String
状态码，AA：
成功AE:
失败
msg
String
失败原因
格式
xmlversion="1.0"encoding="GB2312"standalone="yes"?
>
状态码
失败原因
|
业务系统ID
权限ID
权限名称
权限描述
权限类型ID
权限类型名称
父权限ID
注册时间
|
系统ID
权限ID
权限名称
权限描述
权限类型ID
权限类型名称
父权限ID
注册时间
……
验证服务：
1、登录安全验证。
函数
LoginVerify（stringinputdata）
应用场景
从单点登录窗口登录业务系统时，会以参数形式传递给业务系统一个验证码，然后再调用此函数验证是否是安全登录，返回值为AA时应成功登录，否则应拒绝登录。
传入参数说明
applicationid
varchar（20）
当前登录的业务系统ID
loginid
varchar（10）
当前登录的业务系统用户ID
macaddress
Varchar（40）
当前做登录操作的电脑mac地址
captcha
Varchar（40）
登录时平台传入的验证码
格式
xmlversion="1.0"encoding="GB2312"standalone="yes"?
>
系统ID
当前登录的业务系统用户ID
当前做登录操作的电脑mac地址
登录时平台传入的验证码
返回值参数
retcode
String
状态码，AA：
成功AE:
失败
msg
string
失败原因
格式
xmlversion="1.0"encoding="GB2312"standalone="yes"?
>
状态码
失败原因
2、统一认证时登录验证。
函数
CertificationLoginVerify（stringinputdata）
应用场景
业务系统登录时调用此服务，验证用户名、密码。
返回值AA时验证成功，可登录系统；返回AR时未映射平台用户与业务系统用户；返回AE时表示验证失败。
传入参数说明
applicationid
varchar（20）
当前登录的业务系统ID
loginid
varchar（10）
统一用户ID
password
Varchar（40）
统一用户的登录密码
格式
xmlversion="1.0"encoding="GB2312"standalone="yes"?
>
系统ID
统一用户ID
统一用户的登录密码
返回值参数
retcode
String
状态码，AA：
成功AE:
失败AR:
未映射平台用户与业务系统用户
msg
string
Retcode为AA时，msg返回业务系统的用户ID；retcode为AE、AR时，msg返回错误信息
格式
xmlversion="1.0"encoding="GB2312"standalone="yes"?
>
状态码
失败原因
通知服务：
1、关闭单点登录窗口。
函数
CloseSSO（stringinputdata）
应用场景
关闭业务系统时应弹出提示框‘是否关闭单点登录窗口’，选择‘是’时，业务系统应调用此服务通知平台关闭单点登录窗口
传入参数说明
applicationid
varchar（20）
当前登录的业务系统ID
userid
varchar（10）
平台用户ID
captcha
Varchar（40）
登录时平台传入的验证码
格式
x
升级会员 