当前位置：文档库 › SDK接口说明(HTTP

SDK接口说明(HTTP

SDK接口说明（HTTP）

查询余额GetBalance

输入参数

输出参数：

调用方式：

https://www.wendangku.net/doc/2118112045.html,/GetBalance.asp?Account=***&Password=***&Channel=***

群发短信 SendSMS（返回状态报告ID）

输入参数：

输出参数：

调用方式：

https://www.wendangku.net/doc/2118112045.html,/SendSms.asp?Account=***&Password=***&Phones=***&Content=***&Channe l=***

备注：

编码：GBK 提交方式：POST多个号码请用“逗号”分隔

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详细设计说明书（详细设计重点在于对模块进行实现，将模块的对象分解为属性和方法，并阐述如何实现）

海康威视摄像头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 IP DOME ef947dd1-f70b-11b4-83a0-c056e38ef866 IPDome STD-CGI STD-CGI DS-2DE7184-A DS-2DE7184-ACCCH5 c0:56:e3:8e:f8:66 build 150129 build 141009

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/2118112045.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）,如下表：

软件详细设计文档模板(最全面)

序号变更（+/-）说明作者版本号日期批准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]

(完整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．本文件中各处引用的文件、资料，包括所要用到的软件开发标准。列出这些文件的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。

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来生成客户端代理。

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 菜品星级

软件架构设计文档模板

Software Architecture Document Version <>

目录 1.文档简介文档目的文档范围定义、缩写词和缩略语参考资料 2.架构描述方式架构视图阅读指南图表与模型阅读指南 3.架构设计目标关键功能关键质量属性业务需求和约束因素 4.架构设计原则架构设计原则备选架构设计方案及被否原因架构设计对后续工作的限制（详设，部署等） 5.逻辑架构视图职责划分与职责确定接口设计与协作机制重要设计包 6.开发架构视图 Project划分 Project 1 Project目录结构指导程序单元组织框架与应用之间的关系（可选） Project 2…… Project n…… 7.运行架构视图控制流组织

控制流的创建、销毁、通信加锁设计 8.物理架构视图物理拓扑软件到硬件的映射优化部署 9.数据架构视图持久化机制的选择持久化存储方案数据同步与复制策略 10.关键质量属性的设计原理 1.文档简介 [帮助读者对本文档建立基本印象，并为阅读后续内容扫清障碍。] 1.1文档目的 [文档目的，非项目目的。否则造成同一项目多个文档之间的内容重复，不利于文档维护。本小节应指明文档针对的读者对象，最好列出各种读者角色，并说明每种读者角色应该重点阅读的章节。] 1.2文档范围 [文档的Scope，非项目的Scope。否则造成同一项目多个文档之间的内容重复，不利于文档维护。] 1.3定义、缩写词和缩略语 [集中列举文档中的定义、缩写词和缩略语。] 1.4参考资料 [本项目经审核的计划书、合同、上级批文；本项目的其他已发表文件；本文档引用的文件资料，如软件开发标准。具体而言，应包括参考资料的题目（必须）、编号、版本号（必须）、发表日期、发布方，必要时还可以说明如何使用这些资料。] 2.架构描述方式 [为了让读者更好地理解《架构文档》，在本节应当说明文档涉及的架构视图，并指明为了描述设计决策用到了哪些图表和模型。] 2.1架构视图阅读指南 [以多视图的方式来组织《架构文档》是大势所趋。推荐的是经过优化的5视图方法，如下图所示。]

公文对外接口说明

公文对外接口说明一、REST接口 1.导出公文数据接口接口请求方式： http请求方式：POST http://ip:port/seeyon/rest/edoc/export public void test() { Map param = new HashMap(); param.put("summaryid",new String[]{"7296218641489879223"}); param.put("folder", "D:\\changx\\"); client.bindUser("chenyx"); String s =client.post("edoc/export",param,String.class); } 本地生成文件

2.导入公文数据接口接口请求方式： 3.获取公文待签收列表接口请求说明： http请求方式：GET http://ip:port/seeyon/rest/edocResource/signed?memberId={member Id} 参数说明：

4.获取公文待登记列表接口请求说明： http请求方式：GET http://ip:port/seeyon/rest/edocResource/registered?memberId={m emberId} 参数说明： 5.导出MHT公文单接口请求说明： http请求方式：POST http://ip:port/seeyon/rest/edoc/id/exportmht 参数示例： Map res = new HashMap(); String[] SummaryId={"-7993161577072146191"}; res.put("summaryid", SummaryId); res.put("folder", "F:\UFSeeyon\folder\");

java,http协议,接口

竭诚为您提供优质文档/双击可除java,http协议,接口篇一：http接口 2.客户端：通过httpinvoker代理向服务器端发送请求，远程调用服务接口的方法 3.服务器端与客户端通信的数据需要序列化配置服务器端和客户端的步骤配置服务器端 1.添加springjaR文件建议使用spring2+.jar版本 2.创建服务接口 3.创建服务接口的具体实现类 4.公开服务配置客户端 1.添加springjaR文件建议使用spring2+.jar版本 2.创建服务接口 3.访问服务实例讲解

服务器端 1.服务接口：ucservice.java 它提供两项服务，查询用户信息和记录日志，如下： publicinterfaceucservice{ publicuserinfogetuserinfobyname(stringusername); publicintrecordlog(stringusername,stringpoint,strin goperate,stringdesc);} 说明：举这个列子是因为其比较有代表性，它将展示普通数据类型（int,long等）和复杂数据类型（dto等）的远程调用方式。userinfo是一个普通的dto，代码如下：publicclassuserinfoimplementsserializable{ privatestaticfinallongserialVersionuid=-69709675067 12260305l; /**用户名*/ privatestringusername; /**电子邮箱*/ privatestringemail; /**注册日期*/ privatedateregistdate; publicstringgetusername(){

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

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

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

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

http接口

2 HTTP invoker 服务模式

2. 客户端：通过 HTTP invoker 代理向服务器端发送请求，远程调用服务接口的方法 3. 服务器端与客户端通信的数据需要序列化配置服务器端和客户端的步骤配置服务器端 1. 添加 springJAR 文件建议使用 spring2+.jar 版本 2. 创建服务接口 3. 创建服务接口的具体实现类 4. 公开服务配置客户端 1. 添加 springJAR 文件建议使用 spring2+.jar 版本 2. 创建服务接口 3. 访问服务实例讲解服务器端 1. 服务接口： UcService.java 它提供两项服务，查询用户信息和记录日志，如下： public interface UcService { public UserInfo getUserInfobyName(String userName); public int recordLog(String username, String point, String operate, String desc); } 说明：举这个列子是因为其比较有代表性，它将展示普通数据类型（ int,long 等）和复杂数据类型（ DTO 等）的远程调用方式。 UserInfo 是一个普通的 DTO ，代码如下： public class UserInfo implements Serializable { private static final long serialVersionUID= -6970967506712260305L; /**用户名*/ private String userName ;

短信HTTP接口说明文档

HTTP接口说明文档接口地址：http://203.171.227.208:9876/plan/Api/ 请先读这里: 通过API提交参数时, 参数内容编码必须为GB2312, 且经过url编码例如:“您好”的url编码为“%C4%FA%BA%C3” API返回的内容是一些键值对的字符串集合，形式为:“k1=v1&k2=v2&k3=v3…” 返回内容中的键值显示为url编码形式, 经过url解码后的键值是GB2312编码的字符串例如: 返回内容“result=0&description=%B7%A2%CB%CD%B3%C9%B9%A6&faillist=”表示的实际内容为“result=0&description=发送成功&faillist=” 1、发送短信功能描述：短信发送调用格式：http://203.171.227.208:9876/plan/Api/Send.aspx?username=用户名&password=密码&mobiles=手机号码&content=内容&f=1 返回格式:result=&description=错误描述&faillist=失败号码列表注：faillist 列表中的号码间隔为英文”,” 返回值:

2、修改密码功能描述：修改密码调用格式：http://203.171.227.208:9876/plan/Api/ChgPwd.aspx?username=用户名&password=密码&newpwd=新密码返回格式:result=&description=错误描述参数说明：返回值: 3、查询余额功能描述：查询余额调用格式：http://203.171.227.208:9876/plan/Api/Query.aspx?username=用户名&password=密码返回格式：result=返回值&balance=条数&description=错误描述注意: 当返回值为0时才同时返回条数参数说明：返回值:

接口说明

phpcms v9文章模型栏目接口第三版使用手册一、简介 1、本接口应用于phpcms v9.2.4 - v9.3.3版文章模型栏目文章发布； 2、本接口支持非默认站点发布； 3、本接口支持自动获取关键词、自动提取缩略图、自动摘要、自动分页、自定义字段等功能，详见发布接口部分说明； 4、支持网站后台栏目生成HTML设置； 5、发布时请使用具有管理权限的用户帐号； 6、本接口基于phpcms v9 UTF8版制作，适用于phpcms v9 GBK/utf-8等版本，应用于其他版本时请自行测试调整； 7、在phpcms v9 utf8版使用本接口时，请在发布规则中选择编码为UTF-8； 8、接口文件无须任何改动即可使用，如果你希望增加校验或其他功能，请仔细修改； 9、2个接口文件请复制在phpcms v9网站根目录下使用；二、安装接口在接口文件夹中找到接口文件，如图：请将etchk_cms.php、etpost_cms.php等接口文件上传到指定目录，请使用二进制方式上传，如图：三、配置发布规则 1、将范例发布规则文本导入ET2发布配置，或使用软件内置发布规则范例，如图：

2、将检查网址和发布网址中的“您的网站”改为您要发布的网站网址，如图： 3、在检查网址填上您的栏目ID，如图： 4、在检查网址填上您的站点ID，站点ID如留空则默认为1，如图： 5、在参数取值页，填上您要发布的栏目ID和站点ID，如图： 6、在网站后台内容管理-栏目管理处，可以看到各栏目的catid号，如图：

7、在网站后台-设置-站点管理中，可以查看站点ID，如图： 8、填上您的账号、密码，注意格式和账号权限，如图：

游戏数据接口说明

游戏数据接口说明游戏数据接口说明 (1) cboss系统数据接口 (1) Gm平台控制接口 (2) cboss系统数据接口一、说明：这里定义了游戏提供给cboss系统的数据结构及操作流程。二、操作流程：每个游戏线路，会收集玩家角色在该线路的登录信息，并定时（如：间隔10分钟）发送一次下面定义的所有数据到cboss系统提供的http接口。三、数据定义：四、当前在线人数(sum) 五、角色上下线记录(roles) 六、接口定义： http接口使用post协议提交数据，数据使用json格式，并用zip方式压缩；字符串数据使用utf-8编码； json格式：{"num": 当前在线人数, "roles": 角色上下线记录} 角色上下线记录json格式：[[角色名, 等级, 登录时间, 退出时间], ...] 例子：{"num": 100, "roles": [["abc", 10, "1112291212", "1112291812"], ["ddd", 11, "1112291212", "1112291812"]]} 上面例子经过Zip压缩后数据： 'x\x9c\xabV\xca+\xcdU\xb2R040\xd0QP*\xca\xcfI-\x06\xf2\xa2\xa3\x95\x12\x93\x92\x95t\x80\x c2@QCCC##KC#C#%\x04\xcf\x02\xc8\x8b\xd5Q\x88VJII\x01)4\xc4\xab0\xb6\x16\x00\x13\xc3 \x17T' 七、Cboss系统http接口地址：

Gm平台控制接口一、说明：这里定义了游戏提供给gm系统的数据结构及其操作流程。二、操作流程：游戏提供http接口，gm系统使用http POST，调用游戏提供的http 接口。接口数据结构和安全认证，使用dgapi相同的数据结构和认证机制：认证机制：由游戏方发放gm用户名和key给gm系统。gm系统使用key加密传输的具体数据，并将gm用户名和加密数据post到http接口；数据加密过程： encrypt_data = DGCrypt.encrypt(key, json_data) 加密的数据= base64.b64encode(encrypt_data) 数据解密过程： encrypt_data = base64.b64decode(加密的数据) json_data = DGCrypt.decrypt(key, encrypt_data) 数据结构：{'client': gm用户名, 'data':加密的数据} 具体细节参考dgapi；三、接口定义：说明：http接口处理post协议提交的数据，原始数据使用json格式；数据中的字符串数据使用utf-8编码； a)获取线路列表请求：{'barea':大区名, 'area':服名} 应答：{'area_key':area_key, 'list':[线路名, chl_key], [....], .....]} 说明： area_key, chl_key代表对应服或线路的唯一标识字符串，需要在后面使用；大区名、服名，从(https://www.wendangku.net/doc/2118112045.html,:8080/config/area_svr.xml)地址获取； b)系统消息发送请求：发送到整个服：{'area_key':area_key, 'message':消息, 'chat_scope':'世界', 'chat_type':消息类型, 'view_type':消息的显示位置} 发送到特定线：{'chl_key':chl_key, 'message':消息, 'chat_type':消息类型, 'view_type':消息的显示位置} 应答：{'result':Result, 'fail':失败的原因} 说明：'chat_type'：设定消息的类型：7=系统消息； 'view_type'：设定消息显示的位置：1=滚动位置 c)角色列表查询