当前位置：搜档网 › 接口文档说明示例

接口文档说明示例

支付网关说明文档by:Q294500001

##联盟支付网关说明文档..................................................................... 错误！未定义书签。目录 .. (1)

第一章文档描述........................................................................................... 错误！未定义书签。

1、文档说明 (1)

2、阅读对象 (1)

第二章系统原理 (2)

1、术语定义 (2)

2、消费流程 (2)

3、查询流程 (2)

4、系统加密 (2)

第三章网银接口定义 (3)

1、同步过程接口定义（商户系统发起请求） (3)

2、下行异步通知过程接口定义（##联盟接口发起请求） (5)

3、下行同步通知过程接口定义（##联盟接口发起请求） (7)

第四章查询流程接口定义 (8)

第五章订单外部查询独立网址................................................................... 错误！未定义书签。附录1：##联盟支付网关银行类型说明. (9)

第一章文档描述

1、文档说明

本说明文档用于指导##联盟商户实现与##联盟网银接口的顺利对接。请相关技术人员详细阅读本文档。

2、阅读对象

商户开发人员。

第二章系统原理

1、术语定义

商户：指已独立拥有在线销售系统，并成为##联盟网银接口系统会员，且已使用或者将使用##联盟网银接口实现收付费或其他相关功能需求的企业或者个人。

外部接入接口：指##联盟通过统一的方式接受外部请求的接口。

商户系统：指使用##联盟外部接入接口的计算机系统，一般指商户所拥有的在线销售系统。

用户：指在商户系统内进行消费的企业或者个人。

商户ID：指##联盟为使用外部接入接口的商户统一分配的唯一标识。

商户密钥：指商户在和##联盟确定合作意向时##联盟为商户提供的16位字符串。该信息作为商户系统和##联盟交互时身份确认的依据，需商户妥善保管。

2、消费流程

通常，一次支付最少包括2个交互过程。第一个过程是商户系统将在线支付等信息提交到##联盟接口的过程，称之为上行过程。第二个过程是在支付完成后，##联盟接口通过server to server方式将支付结果告知商户系统的过程，称之为下行异步通知过程。

如果用户在跳转到##联盟接口完成支付操作后，需要##联盟接口将处理结果立即返回给商户系统的下一步页面，让用户继续完成整个操作流程，此时支付还应包括第三个流程，下行同步通知过程。该过程需要在上行过程中提交参数hrefbackurl。

3、查询流程

在商户系统将订单成功提交给##联盟接口后的任意时间，商户系统可发起请求查询订单的处理结果。该流程由商户系统发起，由接口返回相应结果。

4、系统加密

##联盟接口采用MD5加密方式对传输数据进行签名验证，具体请参考相关接口定义。对MD5加密后的签名值，请注意结果的大小写务必正确。

为了确保签名值不是因为MD5加密算法而导致结果不正确，请各商户在调用接口前对字符串1234567890abcdefghijklmnoprstuvwxyz使用MD5加密算法进行加密，若加密结果为

##################################则表示MD5加密正常。

第三章网银接口定义

1、同步过程接口定义（商户系统发起请求）

1、接入URL：http://************/chargebank.aspx (最新地址)

2、接入方式：GET方式

3、请求协议参数：

表1 同步过程请求协议参数说明

参数名参数可空加入签名说明

商户ID parter N Y 商户id，由##联盟分配

银行类型type N Y 银行类型，具体请参考附录1

金额value N Y 单位元（人民币），2位小数，最小支

付金额为0.02

商户订单号orderid N Y 商户系统订单号，该订单号将作为##

联盟接口的返回数据。该值需在商户

系统内唯一，##联盟系统暂时不检查

该值是否唯一

下行异步通知地址callbackurl N Y 下行异步通知过程的返回地址，需要

以http://开头且没有任何参数

下行同步通知地址hrefbackurl Y N 下行同步通知过程的返回地址(在支付

完成后##联盟接口将会跳转到的商户

系统连接地址)。

注：若提交值无该参数，或者该参数

值为空，则在支付完成后，##联盟接

口将不会跳转到商户系统，用户将停

留在##联盟接口系统提示支付成功的

页面。

支付用户IP payerIp Y N 用户在下单时的真实IP，##联盟接口

将会判断玩家支付时的ip和该值是否

相同。若不相同，##联盟接口将提示

用户支付风险

备注消息attach Y N 备注信息，下行中会原样返回。若该

值包含中文，请注意编码

MD5签名sign N - 32位小写MD5签名值，GB2312编码代理ID agent N 代理ID 如果没有代理，可以留空

4、MD5签名说明

待签名数据为表1中加入签名列值为Y的参数以及商户密钥，签名顺序为表1中parter 到callbackurl的顺序加商户密钥。具体MD5签名源串及格式如下：

parter={}&type={}&value={}&orderid ={}&callbackurl={}key

其中，key为商户签名。

5、接入实例：（假设商户Id为99，商户密钥为1234567890abcd1f）

请求提交方法：

