汉王签批控件接口说明文档v

汉王签批控件接口说明文档v
汉王签批控件接口说明文档v

汉王签批控件接口说明文档-v.

————————————————————————————————作者:————————————————————————————————日期:

汉王笔迹签名控件接口说明文档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数据流。

1.4 控件界面

上图是签批控件HWPenSign.ocx界面图,此控件是ActiveX控件,可以嵌入到网页中使用。此控件可以提供用户定制开发,额外收取软件开发费用。

控件接口

注:为保证图像不失真,PC端控件显示窗口与设备窗口长宽比应一致。因此,建议对于设备ESP370,设置控件窗口长宽比为8:3。对于设备ESP560,设置控件窗口长宽比为5:3。

2.1函数返回值错误码

HW_eOk 0 成功

HW_eDeviceNotFound -1 未找到对应的汉王手写设备

HW_eFailedLoadModule -2 手写模块加载失败

HW_eFailedInitModule -3 手写模块初始化失败

HW_eWrongImageFormat -4 不支持的图片格式

HW_eNoSignData -5 没有签名数据

HW_eInvalidInput -6 无效输入参数

其它返回值,参见windows(WinError.h头文件中定义)常见错误码含义。

2.2 基本接口

1.LONG HWInitialize (void)

函数功能:手写模块初始化

参数说明:返回值见2.1

2.LONG HWFinalize (void)

函数功能:手写模块卸载

参数说明:无

3.LONG HWClearPenSign(void)

函数功能:清除笔迹

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 →无笔迹 1 →有笔迹

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页面上的”signRestart”函数

客户可以根据需要自行实现上述“signComplete”和”signRestart”函数,完成签名动作的自动触发机制(如Demo.html页面所示在signComplete函数里调用HWGetBase64Stream接口获取签名图片。)。应用系统也可以不采用这种触发机制,而通过手动的方式去获取用户的签名图像,此时在应用系统的HTML页面中不实现“signComplete”和”signRestart”函数即可。

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页面上的回调函数存在以下对应关系:

1)“确认”按钮→调用HTML页面上的“Confirm_Event”函数。

2)“取消”按钮→调用HTML页面上的“Cancel_Event”函数。

3)“上翻”按钮→调用HTML页面上的“PrePage_Event”函数。

4)“下翻”按钮→调用HTML页面上的“NextPage_Event”函数

客户可以根据需要自行实现上述“Confirm_Event”、“Cancel_Event”、“PrePage_Event”、“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)由于控件为浏览器的一个子窗口,故不能创建透明的签名窗口。

接口调用说明文档

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:企业服务代码

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)

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

媒讯集团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 审批签字: 客户方: 实施方:

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

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

接口说明文档

接口说明文档 本文档提供面向openflowjava项目的扩展yang模型说明。yang模型文件(sptn-match.yang&sptn-action.yang)根据CMCC提供的ttp文件书写。 1.Match 1.1.扩展Match相关yang元素的命名方式 本节提供扩展match相关yang元素的命名方式说明,其中粗体部分与ttp文件的映射关系见表1。 identity:”sptnxm-sptnx-“ + Match grouping:”ofj-sptnxm-sptnx-“ +Match+”-grouping” case:Match+”-case-value” 1.2.Match扩展例子 以vlan-dei为例

1.Match field within the class identity sptnxm-sptnx-vlan-dei { base ofoxm:match-field; } 2.value of the match container vlan-dei -values { leaf value { type uint8; } } 3.在openflow-augments: experimenter-id-case中扩展 augment "/ofoxm:oxm-container/ofoxm:match-entry-value/aug:experimenter-id-case" { ext:augment-identifier "ofj-aug-sptnx-match"; choice sptnx-match-entry-value { case vlan-dei -case-value { uses ofj-sptnxm-sptnx- vlan-dei -grouping; } } }

接口调用说明文档

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

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

接口文档规范

XXX接口说明书(版本:V1.0)

修订记录

