一个完整的接口技术解决方案（一）

题注：
      发表这篇解决方案，属于非盈利目的。主要是为了让大家了解一种接口技术解决方案文档的编写格式以及让大家评审在我的这个技术解决方案中的不足之处，以便大家指出并加以改进。
      转载，下载或与各种形式使用这篇文章，必须注明文章的作者，出处。
      其他未尽事宜，以国家法律规定的为准！
                                                                    作者：南疯

文档编号：<?xml:namespace prefix = o ns = "urn:schemas-microsoft-com:office:office" />	T-JKJS
文档版本：	0.01
项目编号：	XX-DX- <?xml:namespace prefix = st1 ns = "urn:schemas-microsoft-com:office:smarttags" />PECS

《XX电信工程外部协作系统》

Project Exterior Cooperation System

施工单位接口技术解决方案

编写人：	南疯	日期：	2006-10-30
审核人：	<?xml:namespace prefix = v ns = "urn:schemas-microsoft-com:vml" />	日期：
批准人：		日期：

<?xml:namespace prefix = w ns = "urn:schemas-microsoft-com:office:word" />XXXXXX信息科技股份有限公司

地址：	XXXXXXX	邮编：XXXXXX
电话：	XXXXXXXX	传真：XXXXXX
网站：	XXXXXXXXX

修改记录（Revision Chart）

版本号	批准人	修改人	修改日期	修改记录
0.01		南疯	2006-10-30	第一次创建

0.02详细修改记录：

序号	内容

1 引言.... 5

1.1 编写目的... 5

1.2 覆盖范围... 5

1.3 预期读者与阅读建议... 5

1.4 文档约定... 5

1.5 术语与缩略语... 5

1.6 参考文献... 6

2 概述.... 7

3 接口方式.... 8

4 接口安全.... 9

4.1 接口认证... 9

4.2 数据安全... 10

5 事务处理.... 10

6 性能考虑.... 11

7 容错处理.... 12

8 数据格式.... 12

8.1 约定... 13

8.2 施工系统向外协系统发送请求... 13

8.2.1 请求查询一个业务数据... 14

8.2.2 新增一条记录，得到记录的键值... 17

8.2.3 修改一条记录... 19

8.2.4 删除一条记录... 21

8.2.5 文档上传... 23

8.2.6 一条记录中一个文档字段上传多个文件... 25

8.2.7 补充上传文档... 26

8.2.8 在记录中删除一个文档... 27

8.2.9 获得文档的基本信息... 28

8.2.10 获得文档的所有兄弟信息... 31

8.2.11 获得文档的所有父亲信息... 32

8.2.12 下载一个文档... 32

8.2.13 获得字典... 34

8.3 外协系统向施工系统发送请求... 35

8.3.1发送变更后的数据... 36

8.3.2发送变更后的字典... 38

8.3.3文档发送请求... 40

9 信息数据项.... 40

9.1 数据表... 40

9.2 字段信息... 42

9.3 字典类型... 42

10 网页地址.... 44

11 Web Service接口.... 44

11.1 接口命名规范... 44

11.2 输入参数... 44

11.3 输出参数... 45

11.4 外协系统提供的其他接口... 45

12 附录：待定问题.... 45

1 引言

1.1 编写目的

本文档为XX电信工程外部协作系统（以下简称外协系统）与电信工程施工单位内部系统（以下简称施工系统）接口技术解决方案，以此作为外协系统与施工系统实施接口的技术方案依据和项目设计标准。

1.2 覆盖范围

XX电信工程外部协作系统项目组

施工系统接口开发技术组

1.3 预期读者与阅读建议

1.4 文档约定

粗体正文表示强调内容

红色正文表示未完成或需要今后考虑的内容

蓝色正文表示待讨论内容

1.5 术语与缩略语

术语、缩略语	定义
外协系统	XX电信工程外部协作系统
施工系统	电信工程施工单位内部系统
PECS	XX电信工程外部协作系统英文简称

1.6 参考文献

(XXXX)

2 概述

建设XX电信工程外部协作系统的目标，是在工程项目的管理、建设、使用和实施单位之间搭建起数据交换和协同工作的信息平台，延伸与拓展工程建设管理信息化的应用范围，实现通信工程建设过程的信息化管理，促进工程项目的管理部门、建设部门、实施部门和使用部门之间业务流程协调有序地开展，实现工程项目设计、施工、监理管理功能，将相关的设计、施工、监理单位纳入到工程建设管理中，完善工程项目建设过程管理体系，通过信息化推动管理的规范化，在信息化的应用过程中不断探索市场环境下工程建设管理的新思路和新方法。

根据工程部业务工作的实际情况，项目首先满足工程建设管理中应用最广泛、问题最突出的基本需求。

项目功能需求包括：

Ø 建立工程外部协作系统与MSS等系统的接口；

Ø 建立设计协作服务、监理协作服务、施工协作服务模块，为邮电设计院、电话监理公司和电信工程公司提供工程部所需的协作服务，保证工程建设实施流程的开展；

Ø 在建立工程协作服务模块的基础上，建立工程外部协作系统与邮电设计院、电话监理公司、电信工程公司信息系统的接口，实现工程部与三家实施单位的信息交互与业务协作；

本技术解决方案就是针对实现工程建设部与三家实施单位信息交互与业务协作接口中施工单位接口的技术解决方案的组成部分。

在接口的调用过程中，存在施工系统调用外协系统接口的情况，这时候，施工系统作为客户端，外协系统作为服务端；也存在外协系统调用施工系统的情况，这时候，外协系统作为客户端，施工系统作为服务端。本方案中，除了特殊另外说明外，不考虑外协系统和施工系统角色换位的问题。如果一方发起了调用，那么它就是客户端，另一方就是服务端。反之亦然。

4 接口方式

u 工程外协系统与施工系统之间的接口采用Web Service接口形式来进行业务数据的交互。

u 接口数据传输采用XML数据交换格式，utf-8编码。

u 在外协系统中提供Web Service的API接口。提供由施工系统调用获得信息；并且提供施工系统提交信息的API接口。

u 同样，在施工系统中提供Web Service的API接口。提供由外协系统提交信息的API接口。

u 考虑到工程外协中的数据信息不仅包括了XX电信工程公司的数据而且还包含了其他的施工单位的数据信息。而这些单位也各有其各自工程应用系统。这样，外协系统对各个施工单位系统所提供的接口API及其参数信息、格式均是统一的。同时，也要求各个施工单位所提供的接口API及其参数、格式等也必须要求统一。外协系统与施工系统属于一对多的关系。

u 外协系统要求能够有目的，信息有过滤的把业务信息通过接口正确的发送给相应施工系统接口。非相关的信息不要发送给对应的施工系统。

u 施工系统建立用户映像对照表、字典对照表、单位对照表等数据映像，传递给外协的数据使用的是映像中转换后的外协系统能够识别数据；同时，接收到的数据也根据对照表转换成各自能够解释的数据格式。

u 数据初始化的时候，由施工系统主动调用外协系统的接口，以获得用户信息、字典信息、单位信息、项目信息等基础信息。以后，一旦发生数据的变动，由外协系统主动往施工系统发送信息。

u 外协系统不主动请求施工系统获得数据，但是外协系统会主动请求施工系统发送数据。

u 施工系统主动请求外协系统获得数据，也会主动请求外协系统发送数据。

转载于:https://www.cnblogs.com/wayne-ivan/archive/2006/11/06/551262.html