http://#############/chargebank.aspx?parter=99&type=963&value=100.00&orderid=12345 67890&callbackurl=https://www.sodocs.net/doc/e36104744.html,/backAction&hrefbackurl=http://############### #######/notifyAction&payerIp

=127.0.0.1&attach=7uka&sign=fde74a4c040b5022cd9c4d9e6b917fcc&agent=1024实际进行MD5加密的串是

parter=99&type=963&value=100.00&orderid=1234567890&callbackurl=http://www.exampl https://www.sodocs.net/doc/e36104744.html,/backAction1234567890abcdef，该串MD5加密结果为

fde74a4c040b5022cd9c4d9e6b917fcc

6、特别说明：

①在接口使用中，商户系统内发起请求时应使用页面跳转的方式跳转到接口地址。如在jsp中，使用response.sendRedirect(接口地址及参数)，在.net中，使用Response.Redirect(接口地址及参数)。

②若hrefbackurl有效，则在跳转返回通知过程中，##联盟接口将使用相同方法跳转回商户系统，跳转地址是hrefbackurl。

③根据HTTP协议要求，提交参数的值中若存在特殊字符（如：空格、@等）时，为使##联盟接口能接收到正确的参数，这些特殊字符需要做URL Encoding。需特别注意的是，此时待签名数据应该是原生值而不是encoding之后的值。

2、下行异步通知过程接口定义（##联盟接口发起请求）

1、接入URL：过程1中请求参数callbackurl值

2、接入方式：GET方式

3、请求协议参数：

表2 下行过程请求协议参数说明

参数名参数加入签名说明

商户订单号orderid Y 上行过程中商户系统传入的orderid。

订单结果opstate Y 0：支付成功

-1 请求参数无效

-2 签名错误

订单金额ovalue Y 订单实际支付金额，单位元

MD5签名sign - 32位小写MD5签名值，GB2312编码

##联盟订单号sysorderid N 此次订单过程中##联盟接口系统内的订单Id

##联盟订单时间completiont

ime

N 此次订单过程中##联盟接口系统内的订单结

束时间。格式为

年/月/日时：分：秒，如2010/04/05 21:50:58

备注信息attach N 备注信息，上行中attach原样返回订单结果说明msg N 订单结果说明

4、返回协议参数：

表3 下行异步通知返回协议参数

参数名参数说明

操作结果状态opstate 0：处理成功

-1：请求参数无效

-2：签名错误

5、MD5签名说明：

待签名数据为表2中加入签名列值为Y的参数以及商户密钥，签名顺序为表2中orderid 到ovalue的顺序加商户密钥。具体MD5签名源串及格式如下：

orderid={}&opstate={}&ovalue={}key

其中，key为商户签名。

6、特别说明：

①下行异步通知过程在整个支付流程中一定存在。商户系统在收到下行通知过程后，需向##联盟接口返回类似opstate=0的结果。##联盟接口根据该返回值判断商户系统是否已经收到结果。若返回结果不是opstate=0（可能是opstate=-1、-2或者空），##联盟接口会根据商家和##联盟接口的约定，再次反复向callbackurl发送结果，直到商户返回opstate=0或者达到和商户约定的重复发送次数。

②当##联盟接口在下行异步通知过程中返回在线支付结果时，商户系统在收到数据后，应该通过sign值判断是否是有效的返回数据，防止数据在网络传输过程中被恶意篡改。

7、注意事项：

①在收到##联盟接口订单下行异步通知结果时，商户系统需首先验证订单通知的合法性，如果不合法，则不要更新商户系统上的订单状态。

②商户系统内订单状态和订单实际金额务必以此次##联盟接口订单异步通知的结果为准。

③商户系统在成功提交订单后，在未没有收到##联盟接口异步通知结果时，请不要更新商户系统上的订单状态。

④商户系统收到异步通知结果后，处理流程可表示为：

if(返回参数同表2表述不同)

同步返回##联盟接口opstate=-1

if(签名正确)｛

if（opstate==0 或者== -3）｛

按照成功处理商户系统内订单，订单实际金额为ovalue

｝else｛

按照失败处理商户系统内订单

｝

同步返回##联盟接口opstate=0

｝else{

同步返回##联盟接口opstate=-2

}

⑤在下行异步通知过程中商户系统返回结果值opstate回##联盟接口时，opstate的值并不是将##联盟接口在下行异步通知的结果原样返回。商户系统返回值opstate=0时表示商户系统已经成功接收到了结果（不论结果是什么，总之是收到了），而其他值表示因为某些原因商户系统并不认为##联盟接口的返回是有效的。##联盟接口在收到商户系统的返回后，如果返回的值为opstate=0，##联盟接口将不再次发送结果，否则##联盟接口会根据##联盟接口同商户的约定再次发送结果。

3、下行同步通知过程接口定义（##联盟接口发起请求）

1、接入URL：过程1中请求参数hrefbackurl值

2、接入方式：GET方式

3、请求协议参数：

该过程参数同表2所示。

4、特别说明：