1简介 1.1文档目的 接口文档是前端与后端交互密不可分的环节,接口的规范性会直接影响双方对接过程中的效率和质量。本着快速高效开发的目的性,避免对接过程中的错误率。 1.2接口规范 (1)遵循RESTfulAPI设计风格 (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:[ { label:'待开票' value:1001 }, { label:'回款' value:1003 } ]

软件开发文档模板GF-接口需求规格说明(GJB 438B-2009)-2785

文档标识及版本号: XX项目标识.IRS V1.0 密级:秘密*5年编制/修订日期:yyyy-mm-dd [规范性]文档名称: XX项目中文名称-接口需求规格说明 接口需求规格说明 《XX项目中文名称》接口需求规格说明 Interface Requirement Specification of XX项目英文名称 编制单位:江苏科技大学新技术研究所 编写:CNISILS项目组XXX 审核:YYY 批准:ZZZ

编写记录 修改记录

目录 1 范围 (1) 1.1标识 (1) 1.2系统概述 (1) 1.3文档概述 (1) 2 引用文档 (1) 3 需求 (2) 3.1接口标识和接口图 (2) 3.2(接口的项目唯一标识符)【原标准中此处编号为3.X,为后续使用方便,故用自动编号】 (2) 3.3需求的优先顺序和关键性【原标准中此处编号为3.Y,为后续使用方便,故用自动编号】 (4) 4 合格性规定 (4) 5 需求可追踪性 (4) 6 注释 (5)

文档模板使用和裁剪说明 使用本文档模板时,首先另存为“<实际文档名>”,然后通过Word的“文档属性”来设置文档属性,包括:文档标识及版本号、密级及保密期限、文档名称、文档类别(中、英文)、项目名称(中、英文)、编制单位、编写人、审批人、批准人等。具体操作方法: Word标题栏的Office按钮菜单→准备→属性→文档属性→高级属性→自定义→在“属性”列表中,选择属性的“名称”,在“取值”框输入要设定的值,然后按“更改”按钮。文档属性设置完成后,选中全部文档内容,执行右键菜单“更新域”操作(文档中的所有文档属性参数引用均被替换为最新设定的取值)→双击任意内容页面的页眉区,选中全部页眉内容,执行右键菜单“更新域”操作(页眉中的所有参数引用均被替换为最新设定的取值)。 本文档模板依据《GJB 438B-2009 军用软件开发文档通用要求》制定,模板中的文档编写说明均引自《GJB 438B-2009 军用软件开发文档通用要求》,并用方括号“【”和“】”括起来,以及使用蓝色文字区分,主要用于指导文档的编写,应在文档编写完成后或正式提交前予以删除(包括删除本说明)。 文档编写者可根据实际需要,对文档内容进行裁剪。按照文档标题顺序与本标准模板规定的标题顺序相同的原则,若裁剪了某章或某条,则在被裁去章条的标题下标识为“本章若无内容,则标识为“本章无内容”,并说明理由。”或“本条若无内容,则标识为“本条无内容”,并说明理由。”,并说明理由。若裁剪的是整章条(包括其所有小条),则仅需在最高层章条的标题下标识为“本章若无内容,则标识为“本章无内容”,并说明理由。”或“本条若无内容,则标识为“本条无内容”,并说明理由。”,并说明理由。

接口字段说明文档

接口字段说明文档

目录 1 说明 ..................................................................................................... 错误!未定义书签。 1.1 重要关联标记说明.................................................................... 错误!未定义书签。 1.2 需要字典................................................................................... 错误!未定义书签。 2 患者信息.............................................................................................. 错误!未定义书签。 2.1 患者信息表(ip_patient_info)................................................ 错误!未定义书签。 2.2 患者就诊记录表(ip_patient_visit) ........................................ 错误!未定义书签。 3 住院 ..................................................................................................... 错误!未定义书签。 3.1 病案首页................................................................................... 错误!未定义书签。 3.1.1 病案首页基础信息表(ip_index_record).................... 错误!未定义书签。 3.1.2 病案首页诊断表(ip_index_diagnosis)...................... 错误!未定义书签。 3.1.3 病案首页手术表(ip_index_operation)...................... 错误!未定义书签。 3.2 文书.......................................................................................... 错误!未定义书签。 3.2.1 文书记录表(ip_doc_record) ..................................... 错误!未定义书签。 3.2.2 入院记录表(ip_doc_in)............................................. 错误!未定义书签。 3.2.3 出院记录表(ip_doc_out) .......................................... 错误!未定义书签。 3.2.4 手术记录表(ip_doc_operation) ................................ 错误!未定义书签。 3.2.5 死亡记录表(ip_doc_death) ...................................... 错误!未定义书签。 3.3 医嘱.......................................................................................... 错误!未定义书签。 3.3.1 医嘱表(ip_order_info) .............................................. 错误!未定义书签。 3.4 检查.......................................................................................... 错误!未定义书签。 3.4.1 检查大项表(ip_exam_info)....................................... 错误!未定义书签。 3.5 检验.......................................................................................... 错误!未定义书签。 3.5.1 检验大项表(ip_lab_main_info)................................. 错误!未定义书签。 3.5.2 检验小项表(ip_lab_detail_info)................................ 错误!未定义书签。 3.6 体温单 ...................................................................................... 错误!未定义书签。 3.6.1 体温单大项表(ip_temperature_main) ...................... 错误!未定义书签。 3.6.2 体温单小项表(ip_temperature_detail) ..................... 错误!未定义书签。 3.6.3 血糖记录表(ip_temperature_sbmg)......................... 错误!未定义书签。

Json接口文档

文档 [ { [ID](int):编号, [NodeName](string):节点名称 [NodeNo](int):节点编号, [ProductID](int):产品编号, [Remark](string):备注, [GatewayNo](string):网关编号, [AreaID](int):区域编号, [X]:, [Y]:, [Longitude](string):经度, [Latitude](string):纬度, [Extern](string):备用字段, [Type](string):类型, [Installation](string):安装地点, [Color](string):颜色, [CropsNames](string):作物, [GreenhousesID](int):大棚编号 }, .... ] [ { [SENSOR_ID](int):传感器编号, [SENSOR_SHOW_NAME](string):传感器名称, [PORT_SHOW_NAME](string):传感器显示名称,

[UNIT](string):单位, [Accuracy](string):准确性, [ParentID](int):父节点编号, [Code](string):代码, [Level](int):层级, [Color](string):颜色 }, …. ] [ { [ID](int):编号, [SRC_NAME](string):节点名称, [TIME_STAMP](datetime):时间, [NODE_ID](int):节点编号, [CHANNEL](int):, [SENSOR_ID](int):传感器编号, [DATA](double):数值, [LIVE](int):层级 }, .... ] [ { [节点编号](int):, [安装地点](string):, [更新时间](datetime):, [湿度](string):, [温度](string):, [气压](string):, [降雨量](string):, [风向](string):,

二次开发接口文档

接口开发文档 一、开发包目录结构 1.1demo 文件夹 包含了s dk 接口调用源代码,可供二次开发参考。使用C++开发的M FC 程序。 1.2dll 文件夹 包含了二次开发所需的所有动态库,demo 编译好的e xe 文件需要放在该文件夹内才可以运行。 1.3include 文件夹 包含了二次开发所需要的头文件。 1.4lib 文件夹 包含了二次开发所需要的l ib 静态库。 1.5DSS 二次开发指南(C++).pdf 指导二次开发用户如何新建V S2005 工程运行d emo 文件夹中的d emo。 1.6Version.xml dpsdk 开发包的程序版本信息。 1.7常见问题解答.pdf 二次开发常见问题以及解决方式。

1.8大华平台S DK 开发手册(C++版).chm 二次开发接口使用说明。 二、术语和缩略语 1、D PSDK:DSS 平台二次开发S DK 包 2、C MS:中心管理服务 3、D MS:设备管理模块 4、d emo:程序示例(功能类似D SS 平台客户端) 5、w eb 管理员端:在浏览器中输入D SS 平台的i p 即可打开管理员端 6、C ameraID:通道i d,形如:10000010$1$0$0 7、D eviceID:设备i d 三、Demo 操作方法 3.1 运行d emo

把“demo/bin/”目录下面的3个文件,如下图所示 拷贝到“dll”文件夹下面,运行Test_DPSDK_Core.exe。 3.2 登陆平台 图 1 登陆界面 登陆界面如图 1 所示, 其中: IP:DSS 平台 ip 地址;端口:9000; 用户名:web 管理员端配置的用户; 密码:web管理员端配置的用户对应的密码。 点击“登录”按钮,登陆平台。登陆成功的界面如图2所示: 1 23

汉王签批控件接口说明文档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.0>

一. 概述 目前,已经有很多医院采用了上海金仕达卫宁公司的医院管理系统,而对于医院的LIS、RIS、PACS及其他信息系统(以下统称为医技系统)可能采用不同的产品,这些系统与HIS系统都是医院信息化范畴内的相互完全独立的子系统,没有实现数据的共享,例如一个检验系统里的检验结果还需要在体检系统里再次录入,因此这种重复录入工作占据了很大的工作比重,既影响了医院的工作效率又常常因为重复录入不一致造成数据不准确。 基于以上原因,我们提供第三方的开放性接口实现各子系统之间的数据共享,从而大大提高了医院资源的合理利用率。 二. 医院系统的环境与接口方式 根据目前医院使用的操作系统,客户端基本采用Windows环境,采用客户端直接调用存储过程的方式来完成数据交换与访问。 三. 接口流程图

四. 接口列表

五. 接口格式说明 1.检查报告发布 调用类型:usp_yjjk_jcbrfb 实现功能:提供医技系统报告发布,主要是记录报告的主记录,包括报告号、申请号、病人基本信息、报告医生、报告时间等数据。 前提条件:医技系统确认项目后 相关库表:SF_YS_REPORT(THIS4_REPORT..YJ_REPORT) 2.检查报告回收 调用类型:usp_yjjk_jg_huishou 实现功能:提供已经发布报告的回收 前提条件:已经发布了报告主记录 相关库表:SF_YS_REPORT(THIS4_REPORT..YJ_REPORT) 3.医技结果发布 调用类型:usp_yjjk_yjjgfb 实现功能:提供医技系统报告明细发布,只记录文字信息 前提条件:已经发布了报告主记录 相关库表:SF_JCJGK、SF_YJJGK(YJ_RIS_RESULT、YJ_LIS_RESULT) 4.获取科室信息 调用类型:usp_yjjk_getpzxxlist 实现功能:获取HIS中科室列表 相关库表:YY_KSBMK 5.获取病区信息 调用类型:usp_yjjk_getpzxxlist 实现功能:获取HIS中病区列表 相关库表:YY_BQDMK

Aurora接口使用说明

在AMC-2C667X 平台上使用FPGA 的Aurora 接口说明 声明:本文档仅面向初学者。 1、针对平台用的 V6芯片型号新建一个 ISE工程,工程中加入 Aurora IP 核,IP核的设置 如下(当然也可以选择其他设置,以下均是针对本测试设置而言) 图1 主要参数: lanes-通道数,即使用的 GTX收发器个数 Lane width:aurora 核与用户接口的数据位宽(一般可选2B 或者 4B) Lane rate:Aurora 核的对外通信速率,由于采用 8B/10B 编码,实际有效速率要乘以0.8 。 GT REFCLK:GT参X 考时钟频率采用全双工,流水通信模式。详细请参考 Aurora 的 UG。好了,最后一页了,这 IP 核设置够简单吧!!!(一共才两页好伐?),让你选择 GTX位置 图2

平台上的 V6片子一共有 6组 GTX QUAD,每个 QUAD有 4个 GTX,选择一个 GTX与平台的SFP+ F2相连,平台说明书写清楚了,是 MGT_113_1 ,就是它了。生成了这个核以后,核的文件夹下会多出一堆文件,这就是 XILINX给你的一个示例工程 -example design. 图3 接下来就可以仿真啦。 仿真:你可以直接使用它提供的 testbench 仿真,没问题。但是有更简单的方法,其实你仿真只是为了看看它的时序,看看你加的东西对不对,因为只要你加对了,仿真一定 通过。那么简单的方法呢? 打开 modelsim ,不要告诉我你没装,或者装了没有关联ISE仿真库,那你得先把这个问 题解决了再说。 好了之后,新建一个 modelsim 工程( file-new ?)在你之前那堆文件的 /simulation/functi 文件夹下,看图说 话

接口文档范本

1 引言 1.1编写目的 说明编写这份详细设计说明书的目的,指出预期的读者。 1.2背景 说明:a.待开发软件系统的名称 ;b.本项目的任务提出者、开发者、用户和运行该程序系统的计算中心。 1.3定义 列出本文件中用到专门术语的定义和 外文首字母组词的原词组。 1.4参考资料 列出有关的参考资料,如:a.本项目的经核准的计划任务书或合同、上级机关的 批文;b.属于本项目的其他已发表的文件;c.本文件中各处引用到的文件资料,包括所要用到的软件开发标准。列出这些 文件的标题、文件编号、发表日期和出版单位,说明能够取得这些文件的来源。 2 程序系统的结构 用一系列图表列出本程序系 统内的每个程序(包括每个模块和子程序)的名称、标识符和它们之间的层次结构关系。

3 程序 1(标识符)设计说明从本章 开始,逐个地给出各个层次中的每个程序的设计考虑。以下给出的提纲是针对一般情况的。对于一个具体的模块,尤其是层次比 较低的模块或子程序,其很多条目的内容往往与它所隶属的上一层模块的对应条目的内容相同,在这种情况下,只要简单地说明 这一点即可。 3.1程序描述 给出对该程序的简要描述,主要说明安排设计本程序的目的意义,并且,还要说明本程序的特点 (如是常驻内存还是非常驻?是否子程序?是可重人的还是不可重人的?有无覆盖要求?是顺序处理还是并发处理卜…..等 )。 3.2功能 说明该程序应具有的功能,可采用IPO图(即输入一处理一输出图)的形式。 3.3性能 说明对该程序的全部性 能要求,包括对精度、灵活性和时间特性的要求。 3.4输人项 给出对每一个输入项的特性,包括名称、标识、数据的类型和格 式、数据值的有效范围、输入的方式。数量和频度、输入媒体、输入数据的来源和安全保密条件等等。 3.5输出项 给出对每

相关文档
最新文档