《接口设计模板》由会员分享，可在线阅读，更多相关《接口设计模板（5页珍藏版）》请在金锄头文库上搜索。
1、 接口设计说明书接口设计说明书文档编号：项 目 编 号 -*-5xx当前版本：作者：密级：审 批人：完成日期：保密范围：通过日期：YYYY-MM-DD由项目经理指定使用范围秘密*科技有限公司密 级 ：吵洋滴修改历史修改历史版本号版本号修改人修改人修改日期修改日期修改内容修改内容审批人审批人- I -密 级 ：吵洋滴目录目录1 1概述概述.错误!未定义书签。2 2子系统说明子系统说明 1 .1 .错误!未定义书签。接口名 .错错误误! !未定义书签。未定义书签。接口名 .错错误误! !未定义书签。未定义书签。- II -密 级 ：吵洋滴1 1概述概述概述说明本文档的描述的内容、目的、使用场合等。
2、2 2子系统说明子系统说明 1 12.12.1接口名接口名示例如下：接口功能：接口功能：验证用户是否合法。除部分特别说明不需要用户验证的接口外，此接口必须首先调用，否则会出现 “未授权” 的异常错误。 在验证成功之后才能成功调用其它接口，该接口验证通过的用户信息将保存到 IHDUserSession类的实例中，作为其它接口调用的用户信息。此接口在内部需要通过以下几点的验证：1.CA验证， 验证USBKey是否合法 （只有系统策略中设置了需要 CA验证选项后才会进行CA的验证） ；域用户验证，验证登录用户名和密码是否是域用户，通过Windows集成身份验证实现；用户数据库合法性验证，验证登录用户
3、是否存在于USERS表中；计算机合法性验证，验证登录计算机是否存在于 COMPUTER表中，计算机的验证通过计算机名，硬盘序列号， 网卡物理地址， IP地址这四项的组合进行验证，具体组合可以系统策略中配置；2.3.4.5.如果验证未通过，返回 false，并在客户端日志中记录登录失败的原因接口声明：接口声明：*相关数据表：相关数据表：*输入参数：输入参数：*输出参数：输出参数：- 1 -密 级 ：吵洋滴*返回值及异常：返回值及异常：参见错误错误! !未找到引用源。错误未找到引用源。错误! !未找到引用源。未找到引用源。返回值不变。捕获到异常，请对异常进行分析。如果异常类型是*。2.22.2接口名接口名接口功能：接口功能：接口声明：接口声明：相关数据表：相关数据表：输入参数：输入参数：输出参数：输出参数：返回值及异常：返回值及异常：- 2 -