如果用户在跳转到##联盟接口完成支付操作后，需要##联盟接口将处理结果立即返回给商户系统的下一步页面，让用户继续完成整个操作流程，此时支付还应包括下行同步通知过程。该过程需要在上行过程中提交参数hrefbackurl。

当##联盟接口在下行同步通知过程中返回在线支付结果时，商户系统在收到数据后，应该通过sign值判断是否是有效的返回数据，防止数据在网络传输过程中被恶意篡改。

第四章查询流程接口定义

1、接入URL：http:// ############/Search.aspx

2、接入方式：GET方式

3、请求协议参数：

表4 查询流程请求协议参数

参数名参数加入签名说明

商户订单号orderid Y 需查询的商户系统订单号

商户ID parter Y 商户id，由##联盟分配。

MD5签名sign - 32位小写MD5签名值，GB2312编码

4、返回协议参数

表5 查询流程返回协议参数

参数名参数加入签名说明

商户订单号orderid Y 请求的商户订单号

订单结果opstate Y 3：请求参数无效

2：签名错误

1：商户订单号无效

0：支付成功

其他：用户还未完成支付或者支付失败订单金额ovalue Y 订单实际金额，单位元

MD5签名sign - 32位小写MD5签名值，GB2312编码

5、MD5签名说明：

①查询请求签名：

待签名数据为表4中加入签名列值为Y的参数以及商户密钥，签名顺序为表4中orderid 到parter的顺序加商户密钥。具体MD5签名源串及格式如下：

orderid={}&parter={}key

其中，key为商户签名。

②查询返回签名：

待签名数据为表5中加入签名列值为Y的参数以及商户密钥，签名顺序为表5中orderid 到ovalue的顺序加商户密钥。具体MD5签名源串及格式如下：

orderid={}&opstate={}&ovalue={}key

其中，key为商户签名。

附录1：##联盟支付网关银行类型说明

表7 ##联盟接口银行类型说明

编号类型

962 中信银行

963 中国银行

964 中国农业银行

965 中国建设银行

966 中国工商银行（仅限工行手机签约客户）

967 中国工商银行（全国范围）

968 浙商银行

969 浙江稠州商业银行（暂停使用）

970 招商银行

971 邮政储蓄

972 兴业银行

973 顺德农村信用合作社（暂停使用）

974 深圳发展银行

975 上海银行

976 上海农村商业银行

977 浦东发展银行

978 平安银行

979 南京银行

980 民生银行

981 交通银行

982 华夏银行

983 杭州银行

984 广州市农村信用社|广州市商业银行985 广东发展银行

986 光大银行

987 东亚银行

988 渤海银行

989 北京银行

990 北京农村商业银行

992 支付宝

993 财付通

994 快钱

1003 支付宝扫码支付

211 微信扫码支付

软件项目详细设计文档示例模版

XXX软件/项目/系统详细设计说明书拟制日期评审人日期批准日期编写单位或个人

修订历史

目录 XXX软件详细设计说明书 (1) Revision Record 修订记录 (2) 1引言 (1) 1.1编写目的 (1) 1.2背景 (1) 1.3参考资料 (1) 1.4术语定义及说明 (1) 2设计概述 (1) 2.1任务和目标 (1) 2.1.1需求概述 (1) 2.1.2运行环境概述 (1) 2.1.3条件与限制 (1) 2.1.4详细设计方法和工具 (1) 3系统详细需求分析 (1) 3.1详细需求分析 (2) 3.2详细系统运行环境及限制条件分析接口需求分析 (2) 4总体方案确认 (2) 4.1系统总体结构确认 (2) 4.2系统详细界面划分 (2) 4.2.1应用系统与支撑系统的详细界面划分 (2) 4.2.2系统内部详细界面划分 (2) 5系统详细设计 (2) 5.1系统结构设计及子系统划分 (3) 5.2系统功能模块详细设计 (3) 5.3系统界面详细设计 (3) 5.3.1外部界面设计 (3) 5.3.2内部界面设计 (3) 5.3.3用户界面设计 (3) 6、数据库系统设计 (4) 6.1设计要求 (4) 6.2 信息模型设计 (4) 6.3数据库设计 (4) 6.3.1设计依据 (4) 6.3.2数据库种类及特点 (4) 6.3.3数据库逻辑结构 (4) 6.3.4物理结构设计 (4) 6.3.5数据库安全 (4) 6.3.6数据字典 (4) 7非功能性设计 (4) 8 (5) 9环境配置 (5)

