Web Services业务接口规范说明书

XXXX系统

Web Services业务接口规范说明书

拟制

审核

会签

批准

【公司名称】

版本历史

目录

1.范围 (1)

2.术语、定义和缩略语 (1)

2.1 术语、定义 (1)

2.2 缩略语 (1)

3.接口设计 (1)

3.1 接口公共参数 (1)

3.1.1请求参数 (1)

3.1.2返回参数 (2)

3.2 业务功能接口 (3)

3.2.1业务模块1 (3)

4.MD5加密 (6)

5.参考文献 (6)

1.范围

本规范文档主要适用于XXXX系统和其它业务系统信息数据的接入。

2.术语、定义和缩略语

2.1术语、定义

2.2缩略语

3.接口设计

3.1接口公共参数

接口服务器通过：http://IP:port/EIP/WebService/ 连接服务器，同时对外提供业务功能接口，接收的参数和返回的参数都用一定的xml格式进行封装。

3.1.1请求参数

1.请求类型为String类型

2.头部参数体head定义

请求参数的头部参数体header格式固定，定义如下：

3.请求参数体param定义

参数体param中的具体请求参数，根据不同的业务而不同，详见各业务接口。

3.1.2返回参数

1.返回类型为String类型

2.头部参数体head定义

返回参数的头部参数体header格式固定，定义如下：

3.返回值参数体result定义

参数体result中的具体返回参数，根据不同的业务而不同。详见各业务功能返回值参数体result定义。

注意：在value值标识为失败时，无论在任何业务功能下result都有可能为空。

4.返回value 值

<-- 注释

例如：

3.2业务功能接口3.2.1业务模块1 3.2.1.1模块说明1.

<-- 注释

2.

<-- 注释

例如：

3.2.1.2功能1

1.功能描述

主要对功能1进行描述，说明功能1主要完成什么功能。

2.请求参数体param定义

头部参数体header中的定义参数，详见本文档“请求参数头部参数体header定义”（以下各业务接口中头部参数体header定义相同，不再赘述）。

type属性值xxxx，参数体param说明如下：

<-- 注释

例如：

头部参数体header中的定义参数，详见本文档“请求参数头部参数体header定义”（以下各业务接口中头部参数体header定义相同，不再赘述），type属性值1101，参数体param 说明如下：

3.返回值参数体result定义

头部参数体header中的定义参数，详见本文档“返回参数头部参数体header定义”（以下各业务接口中头部参数体header定义相同，不再赘述），

<-- 注释

例如：

头部参数体header中的定义参数，详见本文档“返回参数头部参数体header定义”（以下各业务接口中头部参数体header定义相同，不再赘述），type属性值1101，参数体result 说明如下：

3.2.1.3功能2

1.功能描述

主要对功能1进行描述，说明功能1主要完成什么功能。