项目接口需求及设计说明文档模板样本.doc

媒讯集团EAS项目

CTC与EAS接口
需求及设计阐明书

文档作者：
创立日期： -05-10
确认日期：
当前版本： 1.0
拷贝数量： 1

审批签字:
客户方：

实行方：

文档控制
修改记录
日期
作者
版本
参照版本
备注

目录
1. 概述 4
1.1读者 4
1.2图例 4
1.3目 4
二、业务现状 5
三、概要设计 5
3.1接口通讯方式 5
3.2通讯内容定义 5
3.3媒讯CTC系统提供接口使用范例 5
3.4金蝶EAS提供接口使用范例 5
3.5媒讯CTC系统提供接口服务地址 7
3.6金蝶EAS提供接口服务地址 7
3.7接口需求 7
四、详细设计 8
4.1XX EAS接口 8

1. 概述
金蝶与顾客及顾客业务系统方通过多次讨论，制定了接口开发需求设计阐明书，作为双方后续开发指引。
1.1读者
本文读者对象为业务管理人员、系统设计、开发人员、测试人员。
1.2图例
本文中如未进行特殊阐明，各图标代表含义如下：
表达一种活动；
表达动态业务数据，如系统单据；
表达流程走向；
表达条件判断、流程分支；
表达静态业务数据，如基本资料；
表达系统外一种手工解决活动；
表达系统外手工填制单据；
表达当前系统之外活动；
表达当前系统之外产生业务数据。

1.3目
本文档是媒讯CTC系统与EAS系统接口需求及设计方案有关文档，可用于指引开发、测试工作和作为验收有关根据文档。

二、业务现状
待补充
三、概要设计
3.1接口通讯方式
金蝶EAS与媒讯CTC系统之间通讯采用WebService方式进行数据传播。
3.2通讯内容定义
对于记录型大对象，在通讯时，采用String型xml格式参数进行传递。对于其她非记录型对象，在通讯时，可采用非xml格式参数进行传递，也可使用各种参数。详细格式，请参照每个接口通讯用例阐明。
3.3媒讯CTC系统提供接口使用范例
待补充。
3.4金蝶EAS提供接口使用范例
3.4.1规范阐明
EAS通过webService接口与异构系统通信。EAS WebService所有是使用java编写，其接口描述符合WSDL国际原则，其数据描述符合XSD 国际原则。
本次提供接口除系统登录接口外，其她接口都需要调用登录接口，以便将登陆SessionId信息放入到 SOAP HEADER 报文中。
3.4.2使用示例
金蝶在EAS上发布WebService服务，提供wsdl文献供客户端下载，其她业务系统依照下载wsdl文献，产生客户端。
建议使用Axis2来生成客户端代理。

下面是登录接口调用参数阐明：

接口地址
http://ip:port/ormrpc/services/EASLogin
办法名称
login
参数列表
参数名称
别名
类型
备注
userName
EAS顾客名
String
EAS系统一种非异常账户顾客名
Password
密码
String
顾客名相应密码
slnName

都为eas
dataCenterName
数据中心id
String
EAS相应数据中心
Language
语言
String
默以为L2即可
dbType
数据库类型
int
0 sql server
1 oracle
2 db2
有关对象描述
不需要任何对象类型数据
错误列表
错误代码
错误概述
详细阐明

概要逻辑阐明
无
调用者阐明
无
其她阐明
无

如下是Java客户端调用Java webservices接口调用代码示例:
public class Demo {
public static void main(String[] args) throws Exception {
Demo demo = new Demo();
demo.login();
}
/**
* EAS登录
* login办法参数分别代表为:
* java.lang.String userName 顾客名，
* java.lang.String password 密码，
* java.lang.String slnName eas,
* java.lang.String dcName 数据中心代码，
* java.lang.String language 语言，简体中文为L2，
* int dbType 0 sql server 1 oracle 2 db2
* @throws Exception
*/
private void login() throws Exception
{
String EASLogin_address ="http://IP:6888/ormrpc/services/EASLogin";
URL url = new URL(EASLogin_address);
EASLoginProxy proxy=new EASLoginProxyServiceLocator().getEASLogin(url);
WSContext ctx = proxy.login("user"，"pwd"，"eas"，"001"，"L2"，1);
if(ws != null&& ws.getSessionId() !=null){
System.out.println("登录成功");
}
else
{
System.out.println("登录失败");
}
}
}
3.5媒讯CTC系统提供接口服务地址
待三地方补充。
3.6金蝶EAS提供接口服务地址
测试环境：:6888/ormrpc/services
正式环境：:6888/ormrpc/services
建议把IP地址和端口做成一种可配备参数。
3.7接口需求
3.7.1接口概况
本次集成业务所涉及接口如下表所示:
序号
接口名称
数据发送方
数据接受方
接口提供者
接口调用者

3.7.2接口阐明
接口解决过程阐明：

其她逻辑控制阐明：
3.7.3其她规定

四、详细设计
4.1XX EAS接口
4.1.1设计阐明
此接口由EAS端(提供者)开发，供媒讯CTC系统 (调用者)调用。
4.1.2通讯内容
接口地址

办法名称

参数列表
参数名称
别名
类型
备注

返回值

对象描述

bill

错误列表
错误代码
错误概述

概要阐明

调用者阐明

其她阐明

4.1.3通讯用例
--xmlData格式例子
<ComplaintBill>
<bill>
<number>20383</number>
<recordTime>-08-29</<recordTime>
<recorder>-08-29</recorder>
<dept>一分</dept>
<telphone></telphone>
……
</bill>
</ComplaintBill>