1引言 1.1编写目的说明编制的目的是，大体上介绍一下软件系统中各层次中模块或子程序、以及数据库系统的设计考虑，表明此文档是主要是为编码人员提供服务，并且其他类型的项目参与人员也可以通过此文档对软件/项目有更深入了解。 1.2背景说明此软件或系统的项目背景、需求背景、开发目的等，还可以列出参与人员等相关信息。 1.3参考资料列出本文档中引用的文献、资料、标准等相关信息（一般是具有出版或版权性质的文件）。 1.4术语定义及说明列出文档中用到的和开发有关，或与行业、业务、需求有关的专业术语，并进行解释。 2设计概述 2.1任务和目标说明详细设计的任务及详细设计所要达到的目标。 2.1.1需求概述对所开发软件的概要描述, 包括主要的业务需求、输入、输出、主要功能、性能等，尤其需要描述系统性能需求。 2.1.2运行环境概述对本系统所依赖于运行的硬件，包括操作系统、数据库系统、运行库、中间件、接口软件、可能的性能监控与分析等软件环境的描述，及配置要求。 2.1.3条件与限制详细描述系统所受的内部和外部条件的约束和限制说明。包括业务和技术方面的条件与限制以及进度、管理等方面的限制。 2.1.4详细设计方法和工具简要说明详细设计所采用的方法和使用的工具，如数据库设计工具、界面设计工具、原型设计工具等。 3系统详细需求分析主要对系统级的需求进行分析。首先应对需求分析提出的企业需求进一步确认，并对由于情况变化而带来的需求变化进行较为详细的分析。

API接口调用说明及示例(第四次修订)

Revision Record 修订记录

目录 1 API接口简介------------------------------------------------------------------------------------------------------- 3 2 API认证概述------------------------------------------------------------------------------------------------------- 4 认证方式的分类 --------------------------------------------------------------------------------------------- 4认证方式的选择 --------------------------------------------------------------------------------------------- 5认证原理 ------------------------------------------------------------------------------------------------------- 5 3 认证方法详解及示例-------------------------------------------------------------------------------------------- 5 OAuth ----------------------------------------------------------------------------------------------------------- 5 eYouAuth ------------------------------------------------------------------------------------------------------- 5 SSO API的eYouAuth认证方法：----------------------------------------------------------------- 5 Feed API的eYouAuth认证方法： --------------------------------------------------------------- 7 申请会话Token：------------------------------------------------------------------------------------- 8 4 API接口调用示例 ---------------------------------------------------------------------------------------------- 10 Feed API调用----------------------------------------------------------------------------------------- 10 资源概述 ---------------------------------------------------------------------------------------------- 10 以用户的增删改查为例，示例各种Feed API调用步骤--------------------------------- 11 5 附表 ---------------------------------------------------------------------------------------------------------------- 13 1 API接口简介 API指eYou邮件系统所提供的接口。调用接口流程图：

接口调用说明文档

XXX）科技有限公司数据接口 2015-5-26

目录第1章引言. ......................................................... 错误!未定义书签。背景. ........................................................... 错误!未定义书签。第2章接口与数据定义. ................................................... 错误!未定义书签。曝光台查询接口. ..................................................... 错误!未定义书签。曝光台列表查询.......................... 错误!未定义书签。曝光台详情查询.......................... 错误!未定义书签。信用公示查询接口定义.......................... 错误!未定义书签。守信公示列表查询.......................... 错误! 未定义书签。守信公示详情查询.......................... 错误!未定义书签。失信公示列表查询.......................... 错误!未定义书签。失信公示详情查询.......................... 错误!未定义书签。企业名称查询接口定义.......................... 错误!未定义书签。 Webservice 方法定义 ........................ 错误! 未定义书签。请求参数. .................................................... 错误! 未定义书签。返回数据. .................................................... 错误!未定义书签。企业信息查询接口定义.......................... 错误!未定义书签。 Webservice 方法定义 ........................ 错误! 未定义书签。请求参数. .................................................... 错误! 未定义书签。返回数据. .................................................... 错误!未定义书签。

帝国CMS版接口说明

帝国CMS接口使用手册一、简介 1、本接口应用于帝国CMS 版新闻系统模型的栏目文章发布； 2、本接口可以自动生成文章、栏目、首页等静态HTML页面； 3、本接口可以生成随机点击数，详见发布接口参数说明； 4、发布时请使用管理员用户帐号； 5、在帝国CMS utf8版使用本接口时，请在发布规则中选择编码为UTF-8； 6、本接口基于帝国CMS UTF8版制作，适用于帝国CMS GBK/utf-8等版本，应用于其他版本时请自行测试调整；； 7、接口文件无须任何改动即可使用，如果你希望增加校验或其他功能，请仔细修改； 8、2个接口文件请复制在网站 /e/admin目录下使用；二、安装接口在接口文件夹中找到接口文件，如图：请将、等接口文件上传到指定目录，请使用二进制方式上传，如图：三、配置发布规则 1、将范例发布规则文本导入ET2发布配置，或使用软件内置发布规则范例，如图：

2、将检查网址和发布网址中的“您的网站”改为您要发布的网站网址，如图： 3、在检查网址填上您要发布的栏目ID，如图： 4、在参数取值页，填上您要发布的网站栏目ID，如图：这里查看栏目ID：

