汉王签批控件接口说明文档v2.2
汉王笔迹签名控件接口说明文档v2.2
控件使用平台
1.1操作系统平台
Windows XP，Windows Vista，Windows 7
1.2支持软件平台
（1）浏览器：
IE 浏览器V2.0 至目前IE 的最高版本（V10.0）
采用IE 内核的浏览器
注：360、搜狗、傲游等浏览器，均是双核浏览器，即兼容模式下为支持IE 内核模式，此时支持控件的加载。极速模式下为采用了Chromium 内核，此种模式下不支持加载控件。
当用户浏览签批控件所在的页面时，请将以上浏览器的模式切换至兼容模式，否则控件无法正常工作。
（2）支持com 组件调用的应用程序中
1.3控件功能
控件为浏览器的子窗口（故不能创建透明的签名窗口），可在窗口内实现带压感的原笔迹手写签字。提供接口支持笔形（压力笔/钢笔）、笔宽（共 5 级）、笔颜色、窗口边框宽度及颜色、窗口内部背景颜色的设置，支持一次性清除所有笔迹，支持对手写模块的初始化和卸载控制，支持获取签字笔迹的bmp/jpg/png/gif 图片格式的base64数据流。
上图是签批控件 HWPenSign.ocx 界面图，此控件是 ActiveX 控件，可以嵌入 到网页中使用。此控件可以提供用户定制开发，额外收取软件开发费用。
1.4 控件界面
控件接口
注：为保证图像不失真， PC 端控件显示窗口与设备窗口长宽比应一致。因此， 建议对于设备 ESP370，设置控件窗口长宽比为 8:3。对于设备 ESP560，设置控 件窗口长宽比为 5:3。
2.1 函数返回值错误码
其它返回值，参见 windows ( WinError.h 头文件中定义)常见错误码含义。
2.2 基本接口
1. LONG HWInitialize (void)
函数功能： 手写模块初始化 参数说明： 返回值见 2.1
2. LONG HWFinalize (void)
函数功能： 手写模块卸载
参数说明： 无
3. LONG HWClearPenSign (void)
函数功能： 清除笔迹
HW_eO k 0 HW_eDeviceNotFound -1 HW_eFailedLoadModule -2 HW_eFailedInitModule -3 HW_eWrongImageForma t-4
HW_eNoSignData -5
HW_eInvalidInput -6
成功 未找到对应的汉王手
写设备 手写模块加载失败
手写模块初始化失败 不支
持的图片格式 没有签名数
据 无效输入参数
4.LONG HWSetPenMode(LONG flag)
函数功能：
参数说明：
设置笔模型
flag ：0 -> 毛笔(默认)
1 -> 钢笔
5.LONG HWSetPenWidth(LONG penWidth)
函数功能：设置笔宽
penWidth ：笔宽，提供1-5个级别的设置，默认为3 级
6.LONG HWSetPenColor (OLE_COLOR color)
函数功
能：设置笔的颜色(默认颜色为0x000000 ) color ：颜色，格式为RGB 7.LONG HWSetBkColor (OLE_COLOR color)
函数功能：设置签名区域背景颜色
参数说明：color ：颜色，无背景图片时设置,默认为白色
8.LONG HWSetCtlFrame (LONG linewidth, OLE_COLOR color)
函数功能：
参数说明：设置边框宽度和颜色
linewidth ：边框宽度，0 为无边框。Color ：边框颜色
9.LONG HWSetFilePath (VARIANT &path)
函数功能：设置签名图像的保存路径，确保输入路径的目标文件夹存在，若不存在，控件不创建。
参数说明：path：路径，支持图像格式为bmp，jpg ，png，gif
注：win7 / vista 存在写文件权限问题，因此不支持将保存路径设置为该操作系统盘盘符下。
10.LONG HWSaveFile (void)
函数功能：参数说明：保存文件
返回值见2.1
11.BSTR HWGetBase64Stream(LONG flag)
函数功能：参数说明：获取签字区域图像的base64 流
flag ：0 -> bmp 图像类型
1 -> jpg
2 -> png
3 -> gif
返回值：签字图像对应的base64 数据流
12.LONG HWSwitchMonitor (LONG mode, LONG ctlapp)
函数功能：
参数说明：显示器模式切换(镜像& 扩展) mode：0 –> 汉王签批控件切换到扩展屏显示1 -> 汉王签批控件在主显示器显示
ctlapp: 0 -> 保留，取值为0 注：此接口仅适用于汉王手写液晶屏。
13.LONG HWSetExtWndHandle(LONG hWndHandle)
函数功能：传递与控件通信的窗口句柄值
参数说明：hWndHandle：窗口句柄值
14.LONG HWLoadImage(VARIANT &pathBackImage)
函数功能：給控件手写区域添加背景图片
参数说明：pathBackImage –> 背景图片路径，当背景图片大小与控件手写区域大
小不一致时，背景图片将被进行拉伸或缩放返回值：见2.1
注：此接口仅适用于获取整个签字区域图像版本的控件。
15.LONG HWLoadBase64Stream(VARIANT &stream)
函数功能：给控件手写区域添加背景图片
参数说明：
stream 背景图片的Base64 数据流返回值：见2.1。
注：此接口仅适用于获取整个签字区域图像版本的控件。
16.LONG HWIsNeedSave(void)
函数功能：是否有需要保存的笔迹
参数说明：无
返回值：0 无笔迹
17.void HWSetSignArea(LONG width, LONG height)
函数功能：设置待获取的签字图像大小
有笔迹
参数说明：width 签字图像的宽度
Height 签字图像的高度注：此接口仅支持无窗口版本的控件。
2.3签名动作的自动触发
2.3.1 签名板
1、回调触发签名板的签名界面上带有“重签”和“确认”按钮，用户签名完成后，点击按钮的动作，汉王签名控件可以捕获。
（一）应用系统的HTML 页面通过JS代码引用汉王的签名板控件（ActiveX）。
（二）应用系统通过调用汉王控件接口函数HWInitialize 开始签名；
（三）客户签名完成，点击签名界面下按钮进行重签、确认动作；（四）ActiveX 控件监听到客户的动作，调用应用系统HTML 页面上的JS 函数；
（五）应用系统调用汉王控件接口函数HWFinalize 结束签名。
控件（ActiveX ）与HTML 页面上的回调函数存在以下对应关系：1）“确定”按钮调用HTML 页面上的“ signComplete”函数
2）“重签”按钮调用HTML 页面上的” signRestar函t 数”
客户可以根据需要自行实现上述“ signComplete 和”” signRestar函t 数”，完成签名动作的自动触发机制（如Demo.html 页面所示在signComplete 函数里调用HWGetBase64Stream 接口获取签名图片。）。应用系统也可以不采用这种触发机制，而通过手动的方式去获取用户的签名图像，此时在应用系统的HTML 页面中不实现“ signComplete 和””signRestar函t 数”即可。
2、窗口消息触发约定：当用户点击签名板上的取消、确定按钮时，控件会往往以下窗口句柄发送签名取消或完成的消息（调用HWSetExtWndHandle 接口传进来的窗口句柄）用户可在程序中响应对应的消息即可。消息定义如下：
HW_SIGN_COMPELETE 0x7ffe
HW_SIGN_CLEAR 0x7ffd
2.3.2 手写液晶屏
1、回调触发
手写液晶屏的左侧有 4个按键，当用户触发按键时， 控件可以捕获并回调页 面函数。具体步骤。
（一） 应用系统的 HTML 页面通过 JS 代码引用汉王的签名板控件 （ActiveX ） 。 （二） 应用系统通过调用汉王控件接口函数 HWInitialize 开始签名； （三 ） 客户触发手写液晶屏左侧按键； （四） ActiveX 控件监听到客户的动作，调用应用系统 HTML 页面上的 JS 函数； （五） 应用系统调用汉王控件接口函数 HWFinalize 结束签名。
控件（ ActiveX ）与 HTML 页面上的回调函数存在以下对应关系：
调用 HTML 页面上的“ Confirm_Event ”函数。 调用 HTML 页面上的“ Cancel_Event ”函数。 调用 HTML 页面上的“ PrePage_Even ”t 函数。 调用 HTML 页面上的“ NextPage_Event ”函数 客户可以根据需要自行实 现上述“ Confirm_Event ”、
“ Cancel_Event ”、 “ PrePage_Even ”t 、“NextPage_Event ”函数，实现自动触发机制 （如 Demo.html 页面所示依次在各个回调函数中给出弹框提示 ）。
2、窗口消息触发
约定：当用户点击签名板上的取消、 确定按钮时， 控件会往往以下窗口句柄发送 签名取消或完成的消息（调用 HWSetExtWndHandle 接口传进来的窗口句柄） 用户可在程序中响应对应的消息即可。消息定义如下：
HW_SIGN_COMPELETE 0x7ffe
HW_SIGN_CLEAR 0x7ffd
HW_PAGE_PREV 0x7ffb
HW_PAGE_NEXT 0x7ffc 备注
（ 1）接口使用方法可参考 Demo.html 文件。
（2）由于控件为浏览器的一个子窗口，故不能创建透明的签名窗口 1） “确认”按钮 2） “取消”按钮
确认”按钮 取消”按钮 上翻”按钮 下翻”按钮
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详细设计说明书 （详细设计重点在于对模块进行实现，将模块的对象分解为属性和方法，并阐述 如何实现）
API接口调用说明及示例(第四次修订)
产品/项目名称Product/Project Name 保密级别Confidentiality Level eYou邮件系统机密 产品/项目版本Product/Project Version 最后更新日期Last Update 81032014-09-12 eYou邮件系统V8接口文档 北京亿中邮信息技术有限公司 All Rights Reserved 版权所有侵权必究 仅供内部使用
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邮件系统所提供的接口。 调用接口流程图：
海康威视摄像头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
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.sodocs.net/doc/8711686600.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]
(完整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．本文件中各处引用的文件、资料，包括所要用到的软件开发标准。 列出这些文件的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。
概要设计说明书范例及模板
《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 处理流程 下面将使用（结构化设计）面向数据流的方法对机票预定系统的处理流程进行分
接口文档规范
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:[
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 预期读者和阅读建议 列举本软件系统详细设计报告所针对的各种不同的预期读者，描述文档中，其余部分的内容及其组织结构，并且针对每一类读者提出最适合的文档阅读建议。 读者包括： ●开发人员； ●项目经理； ●测试人员； ●文档编写人员； ●
项目接口文档
接口使用说明书 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. 上传多媒体资源................................................................. 错误！未定义书签。
项目接口需求及设计说明文档(模板)
媒讯集团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来生成客户端代理。