Openet ICS系统内部接口规范

Openet互联网内容控制系统（Openet ICS）

内部接口规范

拟制人______ ________ 审核人______________________ 批准人______________________

傲天信息技术（深圳）有限公司

2003年9月

目录

1.接口协议 (5)

1.1. IM协议 (5)

1.2. 文件接口 (6)

1.3. Radius协议 (7)

2.全网策略管理中心与节点策略服务器的策略同步接口 (7)

2.1. 黑白名单地址基准文件接口 (7)

2.2. 黑白名单地址增量文件接口 (8)

2.3. 基本控制策略文件接口 (9)

3.节点策略服务器与前置机的策略同步接口 (11)

3.1. 文件更新通知接口 (12)

3.2. 文件下载接口 (12)

3.3. 节点本地的基本控制策略增量文件接口 (12)

3.4. 本地域名-IP对应关系增量文件接口（可选） (13)

4. WEB门户与策略服务器接口 (15)

4.1. 通知接口 (15)

4.1.1. 用户数据更改通知（7036） (15)

4.1.2. 配置数据更改通知（7038） (15)

4.1.3. 防鲨网控制策略数据更改通知（7040） (16)

4.2. 日志参数修改接口 (16)

4.2.1. 修改日志配置参数（224） (16)

4.3. 推送策略管理接口 (17)

4.3.1. 增加PUSH策略（150） (18)

4.3.2. 修改PUSH策略（178） (18)

4.3.3. 删除PUSH策略（176） (18)

4.3.4.添加推送参数（192） (19)

4.3.5. 修改推送参数（194） (19)

4.3.6. 删除推送参数（196） (19)

4.4. 普通/专线用户管理 (20)

4.4.1. 增加用户（186） (21)

4.4.2. 修改用户信息（188） (21)

4.4.3. 删除用户（190） (21)

4.4.4. 增加群组用户（230） (22)

4.4.5. 修改群组用户（） (22)

4.4.6. 群组用户状态修改（232） (22)

4.4.7. 群组用户服务应用（234） (23)

4.4.8. 群组用户服务应用状态修改（236） (23)

4.5. 特殊用户管理 (24)

4.5.1. 增加特殊用户（212） (24)

4.5.2. 删除特殊用户（214） (24)

4.6. 推送策略组管理 (25)

4.6.1. 增加策略组（198） (25)

4.6.2. 删除策略组（200） (26)

4.6.4. 策略组应用（204） (26)

4.6.5. 取消策略组应用（208） (27)

4.7. 文件推送策略管理 (27)

4.7.1. 文件策略应用（206） (27)

4.7.2. 取消文件策略应用（210） (27)

4.7.3. 刷新文件策略（226） (28)

4.7.4. 删除策略文件（228） (28)

4.8. 二次认证接口 (28)

4.8.1. 二次认证通知接口（7042） (28)

5. 策略服务器与前置机数据同步接口 (29)

5.1. 互联特区业务管理 (29)

5.1.1. 增加一条或多条互联特区控制信息（6046） (30)

5.1.2. 删除一条或多条互联特区控制信息（6048） (30)

5.1.3. 请求所有互联特区控制信息（6050） (30)

5.2. 无条件放行IP数据管理 (30)

5.2.1. 修改一条或多条无条件放行IP信息（6052） (31)

5.2.2. 请求所有无条件放行IP信息（6054） (31)

5.3.Radius配置参数 (31)

5.3.1. 请求所有Radius配置参数（6058） (32)

5.3.2. 增加或删除Radius配置参数（6060） (32)

5.4. IP过滤及端口过滤配置参数 (32)

5.4.1. 请求所有IP过滤及端口过滤控制信息（6004） (33)

5.4.2. 增加IP过滤及端口过滤控制信息（6004） (33)

5.4.3. 删除IP过滤及端口过滤控制信息（6008） (33)

5.5. 地址分类数据更新 (34)

5.5.1. 增加一个或多个URL地址（6022） (34)

5.5.2. 删除一个或多个URL地址（6024） (34)

5.5.3. 前置机请求所有URL地址分类（6020） (35)

5.6. 端口过滤信息更新 (35)

5.6.1. 前置机请求所有端口过滤控制信息（6004） (35)

5.6.2. 增加端口过滤控制信息（6006） (36)

5.6.3. 删除端口过滤控制信息（6008） (36)

5.7. 关键字过滤信息更新 (36)

5.7.1. 前置机请求所有关键字过滤控制信息（6010） (36)

5.7.2. 增加关键字过滤控制信息（6012） (37)

5.7.3. 删除关键字过滤控制信息（6014） (37)

5.8. 域名-IP数据更新 (37)

5.8.1. 一个域名增加一个或多个IP（6000） (37)

5.8.2. 一个域名删除一个或多个IP（6002） (38)

5.9. 组ID数据更新 (38)

5.9.1. 前置机请求所有组ID信息（6034） (38)

5.9.2. 增加组ID（6036） (38)

5.9.3. 删除组ID（6038） (39)

5.10. 文件信息更新 (39)

5.10.1. 前置机请求当前需要更新的文件名（6042） (39)

5.10.2. 更新文件名通知（6044） (40)

5.11. PUSH类信息接口 (40)

5.11.1. 前置机请求所有的策略信息（19） (41)

5.11.2. 增加一条策略信息（21） (41)

5.11.3. 修改一条策略信息（23） (42)

5.11.4. 删除一条或多条策略信息（25） (42)

5.11.5. 前置机请求全局、缺省参数（37） (42)

5.11.6. 修改全局、缺省参数（41） (43)

5.11.7. 通知一个或多个在线用户的计数器置0（59） (43)

6. 策略服务器监控接口 (46)

6.1. 取策略服务器当前的CPU/IO/磁盘状态（3003） (46)

6.2. 取策略服务器当前的线程信息（3001） (46)

6.3. 取策略服务器当前的统计信息（3005） (47)

6.4. 取策略服务器当前的队列状态信息（3007） (47)

7. 前置机监控接口 (48)

7.1. 取前置机当前的配置信息（202） (49)

7.2. 取前置机计数器（204） (50)

7.3. 取前置机当前的CPU/IO/磁盘状态（206） (50)

7.4. 取前置机当前某个PUSHID详细信息（208） (50)

7.5. 取前置机当前某个在线用户的实时状态（210） (51)

7.6. 取前置机当前内存的缺省信息（211） (52)

7.7. 取前置机当前WCCP协议状态（213） (52)

7.8. 取前置机内存某一ICSID的信息（215） (52)

8. 附录 (53)

8.1. 策略服务器错误码定义 (53)

1.接口协议

1.1. I M协议

IM协议是Openet自定义的一种基于Socket方式的实时通信接口，主要用于策略服务器与前置机、WEB系统与策略服务器之间进行实时通信。

IM协议每一个通讯数据包由定长的包头和不定长的包体组成。

struct im_head_t

{

unsigned char cVersion;

unsigned int iOperationCode;

unsigned short iFunctionCode;

unsigned char cReserved1;

unsigned int iSeqno;

unsigned short isLength;

unsigned char cMd5[16];

unsigned char cReserved2[2];

};

2)协议包体

协议包体定义为一个最长1024字节的字节数组，包体不定长，其容内容根据包头中的操作码进行解析，每个操作码对应一种具体的包体格式定义（参见操作码的定义）。

1.2. 文件接口

1)文件传送

对某些非实时的、数据量比较大的数据采用文件接口方式进行处理，如黑白名单地址数据、全局的控制策略数据等。文件通过FTP方式进行传送，由FTP客户端主动登录服务器端获取数据。

2)文件的加/解密

所有跨子系统进行传送的文件需要进行加密，由文件生成方对文件内容进行加密，文件接收方对文件内容进行解密，加解密方式如下：