4、填上您的管理账号、密码，注意格式，如图：四、接口说明一、检查接口 1、接口文件名，为保密，请自行修改文件名； 2、本接口文件复制在网站/e/admin目录使用，如果目录名有变更，请自行对应； 3、主要参数 keyboard 文章标题 classid 栏目ID，用于指定检查栏目，可在后台网站栏目管理处查看； vercode 校验码，请自行设定，并在检查接口文件开始处修改$vercode 使其一致； 4、发布配置-文章检查网址处，可以如下填写：注：使用大小写敏感的服务器的用户请注意网址大小写和网站文件一致 5、接口文件无须任何改动即可使用，如果你希望增加校验或其他功能，请仔细修改；二、发布接口 1、接口文件名，为保密，请自行修改文件名； 2、本接口文件请复制在网站/e/admin目录下使用，为保密，请自行修改文件名；

接口使用说明文档

中国移动短信网关 SP端接口使用手册 China Mobile Shot Message Gateway Interface for SP Manual 作者：沈岗日期：2004年1月版本：V1.2

一、CMSMIF.CMPPApp 简要说明：该类采用CMPP协议(V2.0)实现了SP端与移动短信网关的连接处理。本类中，采用长连接方式与ISMG通讯。通信双方以客户-服务器方式建立TCP连接，用于双方信息的相互提交。当信道上没有数据传输时，通信双方应每隔时间C发送链路检测包以维持此连接，当链路检测包发出超过时间T后未收到响应，立即再发送链路检测包，再连续发送N-1次后仍未得到响应则断开此连接。参数C、T、N可通过属性配置。消息发送时采用并发方式，即发送一条消息不等待网关回复确认，继续向网关发送短信，这样发送消息速度非常快，完全取决于网关的处理速度及网络速度。为避免消息丢失，同时采用了滑动窗口流量控制，窗口大小可通过属性设置。消息接收、网络断开等采用事件触发方式，不需应用程序轮询，在此接口基础之上编程方便。类中运用了多线程技术，如一条线程处理发送网络包，而另一条线程处理从网关上接收网络包，其他还有一些线程处理检测包、网络连接情况监测等，使程序思路明确、执行效率很高、运行非常稳定。（一）属性 1.ActiveInterval 说明：检测包发送时间间隔，单位：毫秒。默认值为120000，即120秒。为上述类说明中的C参数。 2.MaxNetworkPackSize 说明：与ISMG通讯时最大网络包大小，单位：字节。默认值为512Byte。 3.MaxRetryTimes 说明：网络超时最大重发次数,单位：次。默认值为3次。为类说明中的N。 4.OverTime 说明：网络包发送超时时间,单位:毫秒,超过此值还未收到回复则重发。默认值为60000，即60秒。为类说明中的T。 5.QueueLength 说明：网络队列大小，单位：个，默认值为20。为类说明中的滑动窗口大小，以控制发送流量。（二）方法 1.ConnectToIsmg 方法说明：连接到远程短信网关ISMG上，只有连接到远程短信网关上，才可进行短信收发操作。在本操作中，自动初始化本地Socket，以连接到指定IP服务器的指定端口上。声明原型：int ConnectToIsmg(string ServerIP,int Port,string SP_ID,string Secret，string SN) 参数说明： ServerIP：远程短信网关服务器的IP地址，如211.138.200.51 Port：远程短信网关服务器的端口号，如7890 SP_ID：企业服务代码

开发接口文档-API文档模板

XXX项目接口文档版本控制信息获取所有字段获取所有字段请求地址：/session/field/findAll 请求参数响应

请求例子：响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统处理正常！ ","page":0,"pageSize":0,"returnObject":null,"returnValue":{"types":null,"villages":null,"companys":[{"iconColour":"","iconSize":0,"ico nStyle":"","id":4,"name":"XX"},{"iconColour":"","iconSize":0,"iconStyle":"","id":5,"name":"XX"},{"iconColour":"","iconSize":0,"iconSty le":"","id":7,"name":"XX"}]},"totals":0} 文件上传文件上传（ajax）请求地址：/session/file/upload 请求参数响应请求例子：var formData = new FormData(); ("file", [0]); $.ajax({ url : routePath + "/session/file/upload", type : 'POST', data : formData,

processData : false, contentType : false, success : function(result) { result = (result); if == "10000"){ ('上传成功！'); $("#editHeadPortrait").val } } }); 响应例子：returnValue里包含了 fileName和filePath 字段管理-所属类型新增所属类型请求地址：/session/fieldType/save 请求参数响应请求例子：响应例子：{"code":"10000","exception":null,"isSuccess":true,"message":"成功，系统处理正常！","page":0,"pageSize":0,"returnListSize":0,"returnObject":null,"returnValue":null,"totals":0}

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)

概要设计说明书范例及模板

《XXXXXX》概要设计说明书张三、李四、王五

