接口文档规范

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

修订记录

1简介

1.1文档目的

接口文档是前端与后端交互密不可分的环节，接口的规范性会直接影响双方对接过程中的效率和质量。本着快速高效开发的目的性，避免对接过程中的错误率。

1.2接口规范

(1)遵循RESTfulAPI设计风格

(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:[

{

label:'待开票'

value:1001

},

{

label:'回款'

value:1003

}

]

(8) “操作类型”的接口必须返回msg信息内容

(9)返回的展示型数据应具有可用性

例如：

createTime：生成时间（建议格式）

{

createTime:'2018-8-20 17:00:00'

}

建议：

由于前台处理数据能力较弱，故后台返回的数据尽可能便于前台使用。

2接口定义

2.1特殊接口

2.1.1获取服务器sessionKey

接口标识：

接口地址：https://https://www.sodocs.net/doc/861470273.html,/api/GetSessionKey 请求方式：POST

请求参数：

输出参数：

返回示例值:

{

data:'123456',

errorCode:100,

msg:''

}

2.2通用接口

2.2.1账单列表

接口标识：

接口地址：https://https://www.sodocs.net/doc/861470273.html,/api/billList 请求方式：POST

请求参数：

返回参数：

返回示例值:

{

data:[

{

id:'1',

gender:2,

invoiceTitle:'帝国快运',

address:'陕西省西安市雁塔区科技路24号', billList:[

{

id:'001',

billName:'测试数据',

billStauts:1,

address:'雁塔区'

},

{

id:'002',

billName:'测试数据02',

billStauts:1,

address:'高新区'

}

],

userInfo:{

name:'张三',

age:23,

gender:1

}

},

{

id:'2',

gender:1,

invoiceTitle:'圆通快递',

address:'陕西省西安市雁塔区科技路24号', billList:[

{

id:'003',

billName:'测试数据',

billStauts:1,

address:'雁塔区'

},

{

id:'004',

billName:'测试数据02', billStauts:2,

address:'高新区' }

],

userInfo:{

name:'张三', age:23,

gender:1

}

}

],

errorCode:10001,

msg:''

}

接口设计规范

目录 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软件-硬件接口 .............................................................................................................................. 错误！未定义书签。

中国移动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)

计算机联锁接口设计规范

计算机联锁接口设计规 编写— 审核—___________ 版本—___________ 日期—____年___月___日

一、总则 (4) 二、采集、驱动信息说明 (5) (一)、基本采集信息： (5) (二)、特殊采集信息： (11) (三)、基本驱动信息： (12) (四)、防护用特殊驱动信息： (15) 三、需告知的容说明 (18) (一)、轨道停电 (18) (二)、引导总锁闭 (18) (三)、发车方向继电器 (18) (四)、接近延长 (18) (五)、点灯电路 (20) 四、计算机联锁系统与站各种电路结合说明。 (23) （一）、64D半自动闭塞 (23) （二）、四线制自动闭塞 (26) （三）、场间联系 (29) （四）、站间联系 (31) （五）、道口通知 (33) （六）、机务段联系 (35) （七）、推峰进路 (37) （八）、编发线与驼峰照查电路 (39)

（九）、非进路调车 (40) （十）、溜放 (41) （十一）、坡道延续进路 (42) （十二）、到发线出岔 (42) （十三）、局控道岔 (42) （十四）、跨场进路 (43) （十五）、与编组场衔接道岔照查电路 (45) 一、总则 为适应铁路运输生产安全的需要，提高计算机联锁厂家与沟通、配合的效率，并减少因沟通不充分而产生的人为错误，因此，需要统一计算机联锁系统接口设计标准。 本规适用于与继电电路结合的计算机联锁系统的接口设计，不适用于全电子联锁系统。 由于不同的联锁厂家对各自联锁系统会有一些特殊要求，所以本规中所列举的采集、驱动信息可能不能做到全部体现，故还需与相应联锁厂家进行必要的沟通。 不同型号的联锁系统与站各种电路结合时，对继电器的驱动时机可能会有不同，本规中所述为铁科院联锁系统的情况，其他联锁系统的具体情况还需与相应联锁厂家沟通。

信息技术之会计核算软件数据接口规范

