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

媒讯集团EAS项目CTC与EAS接口需求及设计阐明书文档作者： 创立日期： -05-10确认日期： 当前版本： 1.0拷贝数量： 1审批签字:客户方：实行方：文档控制 修改记录日期作者版本参照版本备注目录TOC\o"1-3"\h\u1. 概述 41.1读者 41.2图例 41.3目 4二、业务现状 5三、概要设计 53.1接口通讯方式 53.2通讯内容定义 53.3媒讯CTC系统提供接口使用范例 53.4金蝶EAS提供接口使用范例 53.5媒讯CTC系统提供接口服务地址 73.6金蝶EAS提供接口服务地址 73.7接口需求 7四、详细设计 84.1XXEAS接口 8概述金蝶与顾客及顾客业务系统方通过多次讨论，制定了接口开发需求设计阐明书，作为双方后续开发指引。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国际原则。本次提供接口除系统登录接口外，其她接口都需要调用登录接口，以便将登陆SessionId信息放入到SOAPHEADER报文中。3.4.2使用示例金蝶在EAS上发布WebService服务，提供wsdl文献供客户端下载，其她业务系统依照下载wsdl文献，产生客户端。建议使用Axis2来生成客户端代理。下面是登录接口调用参数阐明：接口地址http://ip:port/ormrpc/services/EASLogin办法名称login参数列表参数名称别名类型备注userNameEAS顾客名StringEAS系统一种非异常账户顾客名Password密码String顾客名相应密码slnName都为easdataCenterName数据中心idStringEAS相应数据中心Language语言String默以为L2即可dbType数据库类型int0sqlserver1oracle2db2有关对象描述不需要任何对象类型数据错误列表错误代码错误概述详细阐明概要逻辑阐明无调用者阐明无其她阐明无如下是Java客户端调用Javawebservices接口调用代码示例:publicclassDemo{publicstaticvoidmain(String[]args)throwsException{Demodemo=newDemo();demo.login();}/***EAS登录*login办法参数分别代表为:*java.lang.StringuserName顾客名，*java.lang.Stringpassword密码，*java.lang.StringslnNameeas,*java.lang.StringdcName数据中心代码，*java.lang.Stringlanguage语言，简体中文为L2，*intdbType0sqlserver1oracle2db2*@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.getSessionId()!=null){ System.out.println("登录成功"); } else { System.out.println("登录失败"); }}}3.5媒讯CTC系统提供接口服务地址待三地方补充。3.6金蝶EAS提供接口服务地址测试环境：HYPERLINK:6888/ormrpc/services正式环境：: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格式例子<ComplaintBill><bill><numb