1．引言 1．1编写目的在本机票预定系统项目的前一阶段，也就是需求分析阶段中，已经将系统用户对本系统的需求做了详细的阐述，这些用户需求已经在上一阶段中对航空公司、各旅行社及机场的实地调研中获得，并在需求规格说明书中得到详尽得叙述及阐明。本阶段已在系统的需求分析的基础上，对机票预定系统做概要设计。主要解决了实现该系统需求的程序模块设计问题。包括如何把该系统划分成若干个模块、决定各个模块之间的接口、模块之间传递的信息，以及数据结构、模块结构的设计等。在以下的概要设计报告中将对在本阶段中对系统所做的所有概要设计进行详细的说明。在下一阶段的详细设计中，程序设计员可参考此概要设计报告，在概要设计对机票预定系统所做的模块结构设计的基础上，对系统进行详细设计。在以后的软件测试以及软件维护阶段也可参考此说明书，以便于了解在概要设计过程中所完成的各模块设计结构，或在修改时找出在本阶段设计的不足或错误。 1．2项目背景机票预定系统将由两部分组成：置于个旅行社定票点的前台客户程序，以及置于航空公司的数据库服务器。本系统与其他系统的关系如下： 1．3定义 1．3．1 专门术语 SQL SERVER: 系统服务器所使用的数据库管理系统（DBMS）。 SQL: 一种用于访问查询数据库的语言事务流：数据进入模块后可能有多种路径进行处理。主键：数据库表中的关键域。值互不相同。外部主键：数据库表中与其他表主键关联的域。 ROLLBACK: 数据库的错误恢复机制。 1．3．2 缩写

系统：若未特别指出，统指本机票预定系统。 SQL: Structured Query Language（结构化查询语言）。 ATM: Asynchronous Transfer Mode (异步传输模式)。 1．4参考资料以下列出在概要设计过程中所使用到的有关资料： 1．机票预定系统项目计划任务书浙江航空公司1999/3 2．机票预定系统项目开发计划《**》软件开发小组1999/3 3．需求规格说明书《**》软件开发小组1999/3 4．用户操作手册（初稿）《**》软件开发小组1999/4 5．软件工程及其应用周苏、王文等天津科学技术出版社1992/1 6．软件工程张海藩清华大学出版社1990/11 7．Computer Network A.S.Tanenbaun Prentice Hall 1996/01 文档所采用的标准是参照《软件工程导论》沈美明著的“计算机软件开发文档编写指南”。 2．任务概述 2．1 目标 2．2 运行环境系统将由两部分程序组成，安装在各旅行社客户机上的客户程序及航空公司内的数据服务器程序。根据调研得知所有旅行社的计算机配置均在Pentium 133级别以上，客户程序应能够在Pentium 133级别以上, Win NT环境下运行。 2．3 需求概述浙江航空公司为方便旅客，需开发一个机票预定系统。为便于旅客由旅行社代替航空公司负责为旅客定票，旅行社把预定机票的旅客信息，包括姓名、性别、工作单位、身份证号码、旅行时间、旅行目的地，输入机票预定系统的客户端程序，系统经过查询航空公司内的航班数据服务器后，为旅客安排航班，印出取票通知。旅客在飞机起飞前一天凭取票通知和帐单交款后取票，系统校对无误后即印出机票给旅客。要求系统能有效、快速、安全、可靠和无误的完成上述操作。并要求客户机的界面要简单明了，易于操作，服务器程序利于维护。 2．4 条件与限制 3．总体设计 3．1 处理流程下面将使用（结构化设计）面向数据流的方法对机票预定系统的处理流程进行分

项目需求规格说明书模板

精品文档软件项目名称错误！未指定书签。拟制：日期：审核：日期：批准：日期：

文件修改记录

目录 1范围 (4) 2 总体概述 (4) 2.1 产品描述 (4) 2.2 软件功能 (4) 2.3 一般约束 (5) 2.4 假设和依赖 (5) 3 具体需求 (5) 3.1 功能需求 (5) 3.1.1 功能需求1 (5) 3.1.2 功能需求2 (6) 3.1.n 功能需求n (7) 3.2 外部接口需求 (7) 3.2.1 用户接口 (7) 3.2.2 硬件接口 (7) 3.2.3 软件接口 (7) 3.2.4 通讯接口 (7) 3.3 性能需求 (7) 4 设计约束 (8) 4.1 标准的约束 (8) 4.2 硬件的限制 (8) 4.3 技术的限制 (8) 5 软件质量属性 (8) 5.1 安全性 (9) 5.2 可维护性 (9) 5.3 可移植性 (9) 6 其他需求 (9) 6.1 数据库 (9) 6.2 本地化 (10) 7待确定问题 (10)

模板使用说明： [1]注明可选的部分，可以根据实际情况选择是否填写；如果不必说明，请保留相关的章节标题，同时在该可选章节的内容中填入“无”；未注名可选的，则必须描述；如果有些设计此模版中没有合适的地方填写，则补充在最后的其他栏目中 [2]模版中斜体字相当于撰写指南，最后文稿请将本模板中所有的斜体字部分全部删除。 [3]模板里并不说明设计技术和方法，而只是说明应包含哪些内容，以及如何描述、组织这些内容。

