项目接口需求及设计说明文档.docx
- 文档编号:5216331
- 上传时间:2022-12-14
- 格式:DOCX
- 页数:9
- 大小:363.98KB
项目接口需求及设计说明文档.docx
《项目接口需求及设计说明文档.docx》由会员分享,可在线阅读,更多相关《项目接口需求及设计说明文档.docx(9页珍藏版)》请在冰豆网上搜索。
项目接口需求及设计说明文档
项目接口需求及设计说明文档(模板)(总9页)
媒讯集团EAS项目
CTC与EAS接口
需求及设计说明书
文档作者:
创建日期:
2013-05-10
确认日期:
当前版本:
拷贝数量:
1
审批签字:
客户方:
实施方:
文档控制
修改记录
日期
作者
版本
参考版本
备注
1.概述
金蝶与用户及用户业务系统方通过多次讨论,制定了接口开发需求设计说明书,作为双方后续开发指引。
读者
本文读者对象为业务管理人员、系统设计、开发人员、测试人员。
图例
本文中如未进行特殊说明,各图标代表的含义如下:
表示一个活动;
表示动态的业务数据,如系统单据;
表示流程走向;
表示条件判断、流程分支;
表示静态的业务数据,如基础资料;
表示系统外一个手工处理活动;
表示系统外手工填制的单据;
表示当前系统之外的活动;
表示当前系统之外产生的业务数据。
目的
本文档是媒讯CTC系统与EAS系统接口的需求及设计方案相关文档,可用于指导开发、测试工作和作为验收相关依据文档。
二、业务现状
待补充
三、概要设计
接口通讯方式
金蝶EAS与媒讯CTC系统之间通讯采用WebService方式进行数据传输。
通讯内容定义
对于记录型的大对象,在通讯时,采用String型的xml格式的参数进行传递。
对于其他非记录型的对象,在通讯时,可采用非xml格式的参数进行传递,也可使用多个参数。
具体格式,请参照每个接口的通讯用例说明。
媒讯CTC系统提供接口使用范例
待补充。
金蝶EAS提供接口使用范例
规范说明
EAS通过webService接口与异构系统通信。
EASWebService全部是使用java编写的,其接口描述符合WSDL国际标准,其数据描述符合XSD国际标准。
本次提供的接口除系统登录接口外,其他接口都需要调用登录接口,以便将登陆的SessionId信息放入到SOAP的HEADER报文中。
使用示例
金蝶在EAS上发布WebService服务,提供wsdl文件供客户端下载,其他业务系统根据下载的wsdl文件,产生客户端。
建议使用Axis2来生成客户端代理。
下面是登录接口调用参数说明:
接口地址
sqlserver
1oracle
2db2
相关对象描述
不需要任何对象类型的数据
错误列表
错误代码
错误概述
详细说明
概要逻辑说明
无
调用者说明
无
其他说明
无
以下是Java客户端调用Javawebservices接口的调用代码示例:
publicclassDemo{
publicstaticvoidmain(String[]args)throwsException{
Demodemo=newDemo();
();
}
/**
*EAS登录
*login方法的参数分别代表为:
*userName用户名,
*password密码,
*slnNameeas,
*dcName数据中心代码,
*language语言,简体中文为L2,
*intdbType0sqlserver1oracle2db2
*@throwsException
*/
privatevoidlogin()throwsException
{
StringEASLogin_address="";
URLurl=newURL(EASLogin_address);
EASLoginProxyproxy=newEASLoginProxyServiceLocator().getEASLogin(url);
WSContextctx=("user","pwd","eas","001","L2",1);
if(ws!
=null&&()!
=null){
"登录成功");
}
else
{
"登录失败");
}
}
}
媒讯CTC系统提供接口服务地址
待三地方补充。
金蝶EAS提供接口服务地址
测试环境:
EAS接口
设计说明
此接口由EAS端(提供者)开发,供媒讯CTC系统(调用者)调用。
通讯内容
接口地址
方法名称
参数列表
参数名称
别名
类型
备注
返回值
对象描述
bill
错误列表
错误代码
错误概述
概要说明
调用者说明
其他说明
通讯用例
--xmlData格式例子
……
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 项目 接口 需求 设计 说明 文档