《IDCardWebHelp.doc》由会员分享，可在线阅读，更多相关《IDCardWebHelp.doc（24页珍藏版）》请在金锄头文库上搜索。
1、居民二代身份证通用阅读控件IDCardWeb(网页版)版本：1.3.0.3使用手册2010年12月一、IDCardWeb简介IDCardWeb是一款通用的配合二代身份证阅读器实现网页读取二代身份证信息的工具。作为web应用开发者，我们经常会遇到（如招生考试中等）在浏览器中采集身份证信息的需求。IDCardWeb针对这一需求，通过在网页中嵌入控件，实现准确、快速、安全、防篡改地采集身份证信息。居民二代身份证的姓名中可能含有的生僻字使用的是专用编码和字库，在使用通用字库的计算机中是不能显示的，IDCardWeb很好地解决了此问题。IDCardWeb能够在无界面、图标界面、基本界面和标准界面中转换，
2、适应于不同的应用场合。IDCardWeb提供丰富的数据接口，让应用开发者方便地进行二次开发。IDCardWeb采用信息产业部数据通信科学技术研究数据所制定的居民身份证验证安全控制模块接口进行开发，因此 IDCardWeb可以适用于不同厂家利用这一标准生产的二代身份证阅读器，无需再使用阅读器厂家提供的功能单一的控件。二、系统要求服务端：可以是任何操作系统，任何web服务器。客户端：windows操作系统（除win95/98外），Internet Explorer5.5及以上版本。三、IDCardWeb的安装1. 服务端 在页面中嵌入IDCardWeb控件。示例网页 IDCardWeb.htm .
3、 .如果你访问该网页的地址是: http:/ IDCardWeb.cab放在：http:/ 可以访问到的地方。总之，IDCardWeb.cab的位置，需要根据当前网页路径与codebase属性来确定。2. 浏览器端 当你访问使用IDCardWeb控件的网页时，浏览器将从服务器上下载控件，自动安装到ie中。当然，如果你的IE安全设置过高，也可能不能自动安装，这时，你需要改变IE的安全设置，或进行离线安装。建议下载离线安装包IDCardWeb.exe进行离线安装。注：本控件暂时只提供离线安装包。IE安全设置方法如下：IE 浏览器-工具- internet 选项-安全-自定义级别，设置下载未签名的
4、ActiveX等的相关项目为启用状态。 进入IE菜单栏工具 - Internet选项 进入安全可信任站点 点击 站点 把页面所在的网站加入可信任站点 点击 自定义级别 进入安全设置受信任的站点区域，设置ActiveX控件和插件的相关选项为启用3、IDCardWeb的离线安装 下载IDCardWeb的安装包运行 如果有浏览器或应用程序正在使用原来安装的IDCardWeb，请关闭所有相关的应用程序后再按“重试” 完成安装四、IDCardWeb的界面和功能键使用IDCardWeb有四种界面：无界面、图标界面、基本界面（只显示姓名和身份证号）、标准界面。控件默认使用基本界面，通过Size属性来设置转换
5、界面。图标界面基本界面标准界面l A.启动/停止键鼠标单击此键，可以启动/停止自动阅读身份证。当此图标为 时，自动阅读处于停止状态，单击 将启动自动阅读。当此图标为 时，处于自动阅读状态，连接好设备，将身份证交替放到阅读器上，系统将自动连续阅读，单击 将关闭自动阅读。l B.清除屏幕信息键鼠标单击此键图标 ，系统将清除屏幕上已阅读身份证信息，同时引发onClear() 事件。l C.运行状态图标此图标指示当前自动阅读状态。在停止状态，不显示图标。启动阅读后，此图标连续闪动。当闪动图标为 时表示未找到阅读设备，系统等待并继续查找设备，同时不断引发 onStatus(state,msg) 和onM
6、essage(msg)事件。当闪动图标为 时表示系统已连接设备，正在自动阅读中，同时不断引发 onStatus(state,msg) 和 onMessage(msg) 事件，正确读取出身份证信息时引发 OnRead() 事件。五、IDCardWeb的属性l License网站授权，字符型，必选。 此属性必须在Verify和RarelyWord设置之前设置。此属性将对网站URL进行授权。未正确授权时，IDCardWeb读取信息到屏幕，不引发OnRead事件，不输出数据。示例：idc.License=”71TMkYXFUhaKnAyoIw9/A4lsosfdmEh9myqHW”;l VerifyM
7、D5数字签名编码的字符串表达式，字符型，必选。专用加密编码器加密，与License相关。此属性必须在RarelyWord设置之前和License正确设置之后设置。上传的身份证数据项自定义组合，如：姓名+身份证号+照片+自定义字符+Session，与服务端配合进行MD5数字签名校验，可以有效防止被篡改的身份证信息上传。表达式通过专用加密编码器加密。示例：idc.Verify=q7w3EB3Uu5lXosGtC4VMhMEz1MsjZ8m0E/T5Rs;l RarelyWord生僻字表，字符型，可选。专用加密编码器双重加密，与License和Verify相关。此属性必须在License和Rarel
8、yWord正确设置之后设置。通过此属性，解决身份证姓名中可能包含的，计算机通用字库中没有的生僻字问题。把收集的生僻字字节ASCII码（如837B）通过专用加密编码器加密编码的字符串，赋值到此属性。建议加密编码的生僻字表字符串保存在可在线更新的数据库中，实时读取到页面。示例：idc.RarelyWord=”468IMMMcreAvFV1XfFEVSqp9zA2Rs0bdGm”;l Session用户会话变量，字符型，可选。通过此属性，可以动态设置身份证信息MD5数字签名编码的字符串，增加上传数据防篡改的强度。示例：idc.Session=”abcdefg”;l AutoStopTime停止自动读
9、卡间隔时间（秒），整型，可选。进入自动读卡，IDCardWeb 自动查找阅读设备上是否有身份证，如果在AutoStopTime设定的时间内没有找到身份证，IDCardWeb 将停止继续扫描，以保护阅读设备。示例：idc.AutoStopTime=60;l Size界面类型，整形，可选。示例：idc.Size = 2; /-基本界面Size界面类型0无界面1图标界面2基本界面（只显示姓名和身份证号）3标准界面六、IDCardWeb的方法l ReadStart()开始自动连续读卡。示例：idc.ReadStart();l ReadClose()停止自动连续读卡。示例：idc.ReadClose()
10、;l SaveIDPicture(sFile)保存照片为本地指定的文件，支持.jpg、.bmp、.gif、.png格式。示例：idc.SaveIDPicture(d:idpicture.jpg);l MD5(str)计算字符串的MD5编码，返回字符型。示例：strMd5=idc.MD5(abcdefg);l Send(url, fieldList, sendType, httpHead, timeOut)发送指定身份证信息到指定URL，返回服务端返回的文本。url -数据发送的目录URL地址，字符型，必选fieldList -要发送的身份信息字段名表，用“,”分隔，字符型。字段名首字母为小写时
11、，数据将先进行base64编码。数据字段的关键字注释IDName姓名IDCardNo身份证号IDPictureBase64照片IDNameCode姓名编码IDSex性别IDSexCode性别编码IDNation民族IDNationCode民族编码IDBorn出生日期IDAddress住址IDGrantDept签发机关IDBeginTime开始期限IDEndTime结束期限IDNewAddress最新住址IDRarelyWord姓名生僻字SAMID阅读器安全模块IDsendType - 发送类型，整形，可选。0（默认）通过application/x-www-form-urlencoded方式发送
12、FORM数据。在服务端：通过form读取数据，如在ASP中获取指定的身份证信息的方法：IDName=Request.form(IDName)1通过application/octet-stream方式发送二进制照片数据，指定的身份证字段信息通过HTTP头传送。在服务端，直接接收二进制照片数据，如在ASP中获取二进制照片数据的方法：IDPictureRequest.BinaryRead(Request.TotalBytes)在服务端，从HTTP头中读取字段数据，如在ASP中获取指定的身份证信息的方法：IDName=Request.ServerVariables(HTTP_IDName)。2通过ap
13、plication/octet-stream方式发送时不传送二进制照片数据，指定的身份证字段信息通过HTTP头传送。在服务端，从HTTP头中读取字段数据，如在ASP中获取指定的身份证信息的方法：IDName=Request.ServerVariables(HTTP_IDName)。httpHead - 附加的HTTP头，字符型，可选。timeOut - 超时时间（秒，默认5秒），整形，可选。示例：Send(upload.asp, IDName,IDCardNo,IDRarelyWord);七、IDCardWeb的事件l OnRead()正确读卡后引发的事件。l OnStatus (State,
14、 Msg)IDCardWeb 读卡的状态改变时引发的事件。State状态ID，整型Msg文字消息，字符型StateMsg0关闭1启动2找到阅读器：3搜寻卡（证）中，n 秒后关闭4选择卡（证）失败5读取基本信息失败。6读取追加数据失败。7照片解码错误。8软件未授权9读卡成功10读卡时系统出现错误。11未找到USB读卡设备(连接USB端口失败)l OnMessage(Msg)IDCardWeb 的消息事件。主要在错误时引发。Msg文字消息，字符型说明：IDCardWeb 的事件无法在javascript下被捕获（还没找到原因），可以通过在vbscript下捕获事件，再转发到javascript中来解决。示例：!- *Vbscript下捕
