API接口说明
Resellerclub –API接口说明
说明一
1.进入代理控制面板，点击【设置】-【应用程序接口(API)】，可见下图页面：
2.支持HTTP API和SOAP API(注：SOAP API将要停用，建议使用HTTP API更加简易！)
3.在上图红圈中，需要填入服务器的IP地址进行授权（注：不接受IP段）
4、API说明和测试账户：
API说明文档地址：https://www.sodocs.net/doc/bb9083437.html,/kb/servlet/KBServlet/cat106.html
测试代理账户可在以下地址创建：
https://www.sodocs.net/doc/bb9083437.html,/servlet/ResellerSignupServlet?&validatenow=false
也可以使用下面的账户进行测试：
代理登录信息：https://www.sodocs.net/doc/bb9083437.html,/reseller
rock.h@https://www.sodocs.net/doc/bb9083437.html, rock123456
客户登录信息：https://www.sodocs.net/doc/bb9083437.html,/customer
test@https://www.sodocs.net/doc/bb9083437.html, qwer1234
注：请使用测试账户进行API调试。
说明二
ResellerClub所提供的所有产品均有提供Http API接口，不受开发语言限制，代理商可以根据我们提供的说明文档自行整合。下面介绍的是域名API接口的一些简要说明。
1、ResellerClub提供的Http API文档说明地址：
https://www.sodocs.net/doc/bb9083437.html,/kb/answer/752
此链接是关于不同域名参数的说明，其中底部有个示例：
https://https://www.sodocs.net/doc/bb9083437.html,/api/domains/register.json?auth-userid=0&auth-password=password&d omain-name=https://www.sodocs.net/doc/bb9083437.html,&years=1&ns=https://www.sodocs.net/doc/bb9083437.html,&ns=https://www.sodocs.net/doc/bb9083437.html,&customer-id= 0®-contact-id=0&admin-contact-id=0&tech-contact-id=0&billing-contact-id=0&invoice-op tion=KeepInvoice&protect-privacy=true
在上面的地址中有一些参数
Auth-uesrid & auth-password 此处应填代理商的ID号和密码
https://www.sodocs.net/doc/bb9083437.html, & https://www.sodocs.net/doc/bb9083437.html, 此处应填代理商的DNS，如果使用我们为代理商提供的DNS记录，请在代理后台默认的四组DNS中选择两组
如果是用我们Demo平台，测试DNS为https://www.sodocs.net/doc/bb9083437.html, https://www.sodocs.net/doc/bb9083437.html,
Customer-id 填入直接客户的ID，由于ResellerClub是走代理渠道的，所有产品需要以直接客户身份来购买
Reg-contact-id & admin-contact-id & tech-contact-id & billing-contact-id 请填入直接客户联系信息的ID，这些信息将用于域名whois信息，具体可以通过在直接客户后台--域名--联系人管理--列表查看到这些联系信息的ID
另外需要注意的是，请保证代理账户和直接客户账户上有余额，此外，有些域名后缀对于联系信息的要求有所差异，请认真核对。
说明三
如果您是用的WINIIS（慧林）的主机管理系统，该系统默认有整合我们的API域名接口，您只需要填写相应的参数和设置。
1、首先在我们代理后台--设置--应用程序接口（API）填上你的IP地址
2、在慧林后台找到设置我司接口的地方（LogicBoxes API）
LogicBoxes用户名填入代理账户的用户名即邮箱地址
LogicBoxes密码填入代理账户的密码
LogicBoxes父ID号在代理后台--设置--个人信息--主要资料可查看该父ID号
LogicBoxes客户ID 直接客户的ID号
LogicBoxes主DNS LogicBoxes辅DNS
这两个填代理商在我们后台设置的默认DNS，如果是用我们提供的免费DNS服务，可以挑选任意两组填上。
关于接口整合后如何实现域名DNS管理：
有两种方式，一个是转到慧林提供的dnsceo平台，那边有提供智能解析服务。一种是，代理商自己搭建dns服务器，在自己平台，直接提供给客户域名解析。另外，慧林主机系统如果代理商有购买他们的winmydns服务，也可以实现。
API接口文档
API接口文档 最后更新日期：2013-05-16 一、添加域名接口 (6) 1、接口调用地址 (6) 2、传入参数 (6) 3、输出数据 (6) 二、删除域名接口 (7) 1、接口调用地址 (7) 2、传入参数 (7) 3、输出数据 (7) 三、添加用户接口 (8) 1、接口调用地址 (8) 2、传入参数 (8) 3、输出数据 (8) 四、获取用户信息接口 (9) 1、接口调用地址 (9) 2、传入参数 (9) 3、输出数据 (9) 五、搜索用户接口 (10) 1、接口调用地址 (10) 2、传入参数 (10) 3、输出数据 (10) 六、修改用户接口 (11) 1、接口调用地址 (11) 2、传入参数 (11) 3、输出数据 (12) 七、删除用户接口 (13) 1、接口调用地址 (13) 2、传入参数 (13) 3、输出数据 (13) 八、获取邮箱别名接口 (14) 1、接口调用地址 (14) 2、传入参数 (14) 3、输出数据 (14) 九、获取部门列表接口 (15) 1、接口调用地址 (15) 2、传入参数 (15) 3、输出数据 (15) 十、添加部门接口 (17) 1、接口调用地址 (17)
3、输出数据 (17) 十一、修改部门接口 (18) 1、接口调用地址 (18) 2、传入参数 (18) 3、输出数据 (18) 十二、删除部门接口 (19) 1、接口调用地址 (19) 2、传入参数 (19) 3、输出数据 (19) 十三、获取部门成员接口 (20) 1、接口调用地址 (20) 2、传入参数 (20) 3、输出数据 (20) 十四、添加部门成员接口 (21) 1、接口调用地址 (21) 2、传入参数 (21) 3、输出数据 (21) 十五、删除部门成员接口 (22) 1、接口调用地址 (22) 2、传入参数 (22) 3、输出数据 (22) 十六、添加别名接口 (23) 1、接口调用地址 (23) 2、传入参数 (23) 3、输出数据 (23) 十七、修改别名接口 (24) 1、接口调用地址 (24) 2、传入参数 (24) 3、输出数据 (24) 十八、删除别名接口 (25) 1、接口调用地址 (25) 2、传入参数 (25) 3、输出数据 (25) 十九、获取POP接收邮件接口 (26) 1、接口调用地址 (26) 2、传入参数 (26) 3、输出数据 (26) 二十、添加POP接收邮件接口 (27) 1、接口调用地址 (27) 2、传入参数 (27) 3、输出数据 (27) 二十一、修改POP接收邮件接口 (28) 1、接口调用地址 (28)
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类型
3.请求参数体param定义 参数体param中的具体请求参数，根据不同的业务而不同，详见各业务接口。 3.1.2返回参数 1.返回类型为String类型
开发接口文档-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}
接口文档规范
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:[
共享平台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/bb9083437.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.产品描述 (3) 1.1.编写目的 (3) 1.2.产品名称 (3) 1.3.名词定义（可选） (3) 2.产品需求概述 (3) 2.1.功能简介 (3) 2.2.运行环境 (3) 2.3.条件与限制（可选） (3) 3.功能需求 (3) 3.1.功能划分（可选） (3) 3.2.功能1 (4) 3.3.功能N (4) 3.4.不支持的功能 (4) 4.数据描述 (4) 5.性能需求（可选） (4) 6.运行需求（可选） (4) 6.1.用户界面 (4) 6.2.硬件接口 (4) 6.3.软件接口 (5) 6.4.通信接口 (5) 7.其它需求（可选） (5) 8.特殊需求（可选） (5) 9.不确定的问题（可选） (5) 10.编写人员及编写日期 (5) 11.附录 (5) 11.1.引用文件 (5) 11.2.参考资料 (5)
1.产品描述 1.1.编写目的 【说明编写本软件需求规格说明书的目的，指出预期的读者。】 1.2.产品名称 【本项目的名称，包括项目的全名、简称、代号、版本号。】 1.3.名词定义（可选） 【对重要的或是具有特殊意义的名词（包括词头和缩写）进行定义，以便读者可以正确地解释软件需求说明。】 2.产品需求概述 2.1.功能简介 【对产品的基本功能做一个简介，包括： 1.本产品的开发意图、应用目标及作用范围。 2．概略介绍了产品所具有的主要功能。可以用列表的方法给出，也可以用图形表示主要的需求分组以及它们之间的联系，例如数据流程图的顶层图或类图等。 3．说明本产品与其他相关产品的关系，是独立产品还是一个较大产品的组成部分。 可以用表示外部接口和数据流的系统高层次图，或者方框图说明。】 2.2.运行环境 1.硬件环境： 【详细列出本软件运行时所必须的最低硬件配置、推荐硬件配置(如主机、显示器、外部设备等)以及其它特殊设备。】 2.软件环境： 【如操作系统、网络软件、数据库系统以及其它特殊软件要求。】 2.3.条件与限制（可选） 【说明本软件在实现时所必须满足的条件和所受的限制，并给出相应的原因。 必须满足的条件包括输入数据的范围以及格式。 所受的限制包括软件环境、硬件环境等方面的内容。例如：必须使用或者避免的特定技术、工具、编程语言和数据库；企业策略、政府法规或工业标准；硬件限制，例如定时需求或存储器限制；经费限制、开发期限；项目对外部因素存在的依赖。例如其它项目开发的组件。等等】 3.功能需求 【功能需求描述系统特性，即产品所提供的主要服务。可以通过使用实例、运行模式、用户类、对象类或功能等级等不同方法来描述，还可以把它们组合起来使用。 功能需求的表述形式可以参见《需求分析和管理指南》第8.2节。】 3.1.功能划分（可选） 【此部分从用户的角度描述将软件划分成不同的部分，并给出总体功能结构。对于复杂
完整的接口解决方案说明书
文档编号：T-JKJS 文档版本：0.01 项目编号：XX-DX- PECS 《XX电信工程外部协作系统》 Project Exterior Cooperation System 施工单位接口技术解决方案 编写人：南疯日期：2006-10-30 审核人：日期： 批准人：日期： XXXXXX信息科技股份有限公司 地址：XXXXXXX 邮编：XXXXXX 电话：XXXXXXXX传真：XXXXXX 网站：XXXXXXXXX 修改记录（Revision Chart） 版本号批准人修改人修改0.01南疯2006-10-30 0.02详细修改记录： 序号
1引言 1.1编写目的 1.2覆盖范围 1.3预期读者与阅读建议 1.4文档约定 1.5术语与缩略语 1.6参考文献 2概述 3接口方式 4接口安全 4.1接口认证 4.2数据安全 5事务处理 6性能考虑 7容错处理 8数据格式 8.1约定 8.2施工系统向外协系统发送请求 8.2.1请求查询一个业务数据 8.2.2新增一条记录，得到记录的键值 8.2.3修改一条记录 8.2.4删除一条记录 8.2.5文档上传 8.2.6一条记录中一个文档字段上传多个文件 8.2.7补充上传文档 8.2.8在记录中删除一个文档 8.2.9获得文档的基本信息 8.2.10获得文档的所有兄弟信息 8.2.11获得文档的所有父亲信息 8.2.12下载一个文档 8.2.13获得字典 8.3外协系统向施工系统发送请求 8.3.1发送变更后的数据 8.3.2发送变更后的字典 8.3.3文档发送请求 9信息数据项 9.1数据表 9.2字段信息 9.3字典类型
api接口文档
API(Application Programming Interface,应用程序编程接口)是一些预先定义的函数，目的是提供应用程序与开发人员基于某软件或硬件的以访问一组例程的能力，而又无需访问源码，或理解内部工作机制的细节。API除了有应用“应用程序接口”的意思外，还特指API的说明文档，也称为帮助文档。 API：应用程序接口（API：Application Program Interface） 应用程序接口（是一组定义、程序及协议的集合，通过API 接口实现计算机软件之间的相互通信。API 的一个主要功能是提供通用功能集。程序员通过调用API 函数对应用程序进行开发，可以减轻编程任务。API 同时也是一种中间件，为各种不同平台提供数据共享。 根据单个或分布式平台上不同软件应用程序间的数据共享性能，可以将API 分为四种类型： 远程过程调用（RPC）：通过作用在共享数据缓存器上的过程（或任务）实现程序间的通信。 标准查询语言（SQL）：是标准的访问数据的查询语言，通过数据库实现应用程序间的数据共享。 文件传输：文件传输通过发送格式化文件实现应用程序间数据共享。
信息交付：指松耦合或紧耦合应用程序间的小型格式化信息，通过程序间的直接通信实现数据共享。 当前应用于API 的标准包括ANSI 标准SQL API。另外还有一些应用于其它类型的标准尚在制定之中。API 可以应用于所有计算机平台和操作系统。这些API 以不同的格式连接数据（如共享数据缓存器、数据库结构、文件框架）。每种数据格式要求以不同的数据命令和参数实现正确的数据通信，但同时也会产生不同类型的错误。因此，除了具备执行数据共享任务所需的知识以外，这些类型的API 还必须解决很多网络参数问题和可能的差错条件，即每个应用程序都必须清楚自身是否有强大的性能支持程序间通信。相反由于这种API 只处理一种信息格式，所以该情形下的信息交付API 只提供较小的命令、网络参数以及差错条件子集。正因为如此，交付API 方式大大降低了系统复杂性，所以当应用程序需要通过多个平台实现数据共享时，采用信息交付API 类型是比较理想的选择。 API 与图形用户接口（GUI）或命令接口有着鲜明的差别：API 接口属于一种操作系统或程序接口，而后两者都属于直接用户接口。 有时公司会将API 作为其公共开放系统。也就是说，公司制定自己的系统接口标准，当需要执行系统整合、自定义和程序应用等操作时，公司所有成员都可以通过该接口标准调用源代码，该接口标准被称之为开放式API。
API接口设计说明书
XXAPI 接口设计说明书 公司 2016年11月25日 文档管理信息表 主题XX api接口设计说明书 版本V0.1 内容 关键字 参考文档 创建时间 创建人 最新发布日期 文档变更记录表 修改人修改时间修改内容 创建
目录 文档变更记录表 .................................................................................................................................................................................. 目录 .................................................................................................................................................................................................... 引言 ...................................................................................................................................................................................................... 编写目的 背景 定义 参考资料 综述 ...................................................................................................................................................................................................... 统一的输入输出参数 必须登录才能访问的接口 错误返回码列表 用户接口 .............................................................................................................................................................................................. 用户注册（user/signup） 用户登录（user/signin） 优惠券接口 .......................................................................................................................................................................................... 我的优惠券（coupon/mycoupon）
接口文档规范
XXX接口说明书 (版本： 文档编号保密等级 作者最后修改日期 审核人最后审批日期 批准人最后批准日期
修订记录 日期版本修订说明修订人
1简介 1.1文档目的 接口文档是前端与后端交互密不可分的环节，接口的规范性会直接影响双方对接过程中的效率和质量。本着快速高效开发的目的性，避免对接过程中的错误率。 1.2接口规范 (1) 遵循RESTful API设计风格 (2) 数据格式采用json格式 (3) 返回统一结构数据 例如： 结构：data（数据）、errorCode（状态码）、msg（提示信息） { data:{}, .] 订单列表 orderList orderId string 否订单id orderName string 否订单名称
isStudent boolean 是false false 是否学生（是：true，否： false） 返回参数： 参数名类型示例值默认值描述 data array […]返回的数据 data id string 用户id gender number 1 1 用户性别（男：1，女：2）invoiceTitle string 抬头 address string 地址 billList array [...] 订单列表数据 billList id string 订单id billName string 订单名称 billStauts number 1 1 订单状态（待开票：1，回款： 2，核销：3） address string 客户地址 userInfo object {} 用户信息 userInfo name name 用户姓名 age number 用户年龄 gender string 1 1 用户性别（男：1，女：2）errorCode number 状态信息 msg string 信息提示 返回示例值: { data:[ { id:'1', gender:2, invoiceTitle:'帝国快运', address:'陕西省西安市雁塔区科技路24号', billList:[ { id:'001', billName:'测试数据', billStauts:1, address:'雁塔区' }, { id:'002', billName:'测试数据02',
api接口文档
接口： 接口泛指实体把自己提供给外界的一种抽象化物，用以由内部操作分离出外部沟通方法，使其能被内部修改而不影响外界其他实体与其交互的方式。 在计算机中，接口是计算机系统中两个独立的部件进行信息交换的共享边界。这种交换可以发生在计算机软、硬件，外部设备或进行操作的人之间，也可以是它们的结合。 API： API是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。用来提供应用程序与开发人员基于某软件或硬件得以访问的一组例程，而又无需访问源码，或理解内部工作机制的细节。 简介： 操作系统是用户与计算机硬件系统之间的接口，用户通过操作系统的帮助，可以快速、有效和安全、可靠地操纵计算机系统中的各类资源，以处理自己的程序。为使用户能方便地使用操作系统，OS 又向用户提供了如下两类接口： 用户接口：操作系统专门为用户提供了“用户与操作系统的接口” ，通常称为用户接口。该接口支持用户与OS 之间进行交互，即由用户向OS 请求提供特定的服务，而系统则把服务的结果返回给用户。 程序接口：操作系统向编程人员提供了“程序与操作系统的接口” ，简称程序接口，又称应用程序接口API。该接口是为程序员
在编程时使用的，系统和应用程序通过这个接口，可在执行中访问系统中的资源和取得OS 的服务，它也是程序能取得操作系统服务的唯一途径。大多数操作系统的程序接口是由一组系统调用(system call)组成，每一个系统调用都是一个能完成特定功能的子程序。 应用程序接口又称为应用编程接口，是一组定义、程序及协议的集合，通过API接口实现计算机软件之间的相互通信。API 的一个主要功能是提供通用功能集。API同时也是一种中间件，为各种不同平台提供数据共享。程序设计的实践中，编程接口的设计首先要使软件系统的职责得到合理划分。良好的接口设计可以降低系统各部分的相互依赖，提高组成单元的内聚性，降低组成单元间的耦合程度，从而提高系统的可维护性和可扩展性。
接口说明_POE说明书
POE模块说明 一、POE简介 POE被称为基于局域网的供电系统(POL, Power over LAN )或有源以太网( Active Ethernet)，有时也被简称为以太网供电，这是利用现存标准以太网传输电缆的同时传送数据和电功率的最新标准规范，并保持了与现存以太网系统和用户的兼容性。 POE有两个通用标准： 1.IEEE 80 2.3at：最新POE供电标准，为大功率终端的需求而诞生，最大可以提供30W的输出功率。 2.IEEE 802.3af ：首个POE供电标准，规定了以太网供电标准，是现在POE应用的主流实现标准，最大可以输出13W的功率。 POE标准为使用以太网传输电缆输送直流电到POE兼容的设备定义了两种方法： 1.中间跨接法(Mid -Span)：使用以太网电缆中没有被使用的空闲线对来传输直流电，需要8芯网线来供电，4芯数据线，4芯供电线。 2.末端跨接法(End-Span)：在传输数据所用的芯线上同时传输直流电,其输电采用与以太网数据信号不同的频率。总共只需要4芯线，既传数据，也可以供电。 我司开发的POE模块支持IEEE 802.3at标准也兼容IEEE 802.3af标准，采用标准的38*38大小，同时支持mid-span及end-span两种方法，可以与我们现有的电源板直接对接，有着极好的兼容性，使用方便。
二、接口说明 1.1 POE 模块正面接口 图1 POE 正面图 表1 POE 正面详细接口列表 图中代号 接口详细编号 接口定义 接口定义 实现功能 P1 1 NC 空脚 2 NC 空脚 3 GND 地 4 +12Vin +12V 电源输入 输入 P2 1 +48 48V 正极 输入 2 +48_GND 48V 负极 输入 3 GND 地 4 +12Vin +12V 电源输出 输出
开发接口文档-API文档模板
XXX项目接口文档 版本控制信息 1获取所有字段 1.1获取所有字段 请求地址：/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,"iconStyle":"","id":4,"name":"XX"},{"iconColour":"","iconSize":0,"iconStyle":"","id":5,"name":"XX"},{"icon Colour":"","iconSize":0,"iconStyle":"","id":7,"name":"XX"}]},"totals":0}
2文件上传 2.1文件上传（ajax） 请求地址：/session/file/upload formData.append("file", this.files[0]); $.ajax({ url : routePath + "/session/file/upload", type : 'POST', data : formData, processData : false, contentType : false, success : function(result) { result = JSON.parse(result); if(result.code == "10000"){ layer.msg('上传成功！'); $("#editHeadPortrait").val(result.returnValue.filePath); } } }); 响应例子：returnValue里包含了 fileName和filePath 3字段管理-所属类型 3.1新增所属类型 请求地址：/session/fieldType/save
软件需求说明书编写规范
软件需求说明书编写规范
————————————————————————————————作者：————————————————————————————————日期: ?
案卷号 日期 <项目名称＞ 软件需求说明书 作者:王浩天 完成日期: 8.２3 签收人： 签收日期: 修改情况记录: 版本号修改批准人修改人安装日期签收人
目录 １引言 .................................................................................................. 错误!未定义书签。 1.1 编写目的.................................................................................................... 错误!未定义书签。 1.2范围?错误!未定义书签。 1．３定义?错误!未定义书签。 1．４参考资料............................................................................................... 错误!未定义书签。 2 项目概述?错误!未定义书签。 2.１产品描述?错误!未定义书签。 2．2 产品功能................................................................................................. 错误!未定义书签。2．3 用户特点................................................................................................. 错误!未定义书签。 2.4 一般约束.................................................................................................... 错误!未定义书签。 ２.５假设和依据............................................................................................ 错误!未定义书签。 ３具体需求?错误!未定义书签。 3.1 功能需求.................................................................................................... 错误!未定义书签。 3.1.1 功能需求１?错误!未定义书签。 3.1.2 功能需求２......................................................................................... 错误!未定义书签。 3.１.ｎ功能需求n...................................................................................... 错误!未定义书签。 ３．2 外部接口需求....................................................................................... 错误!未定义书签。 3.2.1 用户接口?错误!未定义书签。 3.２.2 硬件接口?错误!未定义书签。 3．２．３软件接口................................................................................. 错误!未定义书签。 3.2．4 通信接口?错误!未定义书签。 ３．3 性能需求?错误!未定义书签。 3.4 设计约束.................................................................................................... 错误!未定义书签。 ３.4．１其他标准的约束.......................................................................... 错误!未定义书签。 ３.4.2 硬件的限制?错误!未定义书签。 3.5 属性?错误!未定义书签。 3.5.１可用性?错误!未定义书签。 3.5.2 安全性?错误!未定义书签。 3．5．3 可维护性....................................................................................... 错误!未定义书签。 3．5．4 可转移\转换性............................................................................ 错误!未定义书签。 3.5.5 警告?错误!未定义书签。 3.6 其他需求.................................................................................................... 错误!未定义书签。 3．6．1 数据库........................................................................................... 错误!未定义书签。 3.6．２操作 (7) ３．６.３场合适应性需求?错误!未定义书签。 ４附录 .................................................................................................. 错误!未定义书签。
需求说明书编写规范
需求规格说明书 软件需求规格说明书是软件开发过程需求分析阶段需要产出的文档，是为了使用户和软件开发者对软件的规格有一个共同的理解而撰写的，软件需求规格说明有标准的模板 方法/步骤 第一章是引言。 描述软件需求规格说明书的纵览，帮助读者理解文档如何编写并且如何阅读和理解，包含五
个部分： 1.1 编写目的 //对产品(项目)进行定义，在该文档中详尽说明这个产品的软件需求，包 //括修正或发行版本号。如果这个软件需求规格说明书只与整个系统的一 //部分有关，那么只定义文档中说明的部分或子系统。 1.2 文档约定 //描述编写文档时所采用的标准或排版约定，包括正文风格，提示区或重 //要符号。例如，说明高层需求的优先级是否可以被所有细化分需求所继 //承，或者每个需求陈述是否都有优先级。 1.3 读者对象和阅读建议 //列举软件需求规格说明书所针对的不同读者，例如开发人员、项目经理、//营销人员、用户、测试人员等。描述文档中剩余部分的内容及其组织结//构。提出最适合每一类读者阅读文档的建议。 1.4 项目范围 //提供对指定的软件及其目的的简短描述，包括利益和目标。把软件与企业 //目标或业务策略相联系。可以参考项目范围文档，而不是将其内容复制到 //这里 1.5 参考资料 //列举编写软件需求规格说明书时所参考的资料或其它来源。可能包括用户 //界面风格指导、合同、标准、系统需求规格说明书，用户需求、相关产品 //的软件需求规格说明书。这里应给出详细的信息，包括标题名称、作者、 //版本号、日期、出版单位或资料来源，以方便读者查阅这些文献。
第二章是总体描述。包含六个部分： 2.1 产品前景 //描述软件需求规格说明书中所定义的产品的背景和起源。说明该产品是否 //是产品系列中的下一个成员，是否是成熟产品所改进的下一代产品，是否 //是现有应用程序的替代品，或者什邡市一个全新的产品。 //如果软件需求规格说明书定义了大系统的一个组成部分，那么就要说明这 //部分软件是怎样与整个系统相关联的，并且要定义出两者之间的接口。建 //议使用系统结构图或者实体关系图表示 2.2 产品的功能 //概述产品所具有的主要功能，详细内容在第4节描述，所以这里只需要概括 //总结，例如用列表的方法给出。很好地组织产品的功能，使每个读者都易 //于理解。用图形表示主要的需求分组以及它们之间的联系。 //建议使用数据流程图（DFD）的顶层图或者类图来实现图形化
财付通接口文档及代码
财付通API接口文档样例代码 引言 文档概述 本文描述了财付通开放平台的JAVA SDK，帮助开发者轻松实现在线支付、收付款等功能。文档详细介绍了财付通开放平台的工作方式和开发过程，可以帮助开发人员快速入门并掌握开发技能，同时也可以作为日后接口参数以及参数类型的速查手册。 阅读对象 具有WEB程序开发背景，了解JAVA语言。 业务术语 接口业务流程 支付流程 支付流程中，用户在财付通APP中购买业务，通过财付通支付平台进行支付。典型业务流程如下：
买家在财付通APP上浏览下单购买一个商品，财付通APP会生成一个支付链接，此链接通过用户的浏览器跳转到财付通开放平台，财付通通过此链接获取支付请求的参数，引导用户完成支付过程。 用户在财付通完成支付后，财付通通过return_url将用户浏览重新定向到财付通APP，财付通APP 向用户提示订单状态和后续操作。同时，财付通会通过后台回调财付通APP的notify_url，财付通APP在收到支付结果通知后可以根据通知ID查询通知内容，在确保支付成功后再进行业务逻辑处理（例如发货），这样可以进一步提高安全性，防止伪支付成功结果的诈骗。 通知查询/订单查询流程 通知查询/订单查询是指财付通APP向财付通系统发送查询请求，并同步等待财付通系统处理完毕后返回的响应数据。数据交互是财付通APP与财付通服务器直接通信。 例如用户在财付通APP查询时，财付通APP要确认用户某个订单是否支付成功，可以向财付通发送一个查询请求，财付通收到请求后返回查询结果，财付通APP处理结果后再显示给用户。
后台通知流程 后台通知是指财付通系统主动向财付通APP发送通知数据，并同步等待财付通APP处理完毕后返回的响应数据。数据交互是财付通服务器与财付通APP直接通信，一般请求采用http的get或post，应答用字符串格式。 用户在财付通支付成功后，财付通会在后台通过notify_url向财付通APP发起通知，财付通APP 处理后成功返回success，失败返回fail或其他字符。 补单机制 对后台通知流程，如果财付通收到财付通APP的应答不是success或由于网络异常超时，财付通认为通知失败，财付通会通过一定的策略（如1分钟、2分钟、4分钟、8分钟、16分钟、32分钟，共6次）定期重新发起通知，尽可能提高通知的成功率，但财付通不保证通知最终能成功。 由于上述原因，可能存在同样的通知多次发送给财付通APP的情况。财付通APP必须能够正确处理，在收到重复的后台通知不重复引发业务流程（例如发货）。 财付通推荐的做法是，当收到财付通发送的通知消息时，需要检查本系统内订单的状态，判断该通知是否已经处理过。为防止并发产生的问题，在对业务数据进行状态检查和处理之前，要求采用加锁判断进行并发控制。 功能划分 财付通APP负责与之业务相关的代码和页面。 财付通开放平台提供支付相关的业务功能和页面。具体业务功能请参照后面章节SDK说明 支付页面如下： 在小钱包中：
需求规格说明书SRS(标准)
<项目名称> 需求规格说明书 腾讯科技（深圳）有限公司版权所有侵权必究
修订记录
目录 修订记录 (2) 目录 (3) 1前言 (4) 1.1文档目的和范围 (4) 1.2参考文献 (4) 1.3术语表 (4) 2总体描述 (4) 2.1业务执行角色 (4) 2.2运行环境 (5) 2.3设计和实现上的约束 (5) 2.4整体流程/逻辑关系 (5) 3特性 (5) 3.1特性F MMM F EA TURE (5) 3.1.1特性描述 (5) 3.1.2功能性需求(Functional Requirements，FR) (6) 3.1.2.1Fmmm.FR.nnn 功能需求1 (6) 3.1.3性能需求（Performance Requirements，PR） (6) 3.1.3.1Fmmm.PR.nnn 性能需求1 (6) 3.1.4用户界面（User Interface，UI） (6) 3.1.5接口需求（Interface Requirements，IR） (6) 3.1.6安全性需求（Security Requirements ,SR） (7) 3.1.7国际化需求(Internationalization Requirements,I18NR ) (7) 3.1.8数据统计需求(Date Statistic Requirements，DSR) (7) 3.1.9其他需求 (7) 3.1.10该特性受限时的用户体验 (7) 3.2特性F MMM F EA TURE (7) 4附录 (8)
说明：本文中蓝色斜体字体为说明性文字，写文档时请删除。 1前言 1.1文档目的和范围 1)文档目的:本文档针对 **系统/模块的目标、范围的描述，以此作为系统选型、设计、 开发和实施的依据。 2)范围：软件产品名称标识 ****。说明产品将干什么，若需要还将说明产品不干什么。 1.2参考文献 说明：列出本文档的所有参考文献（可以是非正式出版物）； 格式如：[标识符] 作者，文献名称，出版单位（或归属单位），日期；参考网址则列出URL。 1.3术语表 说明：列出本文档中所用到的专门术语的定义和缩略语的全称和解释。 2总体描述 2.1业务执行角色 说明：阐述本产品的各种角色及其相应的活动或权限。各种角色的具体行为将在功能性需求中描述。如QQ会员、蓝钻、黄钻用户等