国家标准《信息技术会计核算软件数据接口》（征求意见稿） 编制讲明 一、任务来源 国家标准化治理委员会2002年下达的国家标准项目打算中，列入了《信息技术会计核算软件数据》（编号为20020389—T—424 ）；2004年国家标准化治理委员会又下达《关于调整信息技术会计核算软件数据国家标准打算项目的复函》（标委办函[2004]6号），明确由中华人民共和国审计署、中华人民共和国财政部作为主管部门，组织《信息技术会计核算软件数据》的起草单位和相关单位，承担《信息技术会计核算软件数据接口》国家标准的制定。 二、要紧工作过程 2002年3月上海市技术监督局制定了《信息技术会计核算软件数据接口规范》，并作为地点标准。2002年依照国家标准项目打算中编号为20020398—T—424的国家标准打算项目《信息技术会计核算软件数据》，上海市技术监督局组织相关单位和专家进行该标准的起草工作，于2003年底提出了《信息技术会计核

算软件数据接口规范》国家标准草案文本。 审计署依照工作需要，自1999年以来开展了“会计核算软件数据接口”方面的研究和实践。经国家电子政务治理委员会、国务院信息化工作办公室批准，审计署于2002年2月开始组织研究编写《会计核算软件数据接口》国家标准，于2003年底提出标准草案文本。 2004年2月，依照国家标准化治理委员会“标委办函[2004]6号”—“关于调整《信息技术会计核算软件数据》国家标准打算项目的复函”的精神，审计署计算中心召集上海《信息技术会计核算软件数据》标准起草组成员，审计署南京特派员办事处、南京审计学院等相关专家与人员，在北京对上述两个标准草案文本进行了深入细致的分析研究，综合整理提出了《信息技术会计核算软件数据接口规范（企业、事业单位）（草案稿）》。 2004年3月，依照国家标准化治理委员会关于“要符合国家标准撰写格式及语言规范；要使用数据元素表示；会计核算软件数据输出文件要有文本和XML格式”的要求，组织审计署计算技术中心、财政部会计司、审计署南京特派员办事处、信息产业部电子标准化所、用友公司、金算盘公司、浪潮公司等相关人员共同研究，编制出《信息技术会计核算软件数据接口（征求意见