1范围说明文档所包括和不包括的内容，具体是： a．待开发的软件系统的名称； b．说明软件将干什么，如果需要的话，还要说明软件产品不干什么； c．描述所说明的软件的应用。如果有一个较高层次的说明存在，则应该使其和高层次说明中的类似的陈述相一致（例如，系统的需求规格说明）。 2 总体概述 2.1 产品描述叙述该项软件开发的意图、应用目标、作用范围以及其他应向读者说明的有关该软件开发的背景材料。解释被开发软件与其他有关软件之间的关系。如果本软件产品是一项独立的软件，而且全部内容自含，则说明这一点。如果所定义的产品是一个更大的系统的一个组成部分，则应说明本产品与该系统中其他各组成部分之间的关系，为此可使用一张方框图来说明该系统的组成和本产品同其他各部分的联系和接口。 2.2 软件功能概述软件必须实现的和通过用户操作实现的主要功能。这里只需要进行简要描述（例如目录列表），详细描述在详细需求部分描述。有时，如果存在较高层次的规格说明时，则功能摘要可从中取得，这个较高层次的规格说明为软件产品分配了特殊的功能，为了清晰起见，请注意： a．编制功能的一种方法是制作功能表，以便客户或者第一次读这个文件的人都可以理解； b．用方框图来表达不同的功能和它们的关系也是有帮助的。但应牢记，这样的图不是产品设计时所需求的，而只是一种有效的解释性的工具。例如：高层的数据流图，面向对象的分析等。

接口文档规范

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

项目接口需求及设计说明文档

媒讯集团E A S项目 CTC与EAS接口需求及设计说明书文档作者：创建日期：20X X-05-10 确认日期：当前版本：1.0 拷贝数量：1 审批签字: 客户方：实施方：

文档控制修改记录日期作者版本参考版本备注

目录 1.概述 (4) 1.1读者 (4) 1.2图例 (4) 1.3目的 (4) 二、业务现状 (5) 三、概要设计 (5) 3.1接口通讯方式 (5) 3.2通讯内容定义 (5) 3.3媒讯CTC系统提供接口使用范例 (5) 3.4金蝶EAS提供接口使用范例 (5) 3.5媒讯CTC系统提供接口服务地址 (7) 3.6金蝶EAS提供接口服务地址 (7) 3.7接口需求 (7) 四、详细设计 (8) 4.1XX EAS接口 (8)

1.概述金蝶与用户及用户业务系统方通过多次讨论，制定了接口开发需求设计说明书，作为双方后续开发指引。 1.1读者本文读者对象为业务管理人员、系统设计、开发人员、测试人员。 1.2图例本文中如未进行特殊说明，各图标代表的含义如下：表示一个活动；表示动态的业务数据，如系统单据；表示流程走向；表示条件判断、流程分支；表示静态的业务数据，如基础资料；表示系统外一个手工处理活动；表示系统外手工填制的单据；表示当前系统之外的活动；表示当前系统之外产生的业务数据。 1.3目的本文档是媒讯CTC系统与EAS系统接口的需求及设计方案相关文档，可用于指导开发、测试工作和作为验收相关依据文档。

二、业务现状待补充三、概要设计 3.1接口通讯方式金蝶EAS与媒讯CTC系统之间通讯采用WebService方式进行数据传输。 3.2通讯内容定义对于记录型的大对象，在通讯时，采用String型的xml格式的参数进行传递。对于其他非记录型的对象，在通讯时，可采用非xml格式的参数进行传递，也可使用多个参数。具体格式，请参照每个接口的通讯用例说明。 3.3媒讯CTC系统提供接口使用范例待补充。 3.4金蝶EAS提供接口使用范例 3.4.1规范说明 EAS通过webService接口与异构系统通信。EAS WebService全部是使用java编写的，其接口描述符合WSDL国际标准，其数据描述符合XSD 国际标准。本次提供的接口除系统登录接口外，其他接口都需要调用登录接口，以便将登陆的SessionId信息放入到SOAP 的HEADER 报文中。 3.4.2使用示例金蝶在EAS上发布WebService服务，提供wsdl文件供客户端下载，其他业务系统根据下载的wsdl文件，产生客户端。建议使用Axis2来生成客户端代理。

项目接口需求及设计说明文档(模板)

客户化开发需求规格说明书媒讯集团E A S项目 CTC与EAS接口需求及设计说明书文档作者：创建日期：2013-05-10 确认日期：当前版本：1.0 拷贝数量：1 审批签字: 客户方：实施方：

文档控制修改记录日期作者版本参考版本备注

软件工程文档模板范例.doc

目录三、需求规格说明书 (2) 四、概要设计说明书 (12) 五、详细设计说明书 (15)

3软件需求说明书软件需求说明书的编制是为了使用户的软件开发者双方对该软件的起初规定有一个共同的理解，使之成为整个开发工作的基础。编制软件需求说明书的内容要求如下： 3.1引言 3.1.1编写的目的 3.1.2背景 3.1.3定义 3.1.1参考资料 3.2任务概述 3.2.1目标 3.2.2用户的点 3.2.3假定与约束 3.3需求规定 3.3.1对功能的规定 3.3.2对性能的规定