密钥：文件发送方和接收方拥有相同的公共密钥。

加密：对文件中的每行记录进行逐一加密，加密采用（逐字节＋1）后和密钥进行异或的简单算法。

解密：对文件中的每行记录进行逐一解密，用密文与密钥进行异或后（逐字节－1）的方法进行解密。

1.3. R adius协议

使用标准的Radius协议进行通讯，主要适用于策略服务器与IP计费系统Radius Server 之间的通讯，用于处理用户的上下线信息（记帐开始包和记帐结束包）。

2.全网策略管理中心与节点策略服务器的策略同步接口

全网策略管理中心与节点策略服务器之间的接口用于同步黑名名单地址数据、域名-IP 对应关系数据、过滤关键字、过滤端口、过滤IP等控制策略数据。

所有的数据接口采用文件方式，由全网策略管理中心生成策略文件，节点策略服务器主动以FTP方式进行获取。

1)通讯方式：

◆通讯协议：FTP

◆发送方：全网策略管理中心

◆接收方：节点策略服务器（节点策略服务器主动与全网策略管理中心建立FTP连

接并以GET方式获取文件。）

2)文件管理

全网策略管理中心给每个节点策略服务器开一个FTP帐号，策略管理中心生成文件时给每个帐号复制一份相同的文件，节点策略服务器以FTP方式登录后，从本帐户的主路径下获取文件，文件传送成功后可删除远程文件。

2.1. 黑白名单地址基准文件接口

1)接口说明：同步全网策略管理中心的全部黑白名单地址数据给节点策略服务器。

2)同步时间：全网策略管理中心每月产生一次基准文件（时间间隔可设置），策略服务器

自行控制获取基准文件的时间间隔。

3)文件命名：BURLYYYYMMDDNNN.TXT

◆BURL表示地址基准文件

◆YYYYMMDD表示文件产生的日期

◆NNN表示文件序列号，序列号每天重新开始编号，从000开始编号，到999后循

环。

4)文件规范

◆文件头（定长，总字节数：60Byte ）

◆文件体

文件体中每行为1条数据记录，由固定顺序的非定长字段组成，字段之间通过逗号分隔。数据记录之间通过换行符（\n）分隔。（每个字段的内容不能包含逗号）

说明：文件记录中应按照域名排序。

2.2. 黑白名单地址增量文件接口

1)接口说明：同步全网策略管理中心从上次数据同步后黑白名单地址的变更数据给节点策

略服务器。

2)同步时间：全网策略管理中心每天产生一次增量文件（时间间隔可设置，无数据改动时

可生成一个空文件），策略服务器自行控制获取基准文件的时间间隔。

3)文件命名：GURLYYYYMMDDNNN.TXT

◆GURL表示地址增量文件

◆YYYYMMDD表示文件产生的日期

◆NNN表示文件序列号，序列号每天重新开始编号，从000开始编号，到999后循

环。

4)文件规范

◆文件头（定长，总字节数：60Byte）

说明：文件记录中应按照域名排序。

◆文件体

文件体中每行为1条数据记录，由固定顺序的非定长字段组成，字段之间通过逗号分隔。

2.3. 基本控制策略基准文件接口

1)接口说明：同步全网策略管理中心的全部过滤关键字、过滤端口、过滤IP数据给节点

策略服务器。

2)同步时间：全网策略管理中心每天产生一次基准文件（时间间隔可设置，无数据改动时

可不生成文件），策略服务器自行控制获取基准文件的时间间隔。

3)文件命名：BPCYYYYYMMDDNNN.TXT

◆BPCY表示控制策略数据基准文件

◆YYYYMMDD表示文件产生的时间

◆NNN表示文件序列号，序列号每天重新开始编号，从000开始编号，到999后循

环。

4)文件规范

◆文件头（定长，总字节数：60Byte ）

◆文件体

文件体中每行为1条数据记录，由固定顺序的非定长字段组成，字段之间通过逗号分隔。数据记录之间通过换行符（\n）分隔。（每个字段的内容不能包含逗号）

2.4. 基本控制策略增量文件接口

5)接口说明：同步全网策略管理中心的过滤关键字、过滤端口、过滤IP增量数据给节点

策略服务器。

6)同步时间：全网策略管理中心每隔一定的时间产生一次增量文件（时间间隔可设置，无

数据改动时可不生成文件），策略服务器自行控制获取增量文件的时间间隔。

7)文件命名：BPCYYYYYMMDDNNN.TXT

◆GPCY表示控制策略数据基准文件

◆YYYYMMDD表示文件产生的时间

◆NNN表示文件序列号，序列号每天重新开始编号，从000开始编号，到999后循

环。

8)文件规范

◆文件头（定长，总字节数：60Byte ）

◆文件体

文件体中每行为1条数据记录，由固定顺序的非定长字段组成，字段之间通过逗号分隔。数据记录之间通过换行符（\n）分隔。（每个字段的内容不能包含逗号）

3.节点策略服务器与前置机的策略同步接口

全网策略管理中心将黑白名单地址数据、域名-IP对应关系数据、过滤关键字、过滤端口、过滤IP等控制策略数据以基准和增量文件方式同步给节点策略服务器，节点策略服务器将这些数据同步给其管辖范围内各个前置机。

节点策略服务器可自定义一些本地的控制策略，如过滤关键字、过滤端口、过滤IP等控制策略，这些控制策略仍以文件的形式同步给各个前置机。

节点策略服务器产生策略文件时，以IM接口协议方式实时通知前置机有新文件产生，前置机收到通知后主动以FTP方式登录策略服务下载文件。

1)文件通知通讯方式

◆通讯协议：IM

◆发送方：节点策略服务器

◆接收方：前置机

2)文件下载通讯方式：

◆通讯协议：FTP

◆发送方：节点策略服务器，作为FTP服务器。

◆接收方：前置机，作为FTP客户端。

3)文件管理

节点策略服务器给每个前置机开一个FTP帐号，前置机以FTP方式登录后，从本帐户的主路径下获取文件，前置机无权限删除远程主机上的文件。

3.1. 文件更新通知接口

文件名通知结构（ICS_FILE）定义：

3.2. 文件下载接口

前置机收到节点策略服务器的文件更新通知消息后，以FTP方式登录策略服务器，根据策略服务发送的文件名进行文件下载，需要同步的文件包括：

◆黑白名单地址基准文件

◆黑白名单地址增量文件

◆全局控制策略文件

◆本地控制策略文件

3.3. 节点本地的基本控制策略增量文件接口

1)接口说明：节点策略服务器可定义本地的过滤关键字、过滤端口、过滤IP等控制策略，

这些本地的控制策略数据以FTP方式同步给各个前置机。

2)同步时间：节点策略服务器每天产生一次策略增量文件（时间间隔可设置，如可设置为

有数据变动时生成策略文件。无数据改动时不生成文件），文件产生成功后策略服务器通知前置机下载文件进行处理。

3)文件命名：JBPCYYYYYMMDDNNN.TXT

◆JBPCY表示本地控制策略数据增量文件

◆YYYYMMDD表示文件产生的时间

◆NNN表示文件序列号，序列号每天重新开始编号，从000开始编号，到999后循

环。

4)文件规范

◆文件体

文件体中每行为1条数据记录，由固定顺序的非定长字段组成，字段之间通过逗号分隔。数据记录之间通过换行符（\n）分隔。（每个字段的内容不能包含逗号）

3.4. 本地域名-IP对应关系增量文件接口（可选）

1)接口说明：ICS用户通过自定义黑名单或白名单会产生一些域名地址，当这些域名在ICS

地址库中不存在时需要在本地定时维护域名与IP的对应关系。

2)同步时间：节点策略服务器每天产生一次增量文件（时间间隔可设置，无数据改动时生

