Manual中控online sdk开发文档.docx

1、Manual中控online sdk开发文档ZKOnline SDK 2.0 For B/S参考手册(Rev 2.0)ZKSoftware Inc.2003-03-221 ZKOnline SDK描述主要目的是将指纹识别技术应用于浏览器/服务器环境中(B/S=Browser/Server)。具体表现形式就是在前台浏览器中直接使用进行指纹登记和提取指纹模板，然后发送到后台服务器中进行比对，比对方式依赖后台使用的WEB服务器和脚本语言。前台浏览器目前一般为IE(internet explorer)浏览器,后台WEB服务器为IIS, APACHE等，后台使用脚本编程语言为ASP,JSP,PHP,JA

2、VA等。 2 ZKOnline SDK架构ZKOnline SDK基于Biokey算法在B/S结构下使用的开发包。ZKOnline SDK针对后台服务器比对方式分为1:1和1:N两种，根据后台WEB服务器开发使用的不同脚本语言提供Com+组件和DLL两种方式；ZKOnline SDK 主要满足需要在前台浏览器端提取指纹模板，然后提交到后台进行1:1或者1:N指纹识别，后台一般包括专门的指纹识别服务软件系统。ZKOnline SDK 1：1版本对应于Biokey SDK1：1版本，模板兼容。ZKOnline SDK 1：N版本对应于Biokey SDK1：N版本，模板兼容。前台浏览器和后台服务器

3、操作系统要求为Windows，服务器为Unix or Linux,则需要单独建立比对Windows服务器。ZKOnline SDK 2.0 (Software Development Kit)前台浏览器部分以ActiveX的方式存在，使用者可以直接嵌入到IE浏览器的网页中使用，也可以使用各种开发语言（例如VC+, C+Builder, Delphi, VB, Visual Foxpro, PB等）来开发相对于指纹仪的应用程序，后台服务器部分以COM+组件（IIS+ASP使用）或者DLL的方式提供。Files IncludedOSFilesDescriptionWindows 95Windows

4、 98Winodws MEWinodws NTWindows2000Windows XPSetup.exe指纹仪和加密狗驱动安装程序License.rtf开发许可协议Manual.doc/pdf程序开发手册OneClientZKOnline.ocxZKOnline 1:1 ControlOneClientZKOnline.licZKOnline 1:1 Control LicenseOneServerFPCom.dll1:1 IIS + ASP使用的COM+组件OneServerMatch.dll1:1 其它后台脚本调用的DLL库ManyClientZKOnline.ocxZKOnline 1

5、:N ControlManyClientZKOnline.licZKOnline 1:N Control LicenseManyServerFPCom.dll1:N IIS + ASP使用的COM+组件ManyServerMatch.dll1:N 其它后台脚本调用的DLL库Sample网站演示代码Sample.htmZKOnline.ocx插件htm使用代码3 ZKOnline SDK特点1、简化开发，快速使用ZKonline SDK基于Biokey SDK开发而来，主要目的可以帮助客户快速使用指纹产品，简化在B/S和程序开发使用中的开发困难，使得客户在短时间内在自己的项目和系统中使用指纹技术

6、。2、授权许可相同ZKonline SDK使用和Biokey SDK相同的授权许可文件或者硬件加密狗方式，即两者使用同一授权方式的Biokey.lic文件或者加密狗。3、指纹模板兼容ZKonline SDK 和Biokey SDK的1:1模板互相可以通用，相互进行比对识别ZKonline SDK 和Biokey SDK的1:N模板互相可以通用，相互进行比对识别4、ZKOnline SDK的其它应用ZKonline SDK基于Biokey SDK开发，前台系统以ActiveX形式存在，因此也可以直接应用于一般的(客户/服务器)C/S结构或者脚本形式的应用程序和系统中，其特点是开发使用简单，快速，

7、ZKonline SDK可以应用于Lotus Notes，Microsoft Office等办公系统软件之中。 4 软件安装1安装驱动程序前台客户端和后台服务器都需要安装指纹仪驱动程序，如果已经安装Biokey SDK光盘所带的指纹仪驱动程序，请跳过继续下面的安装，在安装之前，请确定您的操作系统和计算机的配置符合软件运行的要求。在进行安装之前，如果您的计算机接上了指纹采集器，最好将它拔下来。1、将安装光盘放入计算机的光驱之中，安装软件将自动运行或者执行Setup.exe。弹出窗口如下图所示：点击下一步按钮，可以进入如下操作步骤：请选择安装的目标目录，进入下一个操作界面：点击安装按钮，就开始安装

