项目接口需求及设计说明文档(模板)

客户化开发需求规格说明书媒媒讯讯集集团团EEAASS项项目目CTC与EAS接口需求及设计说明书文文档档作作者者：：创创建建日日期期：：22001133--0055--1100确确认认日日期期：：当当前前版版本本：：11..00拷拷贝贝数数量量：：11审审批批签签字字::客户方：实施方：客户化开发需求规格说明书2文文档档控控制制修修改改记记录录日期作者版本参考版本备注客户化开发需求规格说明书3目录1.概述.................................................................................................................................................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客户化开发需求规格说明书41.概述金蝶与用户及用户业务系统方通过多次讨论，制定了接口开发需求设计说明书，作为双方后续开发指引。1.1读者本文读者对象为业务管理人员、系统设计、开发人员、测试人员。1.2图例本文中如未进行特殊说明，各图标代表的含义如下：表示一个活动；表示动态的业务数据，如系统单据；表示流程走向；表示条件判断、流程分支；表示静态的业务数据，如基础资料；表示系统外一个手工处理活动；表示系统外手工填制的单据；表示当前系统之外的活动；表示当前系统之外产生的业务数据。1.3目的本文档是媒讯CTC系统与EAS系统接口的需求及设计方案相关文档，可用于指导开发、测试工作和作为验收相关依据文档。客户化开发需求规格说明书5二、业务现状待补充三、概要设计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信息放入到SOAP的HEADER报文中。3.4.2使用示例金蝶在EAS上发布WebService服务，提供wsdl文件供客户端下载，其他业务系统根据下载的wsdl文件，产生客户端。建议使用Axis2来生成客户端代理。客户化开发需求规格说明书6下面是登录接口调用参数说明：接口地址方法名称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=客户化开发需求规格说明书7URLurl=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提供接口服务地址测试环境：正式环境：建议把IP地址和端口做成一个可配置参数。3.7接口需求3.7.1接口概况本次集成业务所涉及的接口如下表所示:序号接口名称数据发送方数据接收方接口提供者接口调用者3.7.2接口说明接口处理过程说明：其他逻辑控制说明：客户化开发需求规格说明书83.7.3其他要求四、详细设计4.1XXEAS接口4.1.1设计说明此接口由EAS端(提供者)开发，供媒讯CTC系统(调用者)调用。4.1.2通讯内容接口地址方法名称参数列表参数名称别名类型备注返回值对象描述bill客户化开发需求规格说明书9错误列表错误代码错误概述概要说明调用者说明其他说明4.1.3通讯用例--xmlData格式例子ComplaintBillbillnumber201220383/numberrecordTime2012-08-29/recordTimerecorder2012-08-29/recorderdept一分/depttelphone020838010196/telphone……/bill/ComplaintBill