3.3.2.1精度 3.3.2.2时间特性要求 3.3.2.3灵活性 3.3.3输入输出要求 3.3.4数据管理能力的要求 3.3.5故障处理要求 3.3.6其它的专门的要求 3.4运行环境规定 3.4.1设备 3.4.2支持软件 3.4.3接口 3.4.4控制 4数据需求说明书数据要求说明书的编制目的是为了向整个开发时期提供关于处理数据的描述和数据采集要求的技术信息。编制数据要求说明书的内容要求如下： 4.1引言

4.1.1编写目的 4.1.2背景 4.1.3定义 4.1.4参考资料 4.2数据的逻辑描述 4.2.1静态数据 4.2.2动态输入数据 4.2.3动态输出数据 4.2.4内部生成数据 4.2.5数据约定 4.3数据的采集 4.3.1要求和范围 4.3.2输入的承担者 4.3.3处理 4.3.4影响 5概要设计说明书概要设计说明书可称作系统设计说明书，这里说的系统是指程序系统，编制的目

的是说明对程序的系统的设计考虑，包括程序系统的基本处理流程、程序系统的组织结构、模块划分、功能分配、接口设计、运行设计、数据结构设计和出错处理设计等，为程序的详细设计提供基础。编制概要设计说明书的内容要求如下： 5.1引言 5.1.1编写目的 5.1.2背景 5.1.3定义 5.1.4参考资料 5.2总体设计 5.2.1需求规定 5.2.2运行环境 5.2.3基本设计概念和处理流程 5.2.4结构 5.2.5功能需求与程序的关系 5.2.6人工处理过程

项目接口文档

接口使用说明书 2016年9月

版本控制文档信息文档变更记录

目录 1.接口概述 (4) 1.1. 概述 (4) 1.2. 基本规则 (4) 1.2.1. 域名 (4) 1.2.2. 通用接口调用参数说明 (4) 2.接口定义 (6) 2.1. 登录注册 (6) 2.1.1. 登录接口 (6) 2.1.1.1. 账号密码登录 (6) 2.1.1.2. 微信登录............................................................................. 错误！未定义书签。 2.1.2. 注册和修改接口..................................................................... 错误！未定义书签。 2.1.2.1. 完善个人信息接口............................................................. 错误！未定义书签。 2.1.2.2. 获取个人资料..................................................................... 错误！未定义书签。 2.1.2. 3. 上传/修改企业信息 ........................................................... 错误！未定义书签。 2.1.2.4. 上传/修改工作经历 ........................................................... 错误！未定义书签。 2.1.2.5. 设置/修改提现密码 ........................................................... 错误！未定义书签。 2.1. 3. 短信部分接口......................................................................... 错误！未定义书签。 2.1. 3.1. 发送短信验证码接口......................................................... 错误！未定义书签。 2.1.4. 服务部分接口......................................................................... 错误！未定义书签。 2.1.4.1. 上传/修改个人服务信息 ................................................... 错误！未定义书签。 2.1.4.2. 获取服务列表..................................................................... 错误！未定义书签。 2.1.4. 3. 获取服务详情..................................................................... 错误！未定义书签。 2.1.4.4. 评价列表(全部服务或单个服务) ...................................... 错误！未定义书签。 2.1.4.5. 预约..................................................................................... 错误！未定义书签。 2.1.4.6. 服务评价............................................................................. 错误！未定义书签。 2.1.5. 我的账户................................................................................. 错误！未定义书签。 2.1.5.1. 获取用户收入/支出记录 ................................................... 错误！未定义书签。 2.1.5.2. 分页获取收入/支出记录 ................................................... 错误！未定义书签。 2.1.5. 3. 添加收入/支出记录 ........................................................... 错误！未定义书签。 2.1.6. 红包部分接口......................................................................... 错误！未定义书签。 2.1.6.1. 领取红包............................................................................. 错误！未定义书签。 2.1.6.2. 发放红包............................................................................. 错误！未定义书签。 2.1.7. 精英汇部分接口..................................................................... 错误！未定义书签。 2.1.7.1. 获取精英列表..................................................................... 错误！未定义书签。 2.1.7.2. 精英详情............................................................................. 错误！未定义书签。 2.1.8. 任务接口................................................................................. 错误！未定义书签。 2.1.9. 其他接口................................................................................. 错误！未定义书签。 2.1.9.1. 消息..................................................................................... 错误！未定义书签。 2.1.9.2. 省市区获取......................................................................... 错误！未定义书签。 2.1.9. 3. 行业类型获取..................................................................... 错误！未定义书签。 2.1.9.4. 上传多媒体资源................................................................. 错误！未定义书签。

接口文档说明示例

软件项目详细设计文档示例模版

API接口调用说明及示例(第四次修订)

接口调用说明文档

帝国CMS版接口说明

接口使用说明文档

开发接口文档-API文档模板

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

概要设计说明书范例及模板

项目需求规格说明书模板

接口文档规范

项目接口需求及设计说明文档

项目接口需求及设计说明文档(模板)

软件工程文档模板范例.doc

项目接口文档

相关文档

最新文档