8、指纹驱动程序和加密狗驱动程序。注意：1、程序安装的只是指纹采集器的驱动程序和加密狗的驱动程序，其它开发所需的文件需要用户手动拷贝至相应的目录下2、 用加密狗许可方式，请确保加密狗正确连接在计算机的并口上。 3、 使用许可文件方式，需要将许可文件拷贝到Windows系统目录2注册客户端ZKonline插件客户端需要注册ZKOnline插件，然后才能在网页和程序开发中使用。拷贝下面文件到 Windows 系统目录(c:windowssystem)：ZKOnline.ocx 控件库文件 ZKOnline.lic 控件库文件许可注册控件 ZKOline.ocx：c:windowssystemregsv

9、r32.exe c:windowssystemZKonline.ocx注意： Windows 98,ME的系统目录为 WindowsSystem Windows NT, 2000,XP系统目录为 WindowsSystem323注册安装后台服务器COM+组件(可选)如果使用IIS + ASP开发，则后台WEB服务器需要注册安装COM+组件FPCom.dll，步骤如下：1、 进入管理工具组件服务，下图所示：点击鼠标右键，选取菜单新建应用程序2、 创建新的COM+应用程序，下图所示：3、选取 ”下一步”按钮，选择创建空应用程序，4、输入新应用程序的名称(这里输入Sample)，选取 ”下一步”按钮

10、，一直到完成，这时COM+应用程序会新增一项，下图所示：5、点击鼠标右键，选取菜单，新建组件，下图所示选择安装新组件，选择FPCom.dll，然后完成安装。5 ZKOnline.ocx控件参考ZKOnline SDK前台浏览器使用ActiveX插件ZKOnline.ocx，其中接口属性和方法在以下综合说明。以下都采用VB语法说明。1属性1.1 VerifyCount As Long设置验证指纹重试次数，调用Verify方法是使用。1.2 RegisterTemplate As String调用方法Register时，若指纹登记成功，则保存当前指纹登记模板，登记失败则为空。另外，在调用Verif

11、y进行指纹比对时，RegisterTemplate存放要比对的登记模板。1.3 VerifyTemplate As String调用方法GetVerTemplate成功时，保存指纹比对模板，获取失败时为空。1.4 Threshold As Long(1:N) 设定指纹识别系统比对识别阀值分数(1-100)，默认为10，值越大，误判率越低同时拒绝率变大 注意：1:1控件没有这个属性1.5 OneToOneThreshold As Long(1:N) 设定Biokey低速指纹1：1比对的识别阀值分数(1-100)，默认为10，值越大，误判率越低同时拒绝率变大 注意：1:1控件没有这个属性1.6 C

12、heckFinger As String(1:N) 设定指纹界面已登记手指的标志。长度为10，格式为XXXXXXXXXX 其中X为0或者1, 0表示未登记，1表示已登记每一字符从左到有代表1：左小指；2：左无明指；3：左食指；4：左中指；5：左大拇指；6：右大拇指7：右中指；8：右食指；9：右无名指；10：右小指 注意：1:1控件没有这个属性1.7 EnrollCount As Long(1:N)调用方法GetVerTemplate成功时，保存指纹比对模板，获取失败时为空。注意：1:1控件没有这个属性1.8 DefaultRegFinger As Long(1:N)设置调用Regsiter方法

13、进行指纹登记时手指序号, 具体序号请参考CheckFinger属性。注意：1:1控件没有这个属性1.9 DefaultWindowClose As Long(1:N)设置指纹比对界面自动关闭的时间，单位为秒。注意：1:1控件没有这个属性2方法2.1 Function Register As Boolean开始登记指纹，登记成功时返回True，登记失败返回False，RegisterTemplate保存当前的指纹登记模板。2.2 Function GetVerTemplate As Boolean获得指纹比对模板，提交到后台服务器进行比对，主要配合后台比对使用，提取成功返回True，失败返回Fa

