HTTP接口文档
HTTP接口文档
接口域名：
一、工作方式....................................................................... 错误!未定义书签。
1.1 密码验证方式............................................................................... 错误!未定义书签。
二、字符编码....................................................................... 错误!未定义书签。
三、响应格式....................................................................... 错误!未定义书签。
四、短信发送（单条，多条发送）...................................... 错误!未定义书签。
五、接收状态报告................................................................ 错误!未定义书签。
5.1 主动获取状态............................................................................... 错误!未定义书签。
六、接收上行短信（回复）................................................. 错误!未定义书签。
6.1 主动接收上行短信（回复） ......................................................... 错误!未定义书签。
6.2 推送接收上行短信（回复） ......................................................... 错误!未定义书签。
七、取剩余短信条数............................................................ 错误!未定义书签。
八、取已发送总条数............................................................ 错误!未定义书签。
九、接口安全（绑定IP）.................................................... 错误!未定义书签。
十、取发送记录 ................................................................... 错误!未定义书签。
一、工作方式
双方通过HTTP方式交互数据，第三方可以简单的“name=value”方式发送提交内容或响应请求内容。即通过HTTP的GET/POST方式交换。
另外双方需要保证数据传输的完整性和安全性，每次发送请求都有响应(响应返回格式为纯文本)，安全验证目前采用用户名、密码和IP绑定的方式。
1.1 密码验证方式
接口密码使用“登录密码”与“用户名”拼接字符串后能过md5加密进行验证
如登录密码是：123123
如用户名是：test
接口密码（pwd）=md5(登录密码+用户名)
pwd=md5(123123test)
pwd=b9887c5ebb23ebb294acab183ecf0769
二、字符编码
服务器接收数据可以是GBK或UTF-8编码字符,默认接收数据是GBK编码,如提交的是UT F-8编码字符,需要添加参数encode=utf8。
请求响应返回内容是GBK编码。
三、响应格式
所为响应即每次向服务器提交请求后返回值
响应值格式为纯文本
四、短信发送（单条，多条发送）
GET/POST操作格式：
/?uid=用户账号&pwd=MD532位密码&mobile=号码&mobileids=消息编号&cont ent=内容
接口参数说明:
接收号：,1390000test,
发送内容：发送测试
/?uid=test&pwd=b9887c5ebb23ebb294acab183ecf0769&mobile=,1390000test,&mo bileids=888,1390000test,666&content=%B7%A2%CB%CD%B2%E2%CA%D4
发成功时响应状态码值:
sms&stat=100&message=发送成功
stat 状态码
http接口说明模板
一、查询菜品列表接口(DONE) 1、功能说明 接受提供的菜品 XXX画面XXX功能（比如人口查询画面-查询 | 人口查询画面-详细等） 2、接口调用说明 2.1获取地址 http://192.168.0.6:8080/FamilyServiceSystem/BookDinnerQueryAction?ope ration=queryServiceItem 2.2http请求方式 GET 2.3数据返回格式 JSON 2.4传递参数
2.5成功返回结果 [ “serverResponse”:”Success”, “totalRecords”:”52”, “page” : “10”, “pageSize” : “5”, “data”：{ “id” : “123”, “itemName” : “皇堡”, “priceNow” : “10”, “pricePast” : “12”, “servicePicture” :”s9118668.jpg”, “serviceStars” : “3” }, ……. { “id” : “”, “itemName” : “”, “priceNow” : “”, “pricePast” : “”, “servicePicture” :” s9118668.jpg”,
“serviceStars” : “3” } ] 2.6返回结果解释 二、查询广告接口（DONE） 1、功能说明 接受广告图片，目前为一张 2、接口调用说明 2.1获取地址 http://192.168.0.6:8080/FamilyServiceSystem/BookDinnerQueryAction?ope ration=queryAdvertisePicture
系统设计文档模板
系统设计说明书（架构、概要、详细）目录结构 虽然这些文档一般来说公司都是有模板的，但我写这些文档以来基本上是每写一次就把目录结构 给改一次，应该说这是因为自己对这些文档的理解开始加深，慢慢的越来越明白这些文档的作用 和其中需要阐述的东西，觉得这三份文档主要阐述了一个系统的设计和实现过程，从系统分解为层次、层次内的模块以及相互的接口、模块分解为对象以及对象的接口、实现这些对象接口的方法。这次又整了一份，A/ ，欢迎大家指正。 XXX架构设计说明书 （架构设计重点在于将系统分层并产生层次内的模块、阐明模块之间的关系）一?概述 描述本文的参考依据、资料以及大概内容。 二.目的 描述本文编写的目的。 三.架构设计 阐明进行架构设计的总体原则，如对问题域的分析方法。 3.1. 架构分析 对场景以及问题域进行分析，构成系统的架构级设计，阐明对于系统的分层思想。 3.2. 设计思想 阐明进行架构设计的思想，可参考一些架构设计的模式，需结合当前系统的 实际情况而定。 3.3. 架构体系 根据架构分析和设计思想产生系统的架构图，并对架构图进行描述，说明分层的原因、层次的职责，并根据架构图绘制系统的物理部署图，描述系统的部署体系。3.4. 模块划分 根据架构图进行模块的划分并阐明模块划分的理由，绘制模块物理图以及模
块依赖图。 341. 模块描述 根据模块物理图描述各模块的职责，并声明其对其他模块的接口要求。。 3.4.2. 模块接口设计 对模块接口进行设计，并提供一定的伪代码。 XXX概要设计说明书 （概要设计重点在于将模块分解为对象并阐明对象之间的关系） 一.概述 描述本文的参考依据、资料以及大概内容。 二.目的 描述本文的编写目的。 三.模块概要设计 引用架构设计说明书中的模块图，并阐述对于模块进行设计的大致思路。 3.1. 设计思想 阐明概要设计的思想，概要设计的思想通常是涉及设计模式的。 3.2. 模块A 3.2.1. 概要设计 根据该模块的职责对模块进行概要设计（分解模块为对象、描述对象的职责以及声明对象之间的接口），绘制模块的对象图、对象间的依赖图以及模块主要功能的序列图，分别加以描述并相应的描述模块异常的处理方法。 3.2.2. 模块接口实现 阐明对于架构设计中定义的模块接口的实现的设计。 XXX详细设计说明书 （详细设计重点在于对模块进行实现，将模块的对象分解为属性和方法，并阐述 如何实现）
百度知道开放平台openAPI接口规范文档 V1.0
百度知道开放平台OPEN API接口规范文档 V 1.0 系统名称百度知道开放平台OPEN API服务接口 项目负责人 作者陈霖 文档提交日期2010-11-04 百度在线网络技术（北京）有限公司 (版权所有,翻版必究)
修改记录 No 修改后 版本号 修改内容简介修改日期修改人 1 1.0 百度知道OPEN API服务接口2010-11-04 陈霖
目录 1背景 (6) 2规范适用对象说明 (6) 3名词解释 (6) 4请求数据包格式规范 (6) 4.1URL (6) 4.2参数 (7) 4.2.1系统级参数 (7) 4.2.2业务级参数的通用约定 (7) 4.2.3参数签名算法 (7) 5响应数据包格式规范 (8) 5.1XML输出格式 (8) 5.2json输出格式 (9) 5.3错误响应输出格式 (9) 6错误码定义 (10) 7API接口细则 (10) 7.1baidu.zhidao.getCatalogInfo (10) 7.1.1功能 (10) 7.1.2参数 (11) 7.1.3返回值 (11) 7.2baidu.zhidao.getQuestionList (11) 7.2.1功能 (11) 7.2.2参数 (11) 7.2.3返回值 (12) 7.3baidu.zhidao.getQuestionSearch (12) 7.3.1功能 (12) 7.3.2参数 (12) 7.3.3返回值 (13) 7.4baidu.zhidao.getQuestionInfo (13) 7.4.1功能 (13) 7.4.2参数 (13) 7.4.3返回值 (14) 7.5baidu.zhidao.getQuestionAnswer (14) 7.5.1功能 (14) 7.5.2参数 (14) 7.5.3返回值 (15) 7.6baidu.zhidao.getUserInfo (15) 7.6.1功能 (15) 7.6.2参数 (15) 7.6.3返回值 (15) 7.7baidu.zhidao.getUserQuestionList (16) 7.7.1功能 (16) 7.7.2参数 (16)
海康威视摄像头HTTP接口能力调研报告
视频监控平台调研报告【海康】
目录
1.前言 本次从海康租借了一台硬盘录像机、一个枪机和一个球机。由于对方HTTP告警消息模块有BUG，调测花费时间较长。对方提供升级测试版本后已经解决。从目前的进展情况看基本完成了我们的预期目标。主要常用功能均已验证通过，包括：视频监控（VLC插件方式）、录像回放、读取设备信息、设备重启、图像抓拍、告警通知、云台控制。本次报告主要目的是记录相关功能具体实现和验证的方式方法及注意事项。 2.部署情况 租借的三台设备均部署在五层实验室，通过无线路由器连接到公司网络。 1)账号信息 设备类型设备型号IP地址管理账号密码 枪机DS-2CD2T20-I3admin Nuctech123 录相机DS-8608N-E8admin Nuctech123 球机DS-2DE7184-A admin Nuctech123 2)设备部署&端口映射 3)设备配置注意事项 IPC和NVR均需要通过修改管理员密码才可以激活，然后接入网络； 录相机（NVR）标准配置都是不带硬盘，所以需要事先准备好SATA硬盘； 录相机（NVR）在接入枪机时，自动识别的设备协议为“海康协议”但实际需要根据说 明书修改为ONVIF才可以，否则会一直报“未知错误“； 枪机（IPC）须另备 DC12V Φ圆头电源； 设备因为是租借来的，所以不是全新，建议配置调试之前先做出厂设置； 设备默认出厂IP均为： 3.视频监控
3.1主码流与字码流 主码流与子码流是海康威视提出的概念，是为了解决在网络情况不好时为了满足远程预览的流畅性，而不影响本地录像提出的双码流技术，主码流分辨率高于子码流，主码流用来录像，子码流用来网传，默认客户端访问采用主码流，客户可以根据网络情况选择子码流访问，以达到改善网络浏览的流畅性，而又不改变本地录像的录像效果。 3.2RTSP地址格式 (1)摄像头(IPC/IPD) 地址格式： username: pwd @ ip: port [554]/h264/ch1/码流类型/av_stream 码流类型：main表示为主码流，sub表示为子码流 举例： IPC主码流： number >，1-32是模拟通道，33以后是IP通道。 举例： IPC@NVR：举例： ，设备 信息和配置推荐使用ISAPI接口，云台控制则推荐使用CGI接口。 接口入口地址：，GET表示读取当前信息、PUT表示更新配置、POST表示创建数据、DELETE表示删除配置。 3.3设备信息 3.3.1基本信息 调用地址：/ISAPI/System/deviceInfo
百度知道OPEN API接口规范文档1.0_final
百度知道OPEN API接口规范文档V1.0 系统名称百度知道OPEN API服务接口 项目负责人 作者耿艳坤 文档提交日期2010-08-26 百度在线网络技术（北京）有限公司 (版权所有,翻版必究)
修改记录 No 修改后 版本号 修改内容简介修改日期修改人 1 1.0 百度知道OPEN API服务接口2010-08-26 耿艳坤
目录 1背景 (4) 2规范适用对象说明 (4) 3名词解释 (4) 4请求数据包格式规范 (4) 4.1URL (4) 4.2参数 (4) 4.2.1系统级参数 (4) 4.2.2业务级参数的通用约定 (5) 4.2.3参数签名算法 (5) 5响应数据包格式规范 (6) 5.1XML输出格式 (6) 5.2json输出格式 (6) 5.3错误响应输出格式 (7) 6错误码定义 (7) 7API接口细则 (8) 7.1baidu.zhidao.getQuestionList (8) 7.1.1功能 (8) 7.1.2参数 (8) 7.1.3返回值 (8) 7.2baidu.zhidao.getQuestionSearch (9) 7.2.1功能 (9) 7.2.2参数 (9) 7.2.3返回值 (9) 7.3baidu.zhidao.getQuestionInfo (10) 7.3.1功能 (10) 7.3.2参数 (10) 7.3.3返回值 (10) 7.4baidu.zhidao.getQuestionAnswer (11) 7.4.1功能 (11) 7.4.2参数 (11) 7.4.3返回值 (12) 7.5baidu.zhidao.question (12) 7.5.1功能 (12) 7.5.2参数 (12) 7.5.3返回值 (12) 7.6baidu.zhidao.answer (13) 7.6.1功能 (13) 7.6.2参数 (13) 7.6.3返回值 (13) 8第三方提供API接口细则 (14) 9附件及参考资料 (15)
Place API http接口使用说明
PlaceAPI http 接口使用说明 1.1 Place API http 接口简介 Place API http 接口（以下简称http 接口）是一个供程序员调用的、http 形式的地图检索服务接口，且只向百度合作伙伴开放。 目前http 接口提供的功能包括：矩形区域关键字检索、周边区域关键字检索（也称：圆形区域检索）和城市内关键字检索。http 接口主要服务那些非网页程序的调用，例如：C# 、C++、Java 等开发的应用程序，这些开发语言都能发送http 请求且能接收返回数据。http 接口可以返回xml 和json 两种不同形式的的地理数据。 目前提供的功能不是很多、以后随着用户需求的收集和总结，会不断完善http 接口。 1.2 Place API http 接口使用说明 http 接口使用分为3个步骤：第一步，申请注册key ；第二步，拼写http 请求发送的url ，url 中附带上第一步申请的key 值；第三步，接收http 请求返回的数据（json 或xml 格式），如下图示意： 1.2.1申请注册key 说明 用户打开https://www.wendangku.net/doc/226873579.html,/wiki/static/mapws/placeapikey/页面，在此页面中申请注册key 值。该key 主要目的是判断用户请求的url 是否合法，且限制用户1天发送的http 请求数不能超过1000次。注册页面如下图：
填写好信息后，点击生成API密钥按钮就获取到所需的key值了，申请的key值和应用程序名称相关联，既相同的应用程序名称返回的key值是一样的。 特别注意：申请key之前会提示用户首先注册百度账号，只有拥有了百度账号，才能顺利的申请key值。 1.2.2 http接口请求参数说明 http接口请求参数主要包括：检索关键字、检索区域（3种选择形式）、输出结果类型（xml或json）,如下表：
软件详细设计文档模板(最全面)
研发生产中心文档编号版本A1 密级商密A 项目名称Xx系统 项目来源 Xxx系统 详细设计说明书 (内部资料请勿外传) 编写：日期：检查：日期：审核：日期：批准：日期： XX公司 版权所有不得复制 文档变更记录
序号变更（+/-）说明作者版本号日期批准1 2
目录 1. 引言 (5) 1.1 编写目的和范围 (5) 1.2 术语表 (5) 1.3 参考资料 (5) 1.4 使用的文字处理和绘图工具 (5) 2. 全局数据结构说明 (7) 2.1 常量 (7) 2.2 变量 (8) 2.3 数据结构 (8) 3. 模块设计 (9) 3.1 用例图 (9) 3.2 功能设计说明 (10) 3.2.1 模块1 (10) 3.2.2 模块2 (11) 4. 接口设计 (12) 4.1 内部接口 (12) 4.2 外部接口 (12) 4.2.1 接口说明 (12) 4.2.2 调用方式 (12) 5. 数据库设计 (12) 6. 系统安全保密设计 (12) 6.1 说明 (12) 6.2 设计 (12) 6.2.1 数据传输部分 (12) 6.2.2 IP过滤分部 (13) 6.2.3 身份验证部分 (13) 7. 系统性能设计 (13) 8. 系统出错处理 (13)
1.引言 1.1背景 此文档的背景 1.2编写目的和范围 说明写这份详细设计说明书的目的。 本详细设计说明书编写的目的是说明程序模块的设计考虑，包括程序描述、输入/输出、算法和流程逻辑等，为软件编程和系统维护提供基础。本说明书的预期读者为系统设计人员、软件开发人员、软件测试人员和项目评审人员。 1.3术语表 定义系统或产品中涉及的重要术语，为读者在阅读文档时提供必要的参考信息。 序号术语或缩略语说明性定义 1 PM Project Manager,项目经理 2 1.4参考资料 列出有关资料的名称、作者、文件编号或版本等。参考资料包括： a．需求说明书、架构设计说明书等； b．本项目的其他已发表的文件； c．引用文件、资料、软件开发标准等。 资料名称作者文件编号、版本资料存放地点 1.5使用的文字处理和绘图工具 文字处理软件：[编写设计文档使用的文字处理软件，如RedOffice ] 绘图工具：[使用的UML工具，如Rose、Jude、Visio]
开发接口文档-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}
(完整word)软件项目文档全套模板-需求说明,推荐文档
＜项目名称＞ 软件需求说明书 作者： 完成日期： 签收人： 签收日期： 修改情况记录：
目录 1 引言 (1) 1.1 编写目的 (1) 1.2 范围 (1) 1.3 定义 (1) 1.4 参考资料 (1) 2 项目概述 (2) 2.1 产品描述 (2) 2.2 产品功能 (2) 2.3 用户特点 (2) 2.4 一般约束 (2) 2.5 假设和依据 (3) 3 具体需求 (3) 3.1 功能需求 (3) 3.1.1 功能需求1 (3) 3.1.2 功能需求2 (4) 3.1.n 功能需求n (5) 3.2 外部接口需求 (5) 3.2.1 用户接口 (5) 3.2.2 硬件接口 (5) 3.2.3 软件接口 (5) 3.2.4 通信接口 (6) 3.3 性能需求 (6) 3.4 设计约束 (6) 3.4.1 其他标准的约束 (6) 3.4.2 硬件的限制 (7) 3.5 属性 (7) 3.5.1 可用性 (7) 3.5.2 安全性 (7) 3.5.3 可维护性 (7) 3.5.4 可转移＼转换性 (8) 3.5.5 警告 (8) 3.6 其他需求 (8) 3.6.1 数据库 (8) 3.6.2 操作 (8) 3.6.3 场合适应性需求 (9) 4 附录 (9)
1 引言 1.1 编写目的 说明编写这份软件需求说明书的目的，指出预期的读者范围。 1.2 范围 说明： a．待开发的软件系统的名称； b．说明软件将干什么，如果需要的话，还要说明软件产品不干什么； c．描述所说明的软件的应用。应当： 1）尽可能精确地描述所有相关的利益、目的、以及最终目标。 2）如果有一个较高层次的说明存在，则应该使其和高层次说明中的类似的陈述相一致（例如，系统的需求规格说明）。 1.3 定义 列出本文件中用到的专门术语的定义和缩写词的原词组。 1.4 参考资料 列出要用到的参考资料，如： a．本项目的经核准的计划任务书或合同、上级机关的批文； b．属于本项目的其他已发表的文件； c．本文件中各处引用的文件、资料，包括所要用到的软件开发标准。 列出这些文件的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。
共享平台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.wendangku.net/doc/226873579.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 普通政策请求参数
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。
HTTP接口文档
HTTP接口文档 接口域名： 一、工作方式....................................................................... 错误!未定义书签。 1.1 密码验证方式............................................................................... 错误!未定义书签。 二、字符编码....................................................................... 错误!未定义书签。 三、响应格式....................................................................... 错误!未定义书签。 四、短信发送（单条，多条发送）...................................... 错误!未定义书签。 五、接收状态报告................................................................ 错误!未定义书签。 5.1 主动获取状态............................................................................... 错误!未定义书签。 六、接收上行短信（回复）................................................. 错误!未定义书签。 6.1 主动接收上行短信（回复） ......................................................... 错误!未定义书签。 6.2 推送接收上行短信（回复） ......................................................... 错误!未定义书签。 七、取剩余短信条数............................................................ 错误!未定义书签。 八、取已发送总条数............................................................ 错误!未定义书签。 九、接口安全（绑定IP）.................................................... 错误!未定义书签。 十、取发送记录 ................................................................... 错误!未定义书签。 一、工作方式 双方通过HTTP方式交互数据，第三方可以简单的“name=value”方式发送提交内容或响应请求内容。即通过HTTP的GET/POST方式交换。 另外双方需要保证数据传输的完整性和安全性，每次发送请求都有响应(响应返回格式为纯文本)，安全验证目前采用用户名、密码和IP绑定的方式。 1.1 密码验证方式 接口密码使用“登录密码”与“用户名”拼接字符串后能过md5加密进行验证 如登录密码是：123123 如用户名是：test 接口密码（pwd）=md5(登录密码+用户名) pwd=md5(123123test) pwd=b9887c5ebb23ebb294acab183ecf0769 二、字符编码 服务器接收数据可以是GBK或UTF-8编码字符,默认接收数据是GBK编码,如提交的是UT F-8编码字符,需要添加参数encode=utf8。 请求响应返回内容是GBK编码。 三、响应格式 所为响应即每次向服务器提交请求后返回值
软件开发文档模板库
软件开发文档模板库 1 可行性研究报告 可行性研究报告的编写目的是：说明该软件开发项目的实现在技术、经济和社会条件方面的可行性；评述为了合理地达到开发目标而可能先择的各种方案；说明论证所选定的方案。 可行性研究报告的编写内容要求如下： 1.1 引言 1.1.1 编写目的 1.1.2 背景 1.1.3 定义 1.1.4 参考资料 1.2 可行性研究的前提 1.2.1 要求 1.2.2 目标 1.2.3 条件、假定和限制 1.2.4 进行可行性研究的方法 1.2.5 评价尺度 1.3 对现有系统的分析 1.3.1 数据流程和处理流程 1.3.2 工作负荷 1.3.3 费用开支 1.3.4 人员 1.3.5 设备 1.3.6 局限性 1.4 所建议的系统 1.4.1 对所建议系统的说明 1.4.2 数据流程各处理流程 1.4.3 改进之处 1.4.4 影响 1.4.4.1 对象设备的影响 1.4.4.2 对软件的影响 1.4.4.3 对用户单位机构的影响 1.4.4.4 对系统动行的影响 1.4.4.5 对开发的影响 1.4.4.6 对地点和设施的影响 1.4.4.7 对经费开支的影响 1.4.5 局限性 1.4.6 技术条件方面的可行性 1.5 可选择其他系统方案 1.5.1 可选择的系统方案1
1.5.2 可选择的系统方案2 …… 1.6 投资及收益分析 1.6.1 支出 1.6.1.1 基本建设投资 1.6.1.2 其他一次性支出 1.6.1.3 非一次性支出 1.6.2 收益 1.6. 2.1 一次性收益 1.6. 2.2 非一次性收益 1.6. 2.3 不可定量的收益 1.6.3 收益/投资比 1.6.4 投资回收周期 1.6.5 敏感性分析 1.7 社会条件方面的可行性 1.7.1 法律方面的可行性 1.7.2 使用方面的可行性 1.8 结论 2 项目开发计划 编制项目开发计划的目的是用文件的形式，把对于在开发过程中各项工作的负责人员、开发进度所需经费预算、所需软、硬件条件等问题作出安排记载下来，以便根据本计划开展和检查本项目的开发工作。编制内容要求如下： 2.1 引言 2.1.1 编写目的 2.1.2 背景 2.1.3 定义 2.1.4 参考资料 2.2 项目概述 2.2.1 工作内容 2.2.2 主要参加人员 2.2.3 产品及成果 2.2. 3.1 程序 2.2. 3.2 文件 2.2. 3.3 服务 2.2. 3.4 非移交产品 2.2.4 验收标准 2.2.5 完成项目的最迟期限 2.2.6 本计划的审查者与批准者 2.3 实施总计划 2.3.1 工作任务的分解 2.3.2 接口人员 2.3.3 进度 2.3.4 预算 2.3.5 关键问题
软件详细设计文档模板
项目编号： （项目名称） 软件详细设计报告文件编号：生效日期：年月日 编制：日期：审核： 日期： 批准： 日期：同方锐安科技有限公司
目录 1. 引言 (1) 1.1编写目的 (1) 1.2项目风险 (1) 1.3文档约定 (1) 1.4预期读者和阅读建议 (1) 1.5参考资料 (2) 2. 支撑环境 (2) 2.1数据库管理系统 (2) 2.2开发工具、中间件以及数据库接口 (2) 2.3硬件环境 (2) 2.4网络环境 (3) 2.5多种支撑环境开发要点 (3) 3. 部件详细设计 (4) 4. 词汇表 (5) 5. 部件表格式 (5) 6. 界面表格式 (6)
1. 引言 引言是对这份软件系统详细设计报告的概览，是为了帮助阅读者了解这份文档如何编写的，并且应该如何阅读、理解和解释这份文档。 1.1 编写目的 说明这份软件系统详细设计报告是基于哪份软件产品需求分析报告、哪份软件产品概要设计报告和哪份软件产品数据库设计说明书(如果该软件产品需要数据库支持)编写的，开发这个软件产品意义、作用、以及最终要达到的意图。通过这份软件系统详细设计报告详尽说明了该软件产品的编码结构，从而对该软件产品的物理组成进行准确的描述。 1.2 项目风险 具体说明本软件开发项目的全部风险承担者，以及各自在本阶段所需要承担的主要风险，首要风险承担者包括： ●任务提出者； ●软件开发者； ●产品使用者。 1.3 文档约定 描述编写文档时所采用的标准(如果有标准的话)，或者各种编写约定。 编写约定包括： ●部件编号方式； ●界面编号方式； ●命名规范： ● 1.4 预期读者和阅读建议 列举本软件系统详细设计报告所针对的各种不同的预期读者，描述文档中，其余部分的内容及其组织结构，并且针对每一类读者提出最适合的文档阅读建议。 读者包括： ●开发人员； ●项目经理； ●测试人员； ●文档编写人员； ●
项目接口需求及设计说明文档(模板)
媒讯集团E A S项目 CTC与EAS接口 需求及设计说明书 文档作者： 创建日期：2013-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来生成客户端代理。
开心网API接口说明文档
开心网API接口说明文档 以下是为大家整理的开心网ApI接口说明文档的相关范文，本文关键词为开心,ApI,接口,说明,文档,oauth,认证,获取,授权，您可以从右上方搜索框检索更多相关文章，如果您觉得有用，请继续关注我们并推荐给您的好友，您可以在综合文库中查看更多范文。 1.oauth认证 ①获取未授权的Requesttoken 需要第三方应用程序的ApIKey和ApIsecrect才能在相应的接口地址申请未授权的Requesttoken。ApIKey和ApIsecrect是第三方应用与
开心网申请获得的，在使用Kaixin_android_sdk之前，先要把/kaixin_android_sdk/src/com/kaixin/connect/Kainxin.java中的consumeR_KeY和consumeR_secRecT替换成为你申请的ApIKey和ApIsecretKey。示例代码： Kaixinkaixin=Kaixin.getInstance();Try{ //获取未授权的RequestToken If(kaixin.getRequsetToken(context,”….”)){uriuri= uri(Kaixin.Kx_AuThoRIZe_uRL+”?oauth_token”+kaixin,getRequestToken() ); startActivity(newIntent(…),uri);}} ApI提供了获得未授权的RequestToken的方法，就是getRequestToken();传两个参数，第一个是当前的上下文，第二个是callbackuRL(重定向的uRL地址)。返回类型是boolean值，false就是没有申请成功。 ②请求用户授权RequestToken uri中的保存的是请求用户授权的接口地址。 （1）此页面中会要求用户登录，然后选择同意或者拒绝对应用授权。（2）授权成功后: A:web应用会重定向到oauth_callback所指定的uRL（含返回参数）b:客户端应用(oauth_callback=oob)会在网页中给出授权码，用户需要手工将验证码输入到应用中才能完成授权流程。
http接口说明模板
http接口说明模板
一、查询菜品列表接口(DONE) 1、功能说明 接受提供的菜品 XXX画面XXX功能（比如人口查询画面-查询 | 人口查询画面-详细等） 2、接口调用说明 2.1获取地址 http://192.168.0.6:8080/FamilyServiceSystem/BookDinnerQueryAction?op eration=queryServiceItem 2.2http请求方式 GET 2.3数据返回格式 JSON 2.4传递参数 类型示例描述 参数名称是否 必须 page 是String 1 获取第几个分页的菜 品，默认第一个分页 为1
pageSize 是String 5 每页显示多少个菜 品，默认为5 isFood 是String true 查询食物还是饮料， 查询食物为true 饮料为false 饮料和食物为空 2.5成功返回结果 [ “serverResponse”:”Success”, “totalRecords”:”52”, “page” : “10”, “pageSize” : “5”, “data”：{ “id” : “123”, “itemName” : “皇堡”, “priceNow” : “10”, “pricePast” : “12”, “servicePicture” :”s9118668.jpg”, “serviceStars” : “3” }, ……. { “id” : “”, “itemName” : “”,
“priceNow” : “”, “pricePast” : “”, “servicePicture” :” s9118668.jpg”, “serviceStars” : “3” } ] 2.6返回结果解释 参数名称类型描述备注 page String 当前返回的 是第几页 id Int 菜品编号itemName String 菜品名字priceNow String 现价 pricePast String 原价servicePicture String 菜品图片 serviceStars String 菜品星级
api接口文档
接口： 接口泛指实体把自己提供给外界的一种抽象化物，用以由内部操作分离出外部沟通方法，使其能被内部修改而不影响外界其他实体与其交互的方式。 在计算机中，接口是计算机系统中两个独立的部件进行信息交换的共享边界。这种交换可以发生在计算机软、硬件，外部设备或进行操作的人之间，也可以是它们的结合。 API： API是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。用来提供应用程序与开发人员基于某软件或硬件得以访问的一组例程，而又无需访问源码，或理解内部工作机制的细节。 简介： 操作系统是用户与计算机硬件系统之间的接口，用户通过操作系统的帮助，可以快速、有效和安全、可靠地操纵计算机系统中的各类资源，以处理自己的程序。为使用户能方便地使用操作系统，OS 又向用户提供了如下两类接口： 用户接口：操作系统专门为用户提供了“用户与操作系统的接口” ，通常称为用户接口。该接口支持用户与OS 之间进行交互，即由用户向OS 请求提供特定的服务，而系统则把服务的结果返回给用户。 程序接口：操作系统向编程人员提供了“程序与操作系统的接口” ，简称程序接口，又称应用程序接口API。该接口是为程序员
在编程时使用的，系统和应用程序通过这个接口，可在执行中访问系统中的资源和取得OS 的服务，它也是程序能取得操作系统服务的唯一途径。大多数操作系统的程序接口是由一组系统调用(system call)组成，每一个系统调用都是一个能完成特定功能的子程序。 应用程序接口又称为应用编程接口，是一组定义、程序及协议的集合，通过API接口实现计算机软件之间的相互通信。API 的一个主要功能是提供通用功能集。API同时也是一种中间件，为各种不同平台提供数据共享。程序设计的实践中，编程接口的设计首先要使软件系统的职责得到合理划分。良好的接口设计可以降低系统各部分的相互依赖，提高组成单元的内聚性，降低组成单元间的耦合程度，从而提高系统的可维护性和可扩展性。