成一个空文件）。

3)文件命名：JDIPYYYYMMDDNNN.TXT

◆JDIP表示节点本地的域名-IP对应关系增量文件

◆YYYYMMDD表示文件产生的时间

◆NNN表示文件序列号，序列号每天重新开始编号，从000开始编号，到999后循

环。

4)文件规范

◆文件头（定长，总字节数：60Byte）

◆文件体

文件体中每行为1条数据记录，由固定顺序的非定长字段组成，字段之间通过逗号分隔。

4.WEB门户与策略服务器接口

WEB门户（用户自服务门户与系统管理门户）与策略服务器之间目前主要有两种形式的数据接口：

◆数据更改通知接口：用户或管理员通过WEB门户更改（增、删、改）某些数据后，

将操作日志存放在表as_op_log中，然后以socket数据包的形式通知策略服务器，策略服务器收到通知消息后，从as_op_log表读取更改数据进行处理。

◆数据更新接口：对于某些特殊的操作，WEB门户不直接操作数据库，而是通过将数

据更新信息封装为Socket数据包发给策略服务器，由策略服务器对数据进行处理

后更新数据库记录。

4.1. 通知接口

4.1.1.用户数据更改通知（7036）

4.1.2.配置数据更改通知（7038）

4.1.3.防鲨网控制策略数据更改通知（7040）

4.2. 日志参数修改接口

4.2.1.修改日志配置参数（224）

4.3. 推送策略管理接口

struct push_policy_attr_t

{

unsigned char updFlag; /* 标志：0=添加/修改策略和参数 1=修改策略 */

unsigned int policyid; /* 策略编号（添加时填0）*/

unsigned char policyName[81]; /* 策略名*/

unsigned char policyType; /* 策略类型*/

unsigned char policyFlag; /* 策略归属*/

unsigned char globalFlag; /* 策略标志*/

unsigned char validFlag; /* 有效标志*/

unsigned char pageShowFlag; /* 弹出窗口类别*/

unsigned int pushInterval; /* 推送时间间隔*/

unsigned int policyPrio; /* 策略优先级*

unsigned int pushMaxTimes; /* 对所有用户总的最大推送次数*/

unsigned int pushUserTimes; /* 对单个用户总的最大推送次数*/

unsigned int pushDayMaxTimes; /*对所有用户一天的最大推送次数*/

unsigned int pushDayUserTimes; /*对单个用户一天的最大推送次数*/

unsigned char logFlag; /* 对该策略是否需要记Log */

unsigned char ackFlag; /* 应答标志 0: 不要应答 1，要应答*/

unsigned int applyTime[12]; /* 策略推送时间(12个月，每月31天） */

PUSH_POLICY_PARAM_INFO param; /*推送参数，单独修改策略时填空*/

} PUSH_POLICY_INFO;

struct push_policy_param_t

{

unsigned int policyParamId; /* 记录编号（添加时填0）*/

unsigned char paramName [65]; /* 名称*/

unsigned char paramType ; /* 参数类型*/

unsigned int maxWindow; /* 一次最多PUSH的窗口数*/

unsigned int maxRetry; /* 未响应的最大重试次数*/

unsigned int retryInterval; /* 未响应时重试的间隔时间*/

unsigned int policyInterval; /* 间隔时间（以秒为单位）*/

unsigned char urlHost[41]; /* 推送URL域名*/

unsigned char urlPath[81]; /* 推送URL路径*

unsigned char toolBarFlag; /* 是否显示工具栏*/

unsigned char locationFlag; /* 是否显示地址栏*/

unsigned char dirFlag; /* 是否显示链接栏*/

unsigned char statusFlag; /* 是否显示状态栏*/

unsigned char menuBarFlag; /* 是否显示菜单*/

unsigned char scrollBarFlag; /* 是否显示滚动条栏*/

unsigned char RESIZABLEFLAG; /* 是否允许改变窗口的大*/ unsigned int winWidth; /* 设定窗口的宽度*/

unsigned int winHeight; /* 设定窗口的高度*/

unsigned int winTop; /* 窗口和屏幕上边界的距离*/ unsigned int winLeft; /* 窗口和屏幕左边界的距离*/ unsigned char fullScreenFlag; /* 是否全屏幕*/ unsigned int urlParaNum; /* URL参数数量*/ unsigned char urlParam[5][21]; /* 参数值*/ unsigned char paramId[5]; /* 参数类型*/ } PUSH_POLICY_PARAM_INFO;

4.3.1.增加PUSH策略（150）

4.3.2.修改PUSH策略（178）

4.3.3.删除PUSH策略（176）

4.3.4.添加推送参数（192）

4.3.

5.修改推送参数（194）

4.3.6.删除推送参数（196）

4.4. 普通/专线用户管理

typedef struct client_user_info_t

{

unsigned char userType;

unsigned char userName[40];

unsigned char userTrueName[40];

unsigned char userSex;

unsigned char userEducational;

unsigned int localArea;

unsigned int userProvince;

unsigned int userCity;

unsigned short birthday[3];

unsigned char incoming;

unsigned char userJob;

char idCard[20];

char email[60];

char mphone[20];

char address[80];

char postId[10];

unsigned char urlLogFlag;

unsigned char linkType;

unsigned char reserved1[2];

unsigned char reserved2[4];

unsigned char userVocation;

unsigned int startIp; /* 起始IP */ unsigned int endIp; /* 终止IP */ unsigned char calledNum[18];

} CLIENT_USER_INFO

typedef struct group_user_info_t

{

unsigned int userId;

unsigned char matchStr[41];

unsigned char groupName[41];

unsigned int groupFlag;

unsigned int matchFlag;

unsigned char Remark[256]

}GROUP_USER_INFO;

中国移动BOSS系统接口规范(代理接入)

中国移动BOSS系统接口规范——代理接入部分 (Version 1.0) 中国移动通信集团公司 二○○一年八月

目录 1. 总则 (1) 1.1. 概述 (1) 1.2. 原则和目标 (1) 1.3. 适用范围 (2) 1.4. 起草单位 (2) 1.5. 解释权 (2) 2. 接入服务接口总体说明 (3) 2.1. 系统总体接口应用模型 (3) 2.2. 接口实现机制 (4) 2.3. 接口要求 (6) 3. 代理接口说明 (7) 3.1. 接口应用模型 (7) 3.2. 接口网络组织 (8) 3.2.1. 省中心网络接入 (8) 3.2.2. 地市中心网络接入 (9) 3.3. 接口安全控制 (10) 3.3.1. 安全评估 (10) 3.3.2. 访问控制 (11) 3.3.3. 入侵检测 (12) 3.3.4. 口令认证 (12) 3.3.5. 安全审计 (12) 3.3.6. 防（毒）恶意代码 (12) 3.3.7. 加密 (13) 3.3.8. 其他 (13) 3.4. 接口连接管理 (14) 3.4.1. 传输控制 (14) 3.4.2. 通讯服务 (14) 3.4.3. 动态资源管理 (15) 3.5. 接口逻辑管理 (16) 3.5.1. 数据管理 (16)

