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

媒讯集团 EAS 项目

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

文档作者：

创建日期：2013-05-10

确认日期：

当前版本：

拷贝数量：1

审批签字:

客户方：

实施方：

文档控制

修改记录

日期作者版本参考版本备注

目录

1.概述错误 !未定义书签。

读者错误 ! 未定义书签。

图例错误 ! 未定义书签。

目的错误 ! 未定义书签。

二、业务现状错误 !未定义书签。

三、概要设计错误 !未定义书签。

接口通讯方式错误 !未定义书签。

通讯内容定义错误 !未定义书签。

媒讯 CTC系统提供接口使用范例错误!未定义书签。

金蝶 EAS提供接口使用范例错误!未定义书签。

媒讯 CTC系统提供接口服务地址错误!未定义书签。

金蝶 EAS提供接口服务地址错误!未定义书签。

接口需求错误!未定义书签。

四、详细设计错误 !未定义书签。

EAS接口错误!未定义书签。

概述

金蝶与用户及用户业务系统方通过多次讨论，制定了接口开发需求设计说明书，作为双方后续开发指引。读者

本文读者对象为业务管理人员、系统设计、开发人员、测试人员。

图例

本文中如未进行特殊说明，各图标代表的含义如下：

表示一个活动；

表示动态的业务数据，如系统单据；

表示流程走向；

表示条件判断、流程分支；

表示静态的业务数据，如基础资料；

表示系统外一个手工处理活动；

表示系统外手工填制的单据；

表示当前系统之外的活动；

表示当前系统之外产生的业务数据。

目的

本文档是媒讯 CTC系统与 EAS 系统接口的需求及设计方案相关文档，可用于指导开发、测试工作和作为验

收相关依据文档。

二、业务现状

待补充

三、概要设计

接口通讯方式

金蝶 EAS与媒讯 CTC系统之间通讯采用WebService方式进行数据传输。

通讯内容定义

对于记录型的大对象，在通讯时，采用 String 型的 xml 格式的参数进行传递。对于其他非记录型的对象，在通讯时，可采用非xml 格式的参数进行传递，也可使用多个参数。具体格式，请参照每个接口的通讯用例说明。

媒讯 CTC系统提供接口使用范例

待补充。

金蝶 EAS提供接口使用范例

规范说明

EAS通过 webService 接口与异构系统通信。 EAS WebService全部是使用 java 编写的，其接口描述符合 WSDL国际标准，其数据描述符合 XSD 国际标准。

本次提供的接口除系统登录接口外，其他接口都需要调用登录接口，以便将登陆的SessionId信息放入到 SOAP 的 HEADER报文中。

使用示例

金蝶在 EAS上发布 WebService 服务，提供 wsdl 文件供客户端下载，其他业务系统根据下载的 wsdl 文件，产生客户端。

建议使用 Axis2 来生成客户端代理。

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

接口地址

sql server

1 oracle

2 db2

相关对象描述不需要任何对象类型的数据

错误代码错误概述详细说明错误列表

概要逻辑说明无

调用者说明无

其他说明无

以下是 Java 客户端调用Java webservices接口的调用代码示例:

public class Demo {

public static void main(String[] args) throws Exception {

Demo demo = new Demo();

();

}

/**

* EAS 登录

* login 方法的参数分别代表为:

*userName 用户名 ,

*password密码 ,

*slnName eas,

*dcName数据中心代码 ,

*language语言，简体中文为 L2,

* int dbType0 sql server 1 oracle 2 db2

*@throws Exception

*/

private void login() throws Exception

{

String EASLogin_address ="";

URL url = new URL(EASLogin_address);

EASLoginProxy proxy=new EASLoginProxyServiceLocator().getEASLogin(url);

WSContext ctx = ("user", "pwd", "eas", "001", "L2", 1);

if (ws != null && () != null ){

"登录成功 " );

}

else

{

"登录失败 " );

}

}

}

媒讯 CTC系统提供接口服务地址

待三地方补充。

金蝶 EAS提供接口服务地址

测试环境：正式环境：建议把IP 地址和端口做成一个可配置参数。

接口需求

接口概况

本次集成业务所涉及的接口如下表所示:

序号接口名称数据发送方数据接收方接口提供者接口调用者

接口说明

接口处理过程说明：

其他逻辑控制说明：

其他要求