项目接口需求及设计说明文档.docx
《项目接口需求及设计说明文档.docx》由会员分享，可在线阅读，更多相关《项目接口需求及设计说明文档.docx（10页珍藏版）》请在冰豆网上搜索。
项目接口需求及设计说明文档
媒讯集团EAS项目
CTC与EAS接口
需求及设计说明书
文档作者：
创建日期：
20XX-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.1XXEAS接口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接口与异构系统通信。
EASWebService全部是使用java编写的，其接口描述符合WSDL国际标准，其数据描述符合XSD国际标准。
本次提供的接口除系统登录接口外，其他接口都需要调用登录接口，以便将登陆的
Sessionld信息放入到SOAP的HEADER报文中。
3.4.2使用示例
金蝶在EAS上发布WebService服务，提供wsdl文件供客户端下载，其他业务系统根据下载的wsdl文件，产生客户端。
建议使用Axis2来生成客户端代理。
ads2Clientjar
F面是登录接口调用参数说明:
接口地址
http:
//ip:
port/ormrpc/services/EASLogin
方法名称
login
参数列表
参数名称
别名
类型
备注
userName
EAS用户名
String
EAS系统一个非异常的账户的用户名
Password
密码
String
用户名对应的密码
slnName
都为eas
dataCenterName
数据中心id
String
EAS对应的数据中心
Language
语言
String
默认为L2即可
dbType
数据库类型
int
0sqlserver
1oracle
2db2
相关对象描述
不需要任何对象类型的数据
错误列表
错误代码
错误概述
详细说明
概要逻辑说明
无
调用者说明
无
其他说明
无
以下是Java客户端调用Javawebservices接口的调用代码示例
publicclassDemo{
publicstaticvoidmain（String[]args）throwsException{
Demodemo=newDemo（）;
demo.login（）;
}
**
*EAS登录
*
login方法的参数分别代表为
*java.lang.StringuserName
*java.Iang.Stringpassword
*java.lang.StringslnName
*java.lang.StringdcName
*java.Iang.StringIanguage
*intdbType
*@throwsException
*/
privatevoidlogin（）throwsException
{
StringEASLogin_address="http:
//IP:
6888/ormrpc/services/EASLogin";
URLurl=newURL（EASLogin_address）;
EASLoginProxyproxy=newEASLoginProxyServiceLocator（）.getEASLogin（url）;
WSContextctx=proxy.login（"user","pwd","eas","001","L2",1）;
if（ws!
=null&&ws.getSessionld（）!
=null）{
System.out.println（"登录成功"）；
}
else
{
System.out.println（"登录失败"）；
}
}
}
3.5媒讯CTC系统提供接口服务地址
待三地方补充。
3.6金蝶EAS提供接口服务地址
测试环境：
http:
//192.168.1.209:
6888/ormrpc/services正式环境：
http:
//192.168.1.7:
6888/ormrpc/services建议把IP地址和端口做成一个可配置参数。
3.7接口需求
3.7.1接口概况
本次集成业务所涉及的接口如下表所示
序号
接口名称
数据发送方
数据接收方
接口提供者
接口调用者
3.7.2接口说明
接口处理过程说明:
其他逻辑控制说明:
3.7.3其他要求
四、详细设计
4.1XXEAS接口
4.1.1设计说明
此接口由EAS端（提供者）开发，供媒讯CTC系统（调用者）调用
4.1.2通讯内容
接口地址
方法名称
参数列表
参数名称
别名
类型
备注
返回值
对象描述
bill
错误列表
错误代码
错误概述
概要说明
调用者说明
其他说明
4.1.3通讯用例
--xmlData格式例子
201220383
2012-08-29
2012-08-29
一分
020838010196
升级会员 