3.5.1.2. 数据压缩/解压 (16) 3.5.2. 优先级管理 (17) 3.5.3. 交换分发管理 (17) 3.5.4. 完整性管理 (18) 3.5.4.1. 实时交易业务 (19) 3.5.4.2. 批量传输业务 (19) 4. 接口服务详述 (20) 4.1. 业务受理 (20) 4.1.1. 功能界定 (20) 4.1.2. 开户 (21) 4.1.2.1. 业务描述 (21) 4.1.2.2. 接口服务 (21) 4.1.2.2.1. 开户初始接口服务 (21) 4.1.2.2.2. 客户身份检查接口服务 (21) 4.1.2.2.3. 客户信用度初始化接口服务 (21) 4.1.2.2.4. 客户建档接口服务 (22) 4.1.2.2.5. 资源查询接口服务 (22) 4.1.2.2.6. 套餐计划查询接口服务 (22) 4.1.2.2.7. 开户费用计算接口服务 (22) 4.1.2.2.8. 开户确认接口服务 (23) 4.1.2.2.9. 开户单据打印接口服务 (23) 4.1.2.2.10. 开户回退接口服务 (23) 4.1.3. 售不记名卡 (24) 4.1.3.1. 业务描述 (24) 4.1.3.2. 接口服务 (24) 4.1.3.2.1. 不记名卡查询接口服务 (24) 4.1.3.2.2. 不记名卡销售接口服务 (24) 4.1.3.2.3. 单据打印接口服务 (24) 4.1.3.2.4. 单据补打接口服务 (25) 4.1.3.2.5. 卡销售回退接口服务 (25) 4.1.4. 预销 (26) 4.1.4.1. 业务描述 (26) 4.1.4.2. 接口服务 (26)

系统需求规范模板

系统需求规范

编制：审核：批准：

目录 1.简介 (5) 1.1.系统简介 (5) 1.2.文档目的 (5) 1.3.文档范围 (5) 1.4.与其它开发任务/文档的关系 (5) 1.5.需求来源 (5) 1.6.需求编号原则 (5) 1.7.术语和缩写词 (6) 2.参考文档 (7) 3.系统定义 (8) 4.系统结构 (9) 5.功能需求规范 (10) 6.性能需求规范 (11) 7.RAM需求规范 (12) 8.系统安全目标 (13) 9.接口需求规范 (14) 10.系统应用环境 (15) 10.1.气候环境 (15) 10.2.海拔要求 (15) 10.3.防雷要求 (15) 10.4.机械环境 (15) 10.5.电气环境 (15) 10.6.非法访问的保护 (16) 10.7.更严酷的环境 (16) 11.假设及限制条件 (17)