接口文档规范

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:[

数据交换接口规范

附件4：数据交换接口规范 一、概述 计量器具检定数据交换接口采用Web service作为数据传输机制，是自包含、自描述（WSDL）、模块化的应用，由省局发布、定位、各技术机构通过web方式调用。接口基于标准的互联网协议，支持超文本传输协议(HTTP)和XML。与省局交换的数据都封装成XML格式的文件，传输前以GZIP格式将文件压缩，然后设置BASE64编码，最后在接收端将其解压，解析读取数据。 二、软件准备 JDK1.6，tomcat6.0，Web service相关包以及数据库。三、数据交换示意图 四、服务端接收数据过程 1、用户合法性校验：服务端在接收数据时同样需要进行用户合法性 校验，并返回信息。

2、数据封装：为方便数据传输和解析，客户端通过Web service交 换的数据需要封装成可扩展标记语言XML的规范，并严格按照此规范。 3、数据压缩：为提高数据的传输效率和减小传输的数据量，客户端 在传输之前需将数据以GZIP格式进行压缩，并设置BASE64位编码，以便基于HTTP传输。 4、对上传文件进行规范性校验：服务端在接收数据之前，校验客户 端数据是否按照XML规范要求，并按GZIP格式进行压缩，设置BASE64编码，否则返回不合法文件格式。 5、返回结果：服务端进行完校验，解析成功并反馈给业务系统后， 会反馈成功信息给客户端，如不成功则返回不成功。 五、客户端接收数据过程（与服务端接收过程类似。） 六、术语说明

THANKS !!! 致力为企业和个人提供合同协议，策划案计划书，学习课件等等 打造全网一站式需求 欢迎您的下载，资料仅供参考

华为逻辑电平接口设计规范

Q/DKBA 深圳市华为技术有限公司技术规范 错误！未定义书签。Q/DKBA0.200.035-2000 逻辑电平接口设计规范

2000-06-20发布 2000-06-20实施深圳市华为技术有限公司发布

本规范起草单位：各业务部、研究技术管理处硬件工程室。 本规范主要起草人如下：赵光耀、钱民、蔡常天、容庆安、朱志明，方光祥、王云飞。 在规范的起草过程中，李东原、陈卫中、梅泽良、邢小昱、李德、梁军、何其慧、甘云慧等提出了很好的建议。在此，表示感谢！ 本规范批准人：周代琪 本规范解释权属于华为技术有限公司研究技术管理处硬件工程室。 本规范修改记录：

目录 1、目的 5 2、范围 5 3、名词定义 5 4、引用标准和参考资料 6 5、TTL器件和CMOS器件的逻辑电平8 5.1：逻辑电平的一些概念8 5.2：常用的逻辑电平9 5.3：TTL和CMOS器件的原理和输入输出特 性9 5.4：TTL和CMOS的逻辑电平关系10 6、TTL和CMOS逻辑器件12 6.1：TTL和CMOS器件的功能分类12 6.2：TTL和MOS逻辑器件的工艺分类特点13 6.3：TTL和CMOS逻辑器件的电平分类特点13 6.4：包含特殊功能的逻辑器件14 6.5：TTL和CMOS逻辑器件的选择15 6.6：逻辑器件的使用指南15 7、TTL、CMOS器件的互连17 7.1：器件的互连总则17 7.2：5V TTL门作驱动源20 7.3：3.3V TTL/CMOS门作驱动源20 7.4：5V CMOS门作驱动源20 7.5：2.5V CMOS逻辑电平的互连20 8、EPLD和FPGA器件的逻辑电平21 8.1：概述21 8.2：各类可编程器件接口电平要求21 8.3：各类可编程器件接口电平要求21 8.3.1：EPLD/CPLD的接口电平21 8.3.2：FPGA接口电平25 9、ECL器件的原理和特点35 9.1：ECL器件的原理35 9.2：ECL电路的特性36 9.3：PECL/LVPECL器件的原理和特点37 9.4：ECL器件的互连38 9.4.1：ECL器件和TTL器件的互连38 9.4.2：ECL器件和其他器件的互连39 9.5：ECL器件的匹配方式39 9.6：ECL器件的使用举例41 9.6.1：SYS100E111的设计41 9.6.2：SY100E57的设计42 9.1：ECL电路的器件选择43 9.2：ECL器件的使用原则43

税控发票开票软件发票信息数据接口规范V4.0

税控发票开票软件发票信息 数据接口规范V4.0 1概述 为进一步优化纳税服务，满足纳税人内部管理信息系统与增值税发票税控开票软件的衔接需要，国家税务总局下发了税控发票开票软件发票信息数据接口规范V1.0、V2.0、V3.0版。随着增值税发票管理新系统的全国推广和营改增的全面实施，公布的接口已经不能满足需要，现对该接口进行更新升级，形成V4.0版。 本接口规范适用于是增值税发票税控开票软件（金税盘版）与增值税发票税控开票软件（税控盘版）的商品编码版本（以下统一简称为税控发票开票软件），配合手工导入开具、自动导入开具和发票明细导出功能使用。 2接口说明 2.1待开发票信息导入接口 通过税控发票开票软件中的手工导入开具和自动导入开具功能，将待开发票的信息批量导入到税控发票开票软件，完成发票开具。 选择手工导入开具时，首先选择要导入的XML文件，再对导入发票信息逐张开具并打印发票。

选择自动导入开具时，首先设置文件存储路径和轮询时间。自动导入开具功能开启后，系统自动轮询指定路径下的XML文件，自动完成发票开具，并将开具结果写入指定文件目录。 2.2已开发票信息导出接口 通过税控发票开票软件中的发票明细导出功能，实现已开发票信息的批量导出，生成EXCEL文件或XML文件。 3接口定义 本接口规范内容包括待开发票信息导入接口和已开发票信息导出接口，发票类型为增值税专用发票、增值税普通发票、货物运输业增值税专用发票、机动车销售统一发票和二手车销售统一发票。3.1增值税专用发票和增值税普通发票 3.1.1修改说明 单据新增了Version节点，增加商品编码功能后的版本为2.0； 单据新增了Spbmbbh节点，增加商品编码功能后为税局下载的商品编码表版本号； 单据新增了Hsbz节点，用于区分营改增新增的5%不含税税率和中外合作油气田（原海洋石油）5%税率、1.5%税率、差额税； 单据商品明细中新增了Spbm（商品编码）、Qyspbm（企业商品编码）、Syyhzcbz（享受优惠政策）、Lslbz（零税率标识）、Yhzcsm

共享平台API接口规范文档V0.7s

共享平台API接口规范 版本: 0.7s 携程旅行网

目录 1.前言 (4) 1.1功能描述 (4) 1.2阅读对象 (4) 1.3业务术语 (4) 1.4技术服务............................................................................................................... 错误!未定义书签。 2.接口参数说明 (5) 2.1普通政策请求参数 (5) 2.2特惠政策请求参数 (5) 2.3特价政策请求参数 (16) 3.示例Xml请求 (16) 3.1普通政策 (16) 3.2特惠政策 (16) 3.3特价政策 (19) 4.错误代码整理 (21) 4.1错误代码规则说明 (21) 4.2错误固定标识及错误代码分类说明 (21) 4.3目前已知错误代码列表 (21)

版本历史

1.前言 1.1 功能描述 为了提高代理商在携程网的政策投放效率，满足其业务需求，由携程机票研发部门开发了一套代理商政策导入接入API。本文档是为了描述相应的接口规范。 1.2 阅读对象 面向具有一定技术实力的代理商公司相应的技术人员 1.3 业务术语 1.4 接口API导入必读 API导入入口： https://www.sodocs.net/doc/861470273.html,/Flight-Product-TradeAPI/PolicyWS.asmx

接口参数： username: 用户名 password: 密码（格式: MD5(UTF-8(“username#password”)）) execType: 执行类型，只支持FullADD(全量上传), ADD(增量上传) gzipRequestBytes: 请求报文字节数组，是对报文进行GZIP后产生的字节流 接口响应格式：返回的是对报文GZIP后的base64位格式的文本编码 目前每日最大请求次数是500次 1.5 技术服务 前期请直接联系相应的票台关联业务人员 2.接口参数说明 2.1 普通政策请求参数

接口设计规范

目录 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)

接口设计规范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 具体需求 功能需求 功能需求1 对于每一类功能或者有时对于每一个功能，需要具体描述其输入、加工和输出的需求。由四个部分组成： a．引言 描述的是功能要达到的目标、所彩的方法和技术，还应清楚说明功能意图的由来 和背景。 b．输入 1)详细描述该功能的所有输入数据，如：输入源、数量、度量单位、时间设定、 有效输入范围（包括精度和公差）； 2)操作员控制细节的需求。其中有名字、操作员活动的描述、控制台或操作员的 位置。例如：当打印检查时，要求操作员进行格式调整； 3)指明引用接口说明或接口控制文件的参考资料。 c．加工 定义输入数据、中间参数，以获得预期输出结果的全部操作。它包括如下的说明： 1)输入数据的有效性检查； 2)操作的顺序，包括事件的时间设定； 3)响应，例如，溢出、通信故障、错误处理等； 4)受操作影响的参数； 5)降级运行的要求； 6)用于把系统输入变换成相应输出的任何方法（方程式、数学算法、逻辑操作等）； 7)输出数据的有效性检查。 d．输出 1)详细描述该功能所有输出数据，例如：输出目的地、数量、度量单位、时间关