14、lse。2.3 Function Verify As Boolean获取指纹比对模板然后进行比对指纹，调用之前必须设置属性RegisterTemplate为需要比对的指纹登记模板，比对成功返回True，失败返回False。2.4 Function MatchFinger(ARegTemplate As String, AVerTemplate As String) As Boolean比对指纹模板，ARegTemplate是登记模板，AVerTemplate是比对模板，比对成功返回True，失败返回False。2.5 Function GetRegFingerTemplate(AFingerO

15、rder As Long) As String(1:N)得到已经登记成功的指纹模板，AFingerOrder是指纹手指顺序，参考属性CheckFinger，已登记手指返回模板字符串，未登记手指返回空字符串。2.6 Sub SetVerHint(AHint As String)(1:N)设置指纹比对界面的窗口。2.7 function EncodeTemplate1(ASour) As String(1:N)将控件使用的Variant模板ASour转换为BASE64格式的模板字符串。参考 方法EncodeTemplate12.8 function DecodeTemplate1(const AS

16、our As String) As Variant(1:N)将BASE64格式的模板字符串ASour转换为控件使用的Variant类型模板。参考 方法DecodeTemplate12.9 function CompressTemplate(const ATemplate As String) As Variant(1:N)将BASE64格式的模板字符串ATemplate转换为Variant类型模板。注意: Variant类型模板主要为了兼容旧开发包模板2.10function MatchFingerAsVariant(const ARegTemplate As String, AVerTemp

17、late As String) As Boolean(1:N)比对两个Variant类型指纹模板。备注说明：1：N插件的登记和比对方法支持语音提示，具体对应语音文件如下(请将语音文件拷贝到系统目录下)：等待按压手指waitfor.wav移开手指Acquired.wav登记成功RegSuc.wav登记失败RegFail.wav验证通过v-ok.wav系统默认包含上面五个语音文件。使用下面代码嵌入到网页中： EMBED type=application/x-eskerplus classid=clsid:A318A9AC-E75F-424C-9364-6B40A848FC6B codebase=Z

18、KOnline.ocx width=20 height=20 6 后台服务器端指纹比对后台服务器比对根据WEB服务器和使用的后台脚本语言不同，ZKOnline SDK提供COM+组件(FPCom.dll)和DLL库(Match.dll)两种方式。1 IIS + ASP对于后台使用IIS+ASP开发环境，调用COM+组件对象FPCom.FPProcess进行比对，请首先注册COM+组件FPCom.dll，参考原型代码如下： Set fpProcess = Server.CreateObject(FPCom.FPProcess) if fpProcess.Process(objRec(finger

19、template), fingertemplate) then fingerpass = true end if Set fpProcess = Nothing FPCom.FPProcess对象说明：1.1 方法Function process(ARegTemplate As String, AVerTemplate As String) As Boolean比对指纹模板，ARegTemplate是登记模板，AVerTemplate是比对模板，比对成功返回True，失败返回False。1.2 属性（1） Threshold As Long 设定指纹识别系统比对识别阀值分数(1-100)，默认

20、为10，值越大，误判率越低同时拒绝率变大 注意：1:1没有这个属性（2） OneToOneThreshold As Long 设定Biokey低速指纹1：1比对的识别阀值分数(1-100)，默认为10，值越大，误判率越低同时拒绝率变大 注意：1:1没有这个属性2 其它WEB服务器和脚本语言通过DLL库方式解决后台比对的问题，如果后台服务器和脚本语言直接支持调用DLL库，则调用DLL库输出函数process进行比对，或者可以通过其它方式，例如，利用Java与DLL 进行通讯技术按照一定的逻辑包装成java类，提供给JSP或者JAVA调用。DLL库输出Process方法原型描述(stdcall方式

21、)：(1) Function process(ARegTemplate As String, AVerTemplate As String) As Boolean比对指纹模板，ARegTemplate是登记模板，AVerTemplate是比对模板，比对成功返回True，失败返回False。（2） Sub SetThreshold(AThreshold As Long, AOneToOneThreshold As Long) 设置比对指纹模板的阀值。 AThreshold设定指纹识别系统比对识别阀值分数(1-100)，默认为10，值越大，误判率越低同时拒绝率变大 AOneToOneThreshold设定Biokey低速指纹1：1比对的识别阀值分数(1-100)，默认为10，值越大，误判率越低同时拒绝率变大 注意：1:1没有这个方法