1.简介 1.1.系统简介 提示：对系统进行简要介绍，包括系统的安全目标，安全评估的类型等。 1.2.文档目的 提示：阐明此文档的目的 系统需求规范将用户需求用规范的形式条目化列举出来，每个需求清晰、准确、具体并具备可验证性，是系统后续开发测试的基础。系统需求规范作为用户需求与项目人员沟通的文件，针对的对象主要是项目开发人员、测试人员。 这里的系统需求规范和系统定义阶段产生的系统定义文档比较类似，只是在定义阶段，需求可能是以描述形式体现用户的需求，而不是规范的形式。 1.3.文档范围 1.4.与其它开发任务/文档的关系 提示：如安全计划和设计文档的关系 1.5.需求来源 提示：说明需求规范的来源/产生方式（标准、规范、Subsets、环境、其他相关系统、接口、平台等）及相关证据，可以用图来说明。 1.6.需求编号原则 提示：给出需求编号的原则和定义。文档下面描述的所有需求都要按照这个原则给出编号。 {需求标识方法，如序列化编号、层次化编号、层次化文本标签等方法。应确

接口设计规范

目录 1接口类型 (2) 1.1人机接口 (2) 1.2软件-硬件接口 (2) 1.3软件接口 (2) 1.4通信接口 (2) 2接口设计规范 (2) 2.1基本内容 (2) 2.2规格说明 (3) 2.2.1人机接口 (3) 2.2.2软件-硬件接口 (3) 2.2.3软件接口 (3) 2.2.4通信接口 (3) 3接口设计文档提纲 (3)

1接口类型 1.1人机接口 人机接口是指计算机系统为完成人与机器之间互相传送信息而提供的功能的接口，包括硬件及程序。 1.2软件-硬件接口 软件-硬件接口是指软件系统中软件与硬件之间的接口。例如软件与接口设备之间的接口。 1.3软件接口 软件接口是软件系统中程序之间的接口。包括软件系统与其他系统或子系统之间的接口、程序模块之间的接口、程序单元之间的接口等。 1.4通信接口 通信接口是指处理机和标准通信子系统之间的接口。包括为实现数据通信用来完成接口功能的部件、装置及有关软件。 2接口设计规范 2.1基本内容 1、接口的名称标识 2、接口在该软件系统中的地位和作用 3、接口在该软件系统中与其他程序模块和接口之间的关系 4、接口的功能定义 5、接口的规格和技术要求，包括它们各自适用的标准、协议或约定 6、各个接口的数据特性 7、各个接口的资源要求，包括硬件支持、存储资源分配等 8、接口程序的数据处理要求

9、接口的特殊设计要求 10、接口对程序编制的要求 2.2规格说明 2.2.1人机接口 准确地说明人机接口的设计条件、设计特征、编程要求等技术内容。包括人机交互环境、人机接口部件、信息传输方式及传输特性、信息格式、数据处理、存储资源分配和程序编制要求等。 2.2.2软件-硬件接口 逐个描述每一个软件-硬件间接口的设计特性。包括接口硬件说明、接口功能说明、接口信息说明、接口处理方法、接口控制方式、接口时间特性、存储资源分配和程序编制要求等。 2.2.3软件接口 逐个说明本软件系统与其他软件系统间接口的设计特征。包括接口功能说明、接口约定、数据特性、数据处理方法、接口程序运行控制、接口时间特性、存储资源分配和程序编制要求等。 2.2.4通信接口 逐个描述各个通信接口的设计特性。包括硬件描述、接口功能说明、通信协议、报文处理、存储资源分配、程序接口设计和程序编制要求等。 3接口设计文档提纲 1概述........................................................................................................................................................... 错误！未定义书签。 1.1编写目的......................................................................................................................................... 错误！未定义书签。 1.2参考资料......................................................................................................................................... 错误！未定义书签。 1.3术语和缩写词................................................................................................................................ 错误！未定义书签。2软件系统综述......................................................................................................................................... 错误！未定义书签。3接口设计.................................................................................................................................................. 错误！未定义书签。 3.1接口框图......................................................................................................................................... 错误！未定义书签。 3.2接口一览表.................................................................................................................................... 错误！未定义书签。 3.3人机接口......................................................................................................................................... 错误！未定义书签。 3.4软件-硬件接口 .............................................................................................................................. 错误！未定义书签。

系统对接设计方案

系统对接设计 1.1.1 3、7、3 对接方式 系统与外部系统的对接方式以web service方式进行。 系统接口标准: 本系统采用SOA体系架构,通过服务总线技术实现数据交换以及实现各业务子系统间、外部业务系统之间的信息共享与集成,因此SOA体系标准就就是我们采用的接口核心标准。主要包括: 服务目录标准:服务目录API接口格式参考国家以及关于服务目录的元数据指导规范,对于W3C UDDI v2 API结构规范,采取UDDI v2 的API的模型,定义UDDI的查询与发布服务接口,定制基于Java与SOAP的访问接口。除了基于SOAP1、2的Web Service接口方式,对于基于消息的接口采用JMS或者MQ的方式。 交换标准:基于服务的交换,采用HTTP/HTTPS作为传输协议,而其消息体存放基于SOAP1、2协议的SOAP消息格式。SOAP的消息体包括服务数据以及服务操作,服务数据与服务操作采用WSDL进行描述。 Web服务标准:用WSDL描述业务服务,将WSDL发布到UDDI用以设计/创建服务,SOAP/HTTP服务遵循WS-I Basic Profile 1、0,利用J2EE Session EJBs 实现新的业务服务,根据需求提供SOAP/HTTP or JMS and RMI/IIOP接口。 业务流程标准:使用没有扩展的标准的BPEL4WS,对于业务流程以SOAP服务形式进行访问,业务流程之间的调用通过SOAP。 数据交换安全:与外部系统对接需考虑外部访问的安全性,通过IP白名单、SSL认证等方式保证集成互访的合法性与安全性。 数据交换标准:制定适合双方系统统一的数据交换数据标准,支持对增量的数据自动进行数据同步,避免人工重复录入的工作。 1.1.2 3、3、8接口规范性设计 系统平台中的接口众多,依赖关系复杂,通过接口交换的数据与接口调用必须遵循统一的接口模型进行设计。接口模型除了遵循工程统一的数据标准与接口

恒生公司ta与客服系统接口规范范本(doc 37页)

恒生公司ta与客服系统接口规范范 本(doc 37页) 部门： xxx 时间： xxx 整理范文，仅供参考，可下载自行编辑

登记过户系统与客户服务系统接口规范 文档修改记录

一、接口规范概述 1．用途 本接口规范仅描述登记过户系统给客户服务系统（包括CALL CENTER查询和网站查询）所提供数据的具体内容和形式。 2．数据处理规则为： (a)以文本文件定长记录方式提供数据； 约定：将来需要新增加的字段都增加在尾部，客服系统读记录时，不用校验记录的长度，以保持兼容。

(b)文件的第一行为数据的记录数 (c)最后一行为’END’ (d)文件数据体中，每行代表一条完整记录； (e)换行必须用回车（ODH）、换行（OAH）字符； (f)数据项类型，C:字符型；N:数字；A:字符型，填数字 (g)数字如是负数，第一位用’-‘表示，占用一个整数位 (h)数字左补零右对齐，字符右补空格左对齐； (i)带有小数点的数值型数据，传输时不传小数点；本接口中，没有特 别说明的，都表示2位小数。 (j)带下划线的字段为相应文件记录的主索引； 3．包括内容 本接口包含六个方面的数据：客户帐户信息、账户类确认数据、客户基金份额余额、客户交易流水（包括申请流水和确认流水）、基金分红信息和基金行情信息。 4．内容更新规则为： (a)每日由登记过户系统向客户服务系统提供一次数据； (b)每日所提供的数据仅表示截至到当日做完登记过户操作后的客户信 息和基金行情信息； (c)每次只提供变化（包括新增和更新）的数据；也可不定期提供全部 数据（文件名区分） 二、客户账户信息数据 1．数据生成规则： (a)客户帐户信息包括客户基本信息和基金帐号的登记信息两个方面的 内容，这两个方面的内容同步更新； (b)客户资料和客户的基金帐号资料合在一条记录里形成所谓“客户基 本信息”； (c)客户基本信息既支持新增客户记录模式又支持新增基金帐号记录模 式； (d)客户基本信息还支持修改已有记录模式，销户也算修改记录范畴；

个人信用信最新息基础数据库系统数据接口规范

1 前言 《企业信用信息基础数据库数据接口规范》（简称“数据接口规范”）规定了企业信用信息基础数据库与外部系统进行信息交换时应遵循的有关信息格式和数据管理规定，本文档分为六部分。 前言简介本规范各部分的内容。 报文规范规定了本规范中报文的基本概念、设计原则、数据处理原则、文件命名原则、报文文件的结构和种类。 数据采集要求规定了公积金管理中心提交数据的范围、频率以及文件传送方式。 公积金信息采集报文和公积金信息删除报文中规定了公积金中心向企业信用信息基础数据库报送采集报文和删除报文的具体数据项以及对数据项的描述和约束。 公积金信息反馈报文规定了企业信用信息基础数据库向公积金中心反馈内容的具体数据项以及对数据项的描述和约束。 附录包含公积金信息采集接口规范的代码表、数据校验规则。 本接口规范适用于与企业信用信息基础数据库进行报文交换的公积金机构及公积金部门的数据处理。文档的主要读者有：拟建系统用户、系统设计人员、系统编码人员、项目经理、系统测试人员、项目监理人员。 2 报文规范 2.1术语和定义 下列术语和定义适用于本规范。 2.1.1报文 由报文头、报文体构成的，按照一定规则组合起来的数据集合体。 2.1.2报文文件 包含报文的数据文件。 本规范中报文文件与报文是一对一的关系。 2.1.3段 一个已标识、命名和结构化的、在功能上相互关联的复合数据元和/或独立数据元的集合。段有各自固定的长度。 本规范中段为基础段。 2.1.4信息记录 数据采集的基本信息单位，包含报送机构一笔业务的有关数据。 本规范中的信息记录由基础段组成。 2.1.5报文头 每个报文必须包含且只包含一个报文头，报文头表示一次数据采集的开始，该部分给出本次采集数据的信息提要。 2.1.6报文体 报文体是数据采集报文的主体内容，报文体部分可包含一种或多种不同类型的信息记录，最后一条信息记录结束即为报文结束。 信息记录之间用一个回车换行符（“﹨r﹨n”或“﹨n”）分隔。 2.1.7信息记录 此信息记录由基础段组成。 每个信息记录包含且仅包含一个基础段。 信息记录的内容中不允许存在回车换行符（“﹨r﹨n”或“﹨n”）。 2.1.8基础段 基础段是由固定数据项按照一定次序排列组成的信息集合体。 2.2设计原则

接口文档规范

XXX接口说明书(版本：V1.0)

修订记录

1简介 1.1文档目的 接口文档是前端与后端交互密不可分的环节，接口的规范性会直接影响双方对接过程中的效率和质量。本着快速高效开发的目的性，避免对接过程中的错误率。 1.2接口规范 (1) 遵循RESTful API设计风格 (2) 数据格式采用json格式 (3) 返回统一结构数据 例如： 结构：data（数据）、errorCode（状态码）、msg（提示信息） { data:{}, // 数据类型不一定为object类型 errorCode:10001, msg:'' } (4) 枚举型参数应列举参数所有值及说明 例如： gender：性别（男：1，女：2） userInfo:{ name:'张三', age:23, gender:1 }

(5) 具有嵌套关系的参数应指明嵌套关系及子级数据结构例如： billList: 账单列表(父级) billList:[ { id:'001', billName:'测试数据', billStauts:1, address:'雁塔区' } ] (6) 返回参数数据类型保持一致性 例如： billList: 账单列表（有数据） billList:[ { id:'001', billName:'测试数据', billStauts:1, address:'雁塔区' } ] billList: 账单列表（无数据） billList:[] 返回的参数数据类型都为：array (7) 下拉及选择型数据以键值对的形式返回 例如： orderOperate：订单操作 orderOperate:[

HIS系统中各类卡接口应用设计说明

HIS系统中各类卡接口应用设计说明 1.卡应用结构 主应用：现有的作用模块都是主应用，在需要应用卡的应用程序中，留有卡的适当接口，比如“读卡”按钮，通过这样的接口（或者说是操作卡的收段）来调用“卡接口”中提供的调用函数实现对卡的各种操作； 卡接口：卡接口是一个程序模块，在这个模块中可以定义卡驱动的api函数给应用系统使用；定义函数wf_read()，wf_write()提供给“主应用”使用；函数wf_read()\wf_write()，调用卡驱动的api函数，根据不同卡的读写特点开发程序，主要是处理异常及读写流程； 读卡器驱动：读卡器驱动由其设备供应商提供，一般来说，各个厂商的读卡器驱动都不尽相同，所以每遇到一个不同厂商的设备后，首先需要详细了解产品及相关资料的情况；读卡器驱动一般是dll，其中打包了一系列的函数，这些函数是要在“卡接口”中定义声明使用的； 2.卡应用的数据基础 医院中应用卡，往往是要贯穿到各个业务部门科室，而卡，在这里仅仅起到“信息提示”的作用。由于卡存储容量及数据安全的原因，在卡中不会写过多的信息，主要记录的数据包括：病人ID，姓名等。要实现医院所有部门、科室实现一卡通，特别是门诊部门（因为住院部门的病人各种信息已经能够完整连贯），就要求在软件系统中能够保存、读取更多的数据，而且这些数据必须在病人就医过程中一直保存。 这样的数据就是卡应用的数据基础。 目前，我们可以卡应用的数据基础理解为“病人信息主索引”和MEDICAL_CARD_MEMO。 那么，在卡运作过程当中就要关注该数据信息：什么位置产生病人信息主索引？刷卡时如何调用该信息？数据保存到什么时候？门诊病人信息量大，连贯性不强，该如何处置？这些问题都应当同医院相关部门讨论清楚。

Q／GDW 622-2011 电力系统简单服务接口规范

电力系统简单服务接口规范 1范围 本标准提出了应用于电力系统的简单服务接口规范，以字符串方式描述面向服务消费者和服务提供者的语法、语义规则及服务调用接口规范。本规范适用于访问简单服务的应用场合。 2规范性引用文件 下列文件对于本文的应用是必不可少的。凡是注日期的引用文件，仅注日期的版本适用于本文件。凡是不注日期的引用文件，其最新版本（包括所有的修改单）适用于本文件。 GB/T 16262.1—2006：信息技术抽象语法记法一 (ASN.1) 第1部分:基本记法规范 Web Services Description Language (WSDL) 1.1 https://www.wendangku.net/doc/0815151289.html,/TR/wsdl.html：web服务描述语言 3术语和定义 下列术语和定义适用于本标准。 3.1 服务Service 服务提供者完成一组工作，为服务消费者交付所需的最终结果。最终结果通常会使使用者的状态发生变化，但也可能使提供者的状态改变，或者双方都产生变化。 3.2 服务消费者Service Consumer 根据服务接口描述访问服务的实体 3.3 服务提供者Service Provider 实现一定功能并提供访问接口描述的实体 3.4 WSDL Web服务描述语言（Web Service Description Language） 3.5 域Domain 电力系统中不同级别的调度机构 3.6 简单服务Simple Service 能够相对独立运行具有简单的输入参数和输出结果的应用 4符号定义和语法规范 4.1符号定义 WSDL是目前唯一的用于Web服务访问的工业标准，通过使用复杂的语法规则来实现服务的描述和访问。本规范参考了WSDL语言，提出了用于电力系统的简单服务接口规范，提供服务访问的功能并满足电力系统对效率的要求。表1是简单服务接口规范的符号定义，扩充了类型描述符、路径分隔符、

接口设计规范V1.0 - 参考

服务端与手机平台 接口协议 BespRout 2014年11月

文档修改/审批记录

目录 1.概述 (4) 2.涉及接口 (4) 3.接口总体要求 (4) 3.1.系统间接口的原则 (4) 3.2.处理流程 (4) 3.3.接口实现方式 (5) 4.XXX服务端接口 (5) 4.1.XX模块-根据XX下载相关的配置文件 (5) 4.2.XX模块-生成指定XX的文件配置 (6) 4.3.APP启动-初使化参数 (7) 5.附件 (8) 5.1.备注说明 (8)

1. 概述 本文档提供接口给手机端使用，为手机端提供业务平台数据 2. 涉及接口 本文档涉及的外围系统接口包括：无 3. 接口总体要求 3.1.系统间接口的原则 接口设计遵循如下原则： ?安全可靠性原则：系统应提供良好的安全性和可靠性策略，支持多种安全而 可靠的技术手段，制定严格的安全可靠的管理措施； ?开放性原则：提供开放式标准接口，提供与其它系统的互联互通； ?灵活性原则：提供灵活的接口设计，便于接口的变动。 ?可扩展性原则：支持新业务的扩展以及接口容量与接口性能的提高； ?可管理性原则：提供良好的管理机制，保证在运行过程中提供给管理员方便 的管理方式以处理各种情况； ?统一性原则：应当保证系统的接口方式、接口形式、使用的协议等标准、统 一。 3.2.处理流程 接口处理流程

3.3. 接口实现方式 手机APP 应用 与服务端采用基于HTTP 的REST 协议完成，数据传输默认为JSON 4. XXX 服务端接口 测试地址前缀: http://192.168.3.208:8088/xxx/xxx 4.1. XX 模块-根据XX 下载相关的配置文件

接口设计规范

目录 1 接口类型 (2) 1.1 人机接口 (2) 1.2 软件-硬件接口 (2) 1.3 软件接口 (2) 1.4 通信接口 (2) 2 接口设计规范 (2) 2.1 基本内容 (2) 2.2 规格说明 (3) 2.2.1 人机接口 (3) 2.2.2 软件-硬件接口 (3) 2.2.3 软件接口 (3) 2.2.4 通信接口 (3) 3 接口设计文档提纲 (3)

1接口类型 1.1人机接口 人机接口是指计算机系统为完成人与机器之间互相传送信息而提供的功能的接口，包括硬件及程序。 1.2软件-硬件接口 软件-硬件接口是指软件系统中软件与硬件之间的接口。例如软件与接口设备之间的接口。 1.3软件接口 软件接口是软件系统中程序之间的接口。包括软件系统与其他系统或子系统之间的接口、程序模块之间的接口、程序单元之间的接口等。 1.4通信接口 通信接口是指处理机和标准通信子系统之间的接口。包括为实现数据通信用来完成接口功能的部件、装置及有关软件。 2接口设计规范 2.1基本内容 1、接口的名称标识 2、接口在该软件系统中的地位和作用 3、接口在该软件系统中与其他程序模块和接口之间的关系 4、接口的功能定义

5、接口的规格和技术要求，包括它们各自适用的标准、协议或约定 6、各个接口的数据特性 7、各个接口的资源要求，包括硬件支持、存储资源分配等 8、接口程序的数据处理要求 9、接口的特殊设计要求 10、接口对程序编制的要求 2.2规格说明 2.2.1人机接口 准确地说明人机接口的设计条件、设计特征、编程要求等技术内容。包括人机交互环境、人机接口部件、信息传输方式及传输特性、信息格式、数据处理、存储资源分配和程序编制要求等。 2.2.2软件-硬件接口 逐个描述每一个软件-硬件间接口的设计特性。包括接口硬件说明、接口功能说明、接口信息说明、接口处理方法、接口控制方式、接口时间特性、存储资源分配和程序编制要求等。 2.2.3软件接口 逐个说明本软件系统与其他软件系统间接口的设计特征。包括接口功能说明、接口约定、数据特性、数据处理方法、接口程序运行控制、接口时间特性、存储资源分配和程序编制要求等。 2.2.4通信接口 逐个描述各个通信接口的设计特性。包括硬件描述、接口功能说明、通信协议、报文处理、存储资源分配、程序接口设计和程序编制要求等。 3接口设计文档提纲 1 概述 (2) 1.1 编写目的 (2) 1.2 参考资料 (2) 1.3 术语和缩写词 (2)

软件系统详细设计说明书模板

xxxxx系统详细设计说明书

版本历史

修改记录

目录 1引言 (5) 1.1编写目的 (5) 1.2背景 (5) 1.3参考资料 (5) 1.4术语定义及说明 (5) 2设计概述 (5) 2.1任务和目标 (5) 2.1.1需求概述 (5) 2.1.2运行环境概述 (5) 2.1.3条件与限制 (6) 2.1.4详细设计方法和工具 (6) 3系统详细需求分析 (6) 3.1详细需求分析 (6) 3.2详细系统运行环境及限制条件分析接口需求分析 (6) 4总体方案确认 (6) 4.1系统总体结构确认 (6) 4.2系统详细界面划分 (7) 4.2.1应用系统与支撑系统的详细界面划分 (7) 4.2.2系统内部详细界面划分 (7) 5系统详细设计 (7) 5.1系统程序代码架构设计 (7) 5.1.1UI(User Interface)用户界面表示层 (7) 5.1.2BLL(Business Logic Layer)业务逻辑层 (8) 5.1.3DAL(Data Access Layer)数据访问层 (8) 5.1.4Common类库 (8) 5.1.5Entity Class实体类 (8) 5.2系统结构设计及子系统划分 (8) 5.3系统功能模块详细设计 (9) 5.3.1XX子系统 (9) .1XX模块 (9) 列表和分页 (9) 创建XX (9) .2XX模块 (9) XX列表 (9) XX修改 (9) 5.3.2XX子系统 (9) 5.3.6.1用户管理模块 (9) 5.3.6.2角色管理模块 (14) 5.3.6.3系统设置模块 (14) 5.3.6.4系统登录注销模块 (14) 5.4系统界面详细设计 (14) 5.4.1外部界面设计 (14) 5.4.2内部界面设计 (14) 5.4.3用户界面设计 (14) 6数据库系统设计 (14) 6.1设计要求 (14) 6.2信息模型设计 (14) 6.3数据库设计 (14) 6.3.1设计依据 (14)

恒生公司ta与客服系统接口规范范本

登记过户系统与客户服务系统接口规范 文档修改记录

一、接口规范概述 1．用途 本接口规范仅描述登记过户系统给客户服务系统（包括CALL CENTER查询和网站查询）所提供数据的具体内容和形

式。 2．数据处理规则为： (a)以文本文件定长记录方式提供数据； 约定：今后需要新增加的字段都增加在尾部，客服系统读记录时，不用校验记录的长度，以保持兼容。 (b)文件的第一行为数据的记录数 (c)最后一行为’END’ (d)文件数据体中，每行代表一条完整记录； (e)换行必须用回车（ODH）、换行（OAH）字符； (f)数据项类型，C:字符型；N:数字；A:字符型，填数字 (g)数字如是负数，第一位用’-‘表示，占用一个整数位 (h)数字左补零右对齐，字符右补空格左对齐； (i)带有小数点的数值型数据，传输时不传小数点；本接 口中，没有特不讲明的，都表示2位小数。 (j)带下划线的字段为相应文件记录的主索引； 3．包括内容 本接口包含六个方面的数据：客户帐户信息、账户类确认数据、客户基金份额余额、客户交易流水（包括申请流水和

确认流水）、基金分红信息和基金行情信息。 4．内容更新规则为： (a)每日由登记过户系统向客户服务系统提供一次数据； (b)每日所提供的数据仅表示截至到当日做完登记过户操 作后的客户信息和基金行情信息； (c)每次只提供变化（包括新增和更新）的数据；也可不 定期提供全部数据（文件名区分） 二、客户账户信息数据 1．数据生成规则： (a)客户帐户信息包括客户差不多信息和基金帐号的登记 信息两个方面的内容，这两个方面的内容同步更新； (b)客户资料和客户的基金帐号资料合在一条记录里形成 所谓“客户差不多信息”； (c)客户差不多信息既支持新增客户记录模式又支持新增 基金帐号记录模式； (d)客户差不多信息还支持修改已有记录模式，销户也算 修改记录范畴； (e)基金帐号登记信息：只要某基金帐号下的账户登记信

信息系统数据接口管理办法

福建万鸿纺织有限公司信息系统数据接口管理办法 第一章总则 第一条为了规范公司信息系统数据接口申请、变更及故障处置管理流程，确保公司信息系统接口数据传递安全、准确、稳定、高效，特制定本管理办法。 第二条信息系统数据接口申请与变更是指因系统架构变化或者管理需求延伸时，需要增加或者修改现有信息系统数据接口的各种业务需求。 第三条信息系统数据接口故障处置是指信息系统运行过程中所出现的各种接口故障问题处理。 第四条本管理办法适用于ERP系统、OA、财务系统、外网网站等信息系统（下面简称信息系统）与其他生产、管理、控制系统（下面简称其他系统）之间的数据接口管理。 第二章管理职责及分工 第五条信息部职责 信息部是公司信息系统数据接口的归口管理部门，负责组织制定公司信息系统数据接口架构方案；负责审批各单位信息系统或者其他系统数据接口申请与变更并组织数据接口谈判、实施、测试与上线；负责收集与归档信息系统维护单位制定或者变更的接口文档；负责组织处置各类信息系统数据接口故障；负责信息系统或者数据接口故障时以及故障

后通知接口对应其他系统所属专业对管辖系统数据接口进行相应处置并组织数据追单；负责信息系统或者数据接口检修前、后通知相关其他系统所属专业对管辖系统数据接口进行相应处置并组织数据追单；负责接受相关其他系统所属专业关于其他系统检修、故障的通报，并组织信息系统维护单位对数据接口进行相应的处置。 第六条各相关单位职责 负责向信息部申请与变更本单位其他系统与信息系统的数据接口需求；负责协调其他系统数据接口实施方与信息部相关专业以及信息系统维护人员数据接口谈判、实施、测试与上线；在其他系统或者数据接口检修前后，负责通报信息部相关专业对相应信息系统数据接口进行处置并组织数据追单；在本单位其他系统或者数据接口故障后以及故障恢复后，负责通报信息部相关专业对相应信息系统数据接口进行处置并组织数据追单；负责接受信息部相关专业关于信息系统或者数据接口检修、故障的通知，并组织本单位系统维护人员对相关其他系统数据接口进行相应处置。 第七条信息系统维护单位职责 负责参与公司信息系统数据接口架构方案的制定，负责配合公司各单位信息系统数据接口需求申请与变更的谈判、实施、测试与上线，负责信息系统数据接口需求申请与变更实施后接口文档的制定与变更，并将数据接口新增与变更文

APP接口开发规范文档-V1.0

{ APP接口规文档}手机客户端接口文档

版本历史

目录 一、概述 (1) 1.1 有关接口 (1) 1.1.1接口是纯数据的交互 (1) 1.2 接口的分类 (1) 1.2.1查询类接口 (1) 1.2.2 操作类接口 (1) 1.2.3上传下载类接口 (1) 1.2.4推送类接口 (1) 二、查询类接口格式规 (1) 2.1获取单条对象信息 (1) 2.1.1 请求格式 (1) 2.1.2参数说明 (2) 2.1.3正常返回结果 (2) 2.2获取列表对象信息 (3) 2.2.1 请求格式 (3) 2.2.2参数说明 (3) 2.2.3正常返回结果 (3) 三、操作类接口 (4) 3.1 新增操作 (4) 3.1.1接口说明 (4) 3.1.2参数说明 (4) 3.1.3正常返回结果 (4) 3.1.4错误返回列表 (5) 3.2 修改操作 (5) 3.2.1接口说明 (5) 3.2.2参数说明 (5) 3.2.3正常返回结果 (5) 3.2.4错误返回列表 (5) 3.3 删除操作 (6) 3.3.1接口说明 (6) 3.3.2参数说明 (6) 3.3.3正常返回结果 (6) 3.3.4错误返回列表 (6) 四、上传下载类 (7) 4.1 上传文件 (7) 4.1.1接口说明 (7) 4.1.2参数说明 (7) 4.1.3正常返回结果 (7) 4.1.4错误返回列表 (7) 4.2 下载文件 (7) 4.2.1接口说明 (7)

4.2.2参数说明 (8) 4.2.3正常返回结果 (8) 4.2.4错误返回列表 (8) 五、推送类接口 (8) 5.1 推送消息 (8) 5.1.1接口说明 (8) 5.1.2参数说明 (8) 5.1.3正常返回结果 (9) 5.1.4错误返回列表 (9) 六、通用返回格式 (9) 6.1 正确返回 (9) 6.1.1接口说明 (9) 6.1.2参数说明 (9) 6.1.3正常返回结果 (9) 6.1.4错误返回列表 (10) 6.2 错误返回 (10) 6.2.1接口说明 (10) 6.2.2参数说明 (10) 6.2.3正常返回结果 (10) 6.2.4错误返回列表 (10) 七、附录 (11) 7.1 通用错误返回列表 (11) 7.2 URL地址信息 (11) 7.2.1 主机地址 (11) 7.2.2 URL列表 (11) 7.3 安全机制 (11) 7.3.1 验证签名机制 (11) 7.4 其他 (12) 7.2.1 列表数据为空的返回 (12)

系统对接设计方案

系统对接设计 1.1.1 3.7.3 对接方式 系统与外部系统的对接方式以web service方式进行。 系统接口标准： 本系统采用SOA体系架构，通过服务总线技术实现数据交换以及实现各业务子系统间、 外部业务系统之间的信息共享和集成，因此SOA体系标准就是我们采用的接口核心标准。主要包括： 服务目录标准：服务目录API接口格式参考国家以及关于服务目录的元数据指导规范， 对于W3C UDDI v2 API结构规范，采取UDDI v2 的API的模型，定义UDDI的查询和发布服务接口，定制基于Java和SOAP的访问接口。除了基于SOAP1.2的Web Service接口方式，对于基于消息的接口采用JMS或者MQ的方式。 交换标准：基于服务的交换，采用HTTP/HTTPS作为传输协议，而其消息体存放基于 SOAP1.2协议的SOAP消息格式。SOAP的消息体包括服务数据以及服务操作，服务数据和服务操作采用WSDL进行描述。 Web服务标准：用WSDL描述业务服务，将WSDL发布到UDDI用以设计/创建服务，SOAP/HTTP服务遵循WS-I Basic Profile 1.0，利用J2EE Session EJBs 实现新的业务服务，根据需求提供SOAP/HTTP or JMS and RMI/IIOP接口。 业务流程标准：使用没有扩展的标准的BPEL4WS，对于业务流程以SOAP服务形式进行访问，业务流程之间的调用通过SOAP。 数据交换安全：与外部系统对接需考虑外部访问的安全性，通过IP白名单、SSL认证等方式保证集成互访的合法性与安全性。 数据交换标准：制定适合双方系统统一的数据交换数据标准，支持对增量的数据自动进行数据同步，避免人工重复录入的工作。 1.1.2 3.3.8接口规范性设计 系统平台中的接口众多，依赖关系复杂，通过接口交换的数据与接口调用必须遵循统一的接口模型进行设计。接口模型除了遵循工程统一的数据标准和接口

系统需求规格说明书模板(结构化标准版)

走过，留下种种希望。啊，朋友，我们从人生的四季走过，将给人生留下些什么? （项目名称） 系统需求规格说明书 文件版本 编写日期 发布日期 没有落日般的瑰丽，没有流云般的飘逸，但可以有水晶般的清纯与透明。没有大山般的巍峨，没

走过，留下种种希望。啊，朋友，我们从人生的四季走过，将给人生留下些什么? 文件修改记录 *变化状态：C――创建，A——增加，M——修改，D——删除 文档审批信息 没有落日般的瑰丽，没有流云般的飘逸，但可以有水晶般的清纯与透明。没有大山般的巍峨，没

走过，留下种种希望。啊，朋友，我们从人生的四季走过，将给人生留下些什么? 目录 1概述 (1) 1.1目的 (1) 1.2预期读者 (1) 1.3背景（可选） (1) 1.4参考资料 (1) 1.5标准（可选） (1) 1.6术语定义 (1) 1.7图例说明 (1) 2系统描述 (1) 2.1现状综述 (1) 2.2系统目标 (1) 2.3目标系统概述 (2) 2.4范围 (2) 2.5系统假设/约定 (2) 2.6接口与界面 (2) 2.6.1外部接口(可选) (2) 2.6.2硬件接口 (2) 2.6.3软件接口 (2) 2.6.4通信接口(可选) (2) 2.6.5用户界面 (3) 3功能需求 (3) 3.1系统流程图 (3) 3.2功能一览表 (3) 3.3功能描述 (3) 3.3.1功能1 (3) 3.3.2功能n (4) 3.4公共功能描述 (4) 3.4.1功能1 (4) 3.5数据描述（可选） (4) 3.5.1业务数据描述 (4) 没有落日般的瑰丽，没有流云般的飘逸，但可以有水晶般的清纯与透明。没有大山般的巍峨，没

接口设计规范

接口设计规范 Prepared on 24 November 2020

目录 1接口类型 1.1人机接口 人机接口是指计算机系统为完成人与机器之间互相传送信息而提供的功能的接口，包括硬件及程序。 1.2软件-硬件接口 软件-硬件接口是指软件系统中软件与硬件之间的接口。例如软件与接口设备之间的接口。 1.3软件接口 软件接口是软件系统中程序之间的接口。包括软件系统与其他系统或子系统之间的接口、程序模块之间的接口、程序单元之间的接口等。 1.4通信接口 通信接口是指处理机和标准通信子系统之间的接口。包括为实现数据通信用来完成接口功能的部件、装置及有关软件。

2接口设计规范 2.1基本内容 1、接口的名称标识 2、接口在该软件系统中的地位和作用 3、接口在该软件系统中与其他程序模块和接口之间的关系 4、接口的功能定义 5、接口的规格和技术要求，包括它们各自适用的标准、协议或约定 6、各个接口的数据特性 7、各个接口的资源要求，包括硬件支持、存储资源分配等 8、接口程序的数据处理要求 9、接口的特殊设计要求 10、接口对程序编制的要求 2.2规格说明 2.2.1人机接口 准确地说明人机接口的设计条件、设计特征、编程要求等技术内容。包括人机交互环境、人机接口部件、信息传输方式及传输特性、信息格式、数据处理、存储资源分配和程序编制要求等。 2.2.2软件-硬件接口 逐个描述每一个软件-硬件间接口的设计特性。包括接口硬件说明、接口功能说明、接口信息说明、接口处理方法、接口控制方式、接口时间特性、存储资源分配和程序编制要求等。 2.2.3软件接口 逐个说明本软件系统与其他软件系统间接口的设计特征。包括接口功能说明、接口约定、数据特性、数据处理方法、接口程序运行控制、接口时间特性、存储资源分配和程序编制要求等。

系统详细设计说明书

XXXXXX XXXXXXXXXXXXX 项目名称 详细设计说明书 XXX公司 二〇XX年X月

文档修改记录

目录 第一章引言............................................. 错误!未定义书签。 目的............................................. 错误!未定义书签。 背景............................................. 错误!未定义书签。 术语定义......................................... 错误!未定义书签。 参考资料......................................... 错误!未定义书签。第二章系统概述......................................... 错误!未定义书签。第三章程序1设计说明................................... 错误!未定义书签。 程序描述......................................... 错误!未定义书签。 模块架构图 ................................... 错误!未定义书签。 功能 ......................................... 错误!未定义书签。 类图 ......................................... 错误!未定义书签。 增加功能（功能点） ........................... 错误!未定义书签。 程序流程 ..................................... 错误!未定义书签。 测试和限制条件 ............................... 错误!未定义书签。 备注 ......................................... 错误!未定义书签。第四章程序2设计说明................................... 错误!未定义书签。第五章公用接口程序说明................................. 错误!未定义书签。 全局变量......................................... 错误!未定义书签。 公用界面或接口................................... 错误!未定义书签。 公用方法和过程................................... 错误!未定义书签。第六章附件............................................. 错误!未定义书签。详细设计评审意见.......................................... 错误!未定义书签。