系、有效输出的范围（包括精度和公差）、非法值的处理、出错信息； 2)有关接口说明或接口控制文件的参考资料。 此外，对着重于输入输出行为的系统来说，需求说明应指定所有有意义的输入、 输出对及其序列。当一个系统要求记忆它的状态时，需要这个序列，使得它可以 根据本次输入和以前的状态作出响应。也就是说，这种情况犹如有限状态机。 功能需求2 ．．．．．． 功能需求n 外部接口需求 用户接口 提供用户使用软件产品时的接口需求。例如，如果系统的用户通过显示终端进行操作，就必须指定如下要求： a．对屏幕格式的要求； b．报表或菜单的页面打印格式和内容； c．输入输出的相对时间； d．程序功能键的可用性。 硬件接口 要指出软件产品和系统硬部件之间每一个接口的逻辑特点。还可能包括如下事宜：支撑什么样的设备，如何支撑这些设备，有何约定。

中国财务软件数据接口标准(DOC7)

中国财务软件数据接口标准(DOC7) 编者按:标准应该是衡量事务的准则。标准的制定一样都由国际/国家有关标准机构或行业主管部门完成。但一些行业的生产厂商为了爱护用户的投资,促进行业有序进展,也按照本行业的特点,联合起来制定了一些大伙儿认可并共同遵守的规范,这种做法在国外已被广泛采纳。随着中国改革开放的深入,国内一些行业的厂家也开始进行这方面的探究,本期我们刊登的《中国财务软件数据接口标准》确实是由该财务软件行业的民间组织——中国软件行业协会财务及企业治理软件分会制定的,起草者为闻名财务软件厂商深圳金蝶公司。 一、背景 目前,国内财务软件众多,它们采纳的数据库平台和数据库结构各不相同,不同财务软件之间的数据交换,因为数据库平台和结构不同而产生许多困难,几乎任意两个不同软件之间要实现数据传递都会存在专门的数据转换咨询题。烦琐的数据转换工作白费了大量人力和物力,同时也阻碍了财务软件产业的健康进展。国内财务软件的商业化差不多比较成熟,各财务软件公司都有一批用户。由于各种缘故,一些用户期望从一个软件交叉升级为另一软件。由于用户在旧软件上已做了大量的工作,必定期望升级后原有数据能移植到新的软件中,然而有些软件的数据文件通过加密或数据库结构未公布,要从中直截了当读取数据几乎不可能。为了爱护用户已付出的劳动,各财务软件需要提供一个标准的数据输入输出接口。如此,建立一个公用的数据交换标准是专门必要的。 用户在使用财务软件时,有一些需求通过财务软件本身是难以实现的,如:用户期望把会计报表通过电子表格软件处理输出为各种专门形式;另一些高级用户,则期望在其它治理软件中能取到财务数据。这些数据交换工作都需要有一个标准的数据接口来规范。财务会计通过长期的进展已形成一定的理论,财务会计工作也有规范可循,国内财务软件是在这些理论和规范的基础上开发出来的,各软件储存财务数据的模式也大同小异。财务数据要紧按会计科目、凭证、余额及发生额、报表几个部分分块储备,它们之间既

通用接口标准规范v1

接口标准规范 目录 接口标准规范 (1) 第1章概述 (3) 第2章基本要求 (4) 2.1信息通讯安全 (4) 2.1.1 安全评估 (4) 2.1.2 访问控制 (4) 2.1.3 防恶意代码 (4) 2.1.4 加密 (5) 2.2支持高并发 (6) 2.3可监控 (6) 2.3.1 日志全覆盖 (6) 2.4系统资源的动态扩展 (6) 2.5异常处理机制 (7) 2.6业务扩展 (7) 第3章接口通讯方式 (7) 3.1同步请求/应答方式 (7) 3.2异步请求/应答方式 (7) 3.3会话方式 (7) 3.4广播通知方式 (7) 3.5事件订阅方式 (7)

3.7可靠消息传输 (8) 第4章传输控制要求 (8) 4.1负载均衡 (8) 4.2伸缩性与动态配置管理 (8) 4.3网络调度 (9) 4.4充分理由 (9) 4.5单一职责 (9) 4.6高内聚低耦合 (9) 4.7状态及消息 (10) 4.8控制数据量 (10) 4.9禁止随意拓展参数 (10) 第5章接口技术 (10) 第6章接口规范 (11) 6.1域名规范 (11) 6.1.1 http接口 (11) 6.1.2 webservice接口 (11) 6.2 API路径规范 (11) 6.2.1 http接口 (11) 6.2.2 webservice接口 (11) 6.3版本控制规范 (12) 6.3.1 http接口 (12) 6.3.2 webservice接口 (12) 6.4 API命名规范 (12) 6.4.1 新增方法 (13) 6.4.2 删除方法 (13) 6.4.3 修改方法 (13) 6.4.4 获取方法 (13) 6.4.5 获取列表方法 (13)

主要用能单位上传数据接口规范

附件2 武汉市节能智慧管理系统 数据接口规范 武汉市发展和改革委员会 2013年12月

前言 为指导我市各级节能智慧管理系统建设，市发改委组织有关专家，以我国现行相关标准为依据，结合我市节能智慧管理系统建设、验收和运行管理要求，研究制定了本数据接口规范。 本规范包括主要用能单位上传数据接口标准规范和市区各级系统上传数据接口标准规范两部分，其中两部分包括了接口的标准应用范围、接口的实现、接口的要求、术语和定义和基本原则。 本规范由市发改委负责管理和解释。

目录 1. 主要用能单位上传数据接口规范 (5) 1.1标准应用范围 (5) 1.2术语和定义 (5) 1.3基本原则 (5) 1.4接口实现 (6) 1.4.1数据提供方 (6) 1.4.2数据接收方 (6) 1.4.3接口的实现方式 (7) 1.4.4传输方式 (7) 1.4.5传输协议 (7) 1.4.6传输过程 (7) 1.4.7编码原则 (8) 1.4.8接口的验证方式 (8) 1.4.9使用策略 (9) 1.5接口数据的要求及保障 (9) 2. 区分系统上传数据接口规范 (10) 2.1标准应用范围 (10) 2.2术语和定义 (10) 2.3基本原则 (10) 2.4接口实现 (11)

2.4.1数据提供方 (11) 2.4.2数据接收方 (12) 2.4.3接口的实现方式 (12) 2.4.4传输方式 (12) 2.4.5传输协议 (12) 2.4.6传输过程 (12) 2.4.7编码原则 (13) 2.4.8接口的验证方式 (13) 2.4.9使用策略 (14) 2.5接口数据的要求及保障 (14) 附录1 数据采集器身份认证过程和数据加密 (15) 附录2 数据采集器或子系统和市数据中心通信过程 (16) 附录3 数据传输的XML数据格式 (17)

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 说明 本文档是关于……，要求……。已达到……目的。 2 参考页面 第一步 客户端首先要设置web service的连接地址、用户名和密码三项。远程地址固定为：http://124.133.54.21/services/DataService。用户名和密码为省总队分配。 参考界面如下： 帐号：3702-00-01 密码:

第二步 企业填报自己月报数据然后提交。 第三步 市级用户审核企业提交的月报数据。 第四步 市级进入提交审核页面。审核通过的企业将在“企业列表”中显示。将企业选择进“已选企业”。然后点击“上传至省平台”按钮。操作完成。 参考界面如下：

附件2： 山东省节能信息系统数据导入接口协议 1 简介 本协议用于山东省节能信息系统与通过API接入山东省节能信息系统的客户端的数据传输通讯。两者的数据传输通讯采用TCP协议、短连接方式，山东省节能信息系统为服务器方。 缩略语清单： client ：所有通过Web Service接口接入山东省节能信息系统的客户端2 Web Service接口说明 2.1 山东省节能信息系统Web Service地址 WSDL：http://124.133.54.21/services/DataService?wsdl

地址：http://124.133.54.21/services/DataService 2.2 接口说明 2.2.1 i mportYearReportData方法 public String importYearReportData( String loginName, String loginPwd, String cityCode, int year, String reportData) 方法说明： 从各地市系统上传本市已经审核确认的企业年报数据到省系统，如果省系统中企业当年年报数据还未上传过，则添加年报数据，如果年报数据已经上传过，则更新已上传年报数据。 返回值定义：第一行为错误代码，其他行为调用失败时的详细错误信息 ok：数据导入成功 invalidate-city：错误的地市编码 invalidate-date：错误的年份 invalidate-user：访问用户不可用 not-allow-op：用户没有操作权限 illegal-report-data：不合法的报表数据格式 error-report-style：错误的报表样式 error-verify-relations：错误的校验关系 2.2.2 i mportMonthReportData方法 public String importMonthReportData( String loginName, String loginPwd,

联锁接口设计

计算机联锁接口设计规范 编写— 审核—___________ 版本—___________ 日期—____年___月___日

历史记录

一、总则 (4) 二、采集、驱动信息说明 (5) (一)、基本采集信息： (5) (二)、特殊采集信息： (8) (三)、基本驱动信息： (10) (四)、防护用特殊驱动信息： (12) 三、设计院需告知的内容说明 (14) (一)、轨道停电 (14) (二)、引导总锁闭 (14) (三)、发车方向继电器 (14) (四)、接近延长 (14) (五)、点灯电路 (15) 四、计算机联锁系统与站内各种电路结合说明。 (17) （一）、64D半自动闭塞 (17) （二）、四线制自动闭塞 (19) （三）、场间联系 (21) （四）、站间联系 (22) （五）、道口通知 (24) （六）、机务段联系 (25) （七）、推峰进路 (27) （八）、编发线与驼峰照查电路 (29) （九）、非进路调车 (29) （十）、溜放 (30) （十一）、坡道延续进路 (30) （十二）、到发线出岔 (31) （十三）、局控道岔 (31) （十四）、跨场进路 (32) （十五）、与编组场衔接道岔照查电路 (33)

一、总则 为适应铁路运输生产安全的需要，提高计算机联锁厂家与设计院沟通、配合的效率，并减少因沟通不充分而产生的人为错误，因此，需要统一计算机联锁系统接口设计标准。 本规范适用于与继电电路结合的计算机联锁系统的接口设计，不适用于全电子联锁系统。 由于不同的联锁厂家对各自联锁系统会有一些特殊要求，所以本规范中所列举的采集、驱动信息可能不能做到全部体现，故还需设计院与相应联锁厂家进行必要的沟通。 不同型号的联锁系统与站内各种电路结合时，对继电器的驱动时机可能会有不同，本规范中所述为铁科院联锁系统的情况，其他联锁系统的具体情况还需设计院与相应联锁厂家沟通。 本规范分为以下几个具体部分： （一）、采集、驱动信息说明； （二）、设计院需告知的内容说明； （三）、计算机联锁系统与站内各种电路结合说明。