OC接口说明V.docx
OC接口说明V1. 概述 精伦电子股份有限公司开发的二代身份证读卡系列机具适用于相关行业的联机型应用。产品提供了完善的二次软件开发接口。本手册针对提供的ActiveX控件，对开发接口的文件组成、函数定义格式、调用方法及返回值等进行了详细的说明。 2. 接口文件说明 接口文件包括： IdrControl.ocx Dewlt.dll Savephoto.dll 适用开发语言： 网络脚本开发 3. 接口函数说明 3.1. 身份证函数 3.1.1. 读身份证函数 原 型：short ReadCard(long iPort,BSTR PhotoPath) 说 明：本函数用于打开串口或USB口并读取二代证卡内信息。 参 数： 1、iPort： 设置串口、USB或iDR210免驱动 USB-HID。 普通串口 1 16(十进制) 例如： 1：串口1(COM1) 2：串口2(COM2) USB USB-HID (iDR210) 1001 例如： 1001：USB 2、PhotoPath：生成图片文件的绝对路径，包括生成的照片文件photo.bmp,photo.jpg和指定文件名的照片文件，和身份证正反面图片card.jpg。该参数为""时，默认将照片文件保存到Windows系统临时文件目录(GetTempPath)。也可自行设置保存的路径，比如： "d:photosphoto.bmp"，注意文件参数必须设置正确，才能正确地将相片文件放在指定位置(相片文件夹若不存在，将会自动生成新文件夹)。 返 回 值： 值 1 -1 -2 -3 -4 正确 端口初始化失败 卡认证失败 读取数据失败 生成照片文件失败 说明 注：如果读卡机具连接的端口是确定的，可以直接使用相应端口号调用本函数。否则，可以采用循环查找的方式调用本函数。 3.1.2. 端口初始化函数 原 型：short InitComm(long iPort) 说 明：本函数用于打开串口或USB并检测读卡设备是否就绪。 参 数：iPort： 设置串口或USB 普通串口 1 16(十进制) 例如： 1：串口1(COM1) 2：串口2(COM2) USB USB-HID (iDR210) 返 回 值： 1001 例如： 1001：USB 值 1 其它 意义 正确 错误 注：如果读卡机具连接的端口是确定的，可以直接使用相应端口号调用本函数。否则，可以采用循环查找的方式调用本函数。 3.1.3. 端口关闭接口 原 型：int CloseComm(void) 说 明：本函数用于关闭已打开的端口，一般在调用InitComm成功并完成读卡任务后调用。 参 数：无 返 回 值： 值 1 其它 意义 正确 错误 3.1.4. 卡认证接口 原 型：short Authenticate (void) 说 明：本函数用于发现身份证卡并选择卡。 参 数：无 返 回 值： 值 1 0 意义 正确 错误 注：认证卡时，需要将身份证放置于读卡机具上方并做稍许时间的停留。如果函数返回错误表示没有发现卡或者卡停留时间太短。 3.1.5. 获得身份证信息个人姓名 原 型：BSTR GetName； 说 明：本函数用于获取身份证个人姓名信息。 返 回 值：个人姓名信息 注：必须在ReadCard函数调用并返回正确的情况下方能正确获得身份证个人姓名信息 3.1.6. 获得身份证个人性别信息 原 型：BSTR GetSex； 说 明：本函数用于获取身份证个人性别信息。 返 回 值：个人性别信息，"男"或"女"。 注：必须在ReadCard函数调用并返回正确的情况下方能正确获得身份证个人性别信息 3.1.7. 获得身份证个人性别信息 原 型：short GetSexN； 说 明：本函数用于获取身份证个人性别代码。 返 回 值： 值 1 2 男 女 说明 注：必须在ReadCard函数调用并返回正确的情况下方能正确获得身份证个人性别信息 3.1.8. 获得身份证信息个人民族 原 型：BSTR GetFolk； 说 明：本函数用于获取身份证个人民族信息。 返 回 值：个人民族信息 注：必须在ReadCard函数调用并调用并返回正确的情况下方能正确获得身份证个人民族信息 3.1.9. 获得身份证信息个人民族 原 型：Short GetFolkN； 说 明：本函数用于获取身份证个人民族数字代码。 返 回 值：个人民族信息数字代码 返回值以代码表示，下列是民族编码顺序，汉族编码为1，蒙古为2，依次递推。 "汉","蒙古","回","藏","维吾尔","苗","彝","壮","布依","朝鲜","满","侗","瑶","白","土家","哈尼","哈萨克","傣","黎","傈僳","佤","畲","高山","拉祜","水","东乡","纳西","景颇","柯尔克孜","土","达斡尔","仫佬","羌","布朗","撒拉","毛南","仡佬","锡伯","阿昌","普米","塔吉克","怒","乌孜别克","俄罗斯","鄂温克","德昂","保安","裕固","京","塔塔尔","独龙","鄂伦春","赫哲","门巴","珞巴","基诺","其他","其他","其他","其他","其他","其他","其他","其他","其他","其他","其他","其他","其他","其他","其他","其他","其他","其他","其他","其他","其他","其他","其他","其他","其他","其他","其他","其他","其他","其他","其他","其他","其他","其他","其他","其他","其他","芒人","摩梭人","革家人","穿青人","入籍","其他" 注：必须在ReadCard函数调用并调用并返回正确的情况下方能正确获得身份证个人民族信息 3.1.10. 获得身份证个人身份证号信息 原 型：BSTR GetCode； 说 明：本函数用于获取身份证个人身份证号信息。 返 回 值：个人身份证号信息 注：必须在ReadCard函数调用并返回正确的情况下方能正确获得身份证个人身份证号信息 3.1.11. 获得身份证个人出生年信息 原 型：BSTR GetBirthYear； 说 明：本函数用于获取身份证个人出生年信息。 返 回 值：个人出生年信息 注：必须在ReadCard函数调用并返回正确的情况下方能正确获得身份证个人出生年信息 3.1.12. 获得身份证个人出生月信息 原 型：BSTR GetBirthMonth； 说 明：本函数用于获取身份证个人出生月信息。 返 回 值：个人出生月信息 注：必须在ReadCard函数调用并返回正确的情况下方能正确获得身份证个人出生月信息 3.1.13. 获得身份证个人获得出生日信息 原 型：BSTR GetBirthDay； 说 明：本函数用于获取身份证个人获得出生日信息。 返 回 值：个人出生日信息 注：必须在ReadCard函数调用并返回正确的情况下方能正确获得身份证个人获得出生日信息 3.1.14. 获得身份证个人地址信息 原 型：BSTR GetAddress； 说 明：本函数用于获取身份证个人地址信息。 返 回 值：个人地址信息 注：必须在ReadCard函数调用并返回正确的情况下方能正确获得身份证个人地址信息 3.1.15. 获得身份证个人发证机关信息 原 型：BSTR GetAgency； 说 明：本函数用于获取身份证个人发证机关信息。 返 回 值：个人发证机关信息 注：必须在ReadCard函数调用并返回正确的情况下方能正确获得身份证个人发证机关信息 3.1.16. 获得身份证个人有效日期信息 原 型：BSTR GetValid； 说 明：本函数用于获取身份证个人有效日期信息。 返 回 值：个人有效日期信息 注：必须在ReadCard函数调用并返回正确的情况下方能正确获得身份证个人有效日期信息 3.1.17. 读追加地址信息 原 型：short ReadNewAppMsg； 说 明：读附加地址信息。 返 回 值： 值 0-4 -1 注：读追加地址信息时，需要将身份证置于读卡机具上方做稍许时间的停留。附加地址数目一般有0-4个，获得具体哪个附加地址信息可在调用此函数获得附加地址数目后调用GetNewAddress(short i)获得 意义 附加地址数目 错误 3.1.18. 获得身份证个人获得附加地址信息 原 型：BSTR GetNewAddress(short i)； 说 明：本函数用于获取身份证个人附加地址信息。 参数: i附加地址序号 返 回 值：附加地址 注：必须在读卡基本信息ReadNewAppMsg函数调用并返回正确的情况下方能正确获得身份证个人附加地址信息 3.1.19. 获得身份证照片Base64编码 原 型：BSTR GetPhotobuf ； 说 明：本函数用于获取身份证照片Base64编码信息。 参数: 无 返 回 值：身份证照片Base64编码信息 注：必须在读卡函数调用并返回正确的情况下方能正确获得身份证照片信息 3.1.20. 获得阅读器安全模块号 原 型：BSTR GetSAMID ； 说 明：本函数用于获取阅读器安全模块号。 参数: 无 返 回 值：阅读器安全模块号 注： 3.1.21. 获得身份证照片JPG格式Base64编码 原 型：BSTR GetJPGPhotobuf ； 说 明：本函数用于获取身份证照片JPG格式Base64编码信息。 参数: 无 返 回 值：身份证照片Base64编码信息 注：必须在读卡函数调用并返回正确的情况下方能正确获得身份证照片信息 3.1.22. 获得身份证卡号 原 型：BSTR GetIDCardSN； 说 明：本函数用于获取身份证卡号。 返 回 值：身份证卡号 注：必须在读卡函数调用并返回正确的情况下方能正确获得身份证照片信息 3.2. TypeA 非接触IC卡函数 3.2.1. 读TypeA卡函数 原 型：short ReadICCard(long iPort) 说 明：本函数用于打开串口并读取卡内信息。 参 数： 1、iPort： 设置串口 普通串口 1 16(十进制) 例如： 1：串口1(COM1) 2：串口2(COM2) USB-HID (iDR210) 返 回 值： 8159(十进制) 值 1 -1 -2 正确 说明 端口初始化失败 读卡失败 注：如果读卡机具连接的端口是确定的，可以直接使用相应端口号调用本函数。否则，可以采用循环查找的方式调用本函数。 3.2.2. 获得TypeA卡序列号 原 型：BSTR GetICCardSN； 说 明：本函数用于获取IC卡序列号。 返 回 值：IC卡序列号 注：必须在ReadICCard函数调用并返回正确的情况下方能使用 3.2.3. 读TypeA卡块内容 原 型：BSTR ReadTypeABlock(short SID, short BID, short KeyType, LPCTSTR Key)； 说 明：本函数用于读取指定扇区的指定块的内容。 参 数： SID为扇区号，0-15。 BID为块号，0-3。 KeyType为密钥类型，两种：1 keyA，2 keyB。 Key为密钥，12个字节的字符串。 返 回 值： 值 32个字节字符串 0 说明 正确。每两个字节对应块内的一个字节内容。 失败 注：必须在ReadICCard函数调用并返回正确的情况下方能使用 3.2.4. 写TypeA卡块内容 原 型：BSTR WriteTypeABlock(short SID, short BID, short KeyType, LPCTSTR Key, LPCTSTR Data)； 说 明：本函数用于写入指定扇区的指定块的内容。 参 数： SID为扇区号，0-15。 BID为块号，0-3。注意：若写每个扇区的3号块的数据不正确，卡将无法正常读写。 KeyType为密钥类型，两种：1 keyA，2 keyB。 Key为密钥，12个字节的字符串。 Data为写入的内容，32个字节的字符串。 返 回 值： 值 1 0 正确。 失败 说明 注：必须在ReadICCard函数调用并返回正确的情况下方能使用 4. 接口使用流程及示例 4.1. 身份证函数示例 在连接好读卡机具以后，调用控件的方法ReadCard读取卡中信息。 示例一： var result; var username; result=IdrControl1.ReadCard("1",""); if (result=1) /读卡成功 username=IdrControl1.GetName /此时可进行获取卡姓名,性别等信息 . else if (result=-1) /端口初始化失败 if (result=-2) /卡认证失败 if (result=-3) /读取数据失败 if (result=-4) /生成照片文件失败 4.2. TypeA卡函数示例 示例二： var result; var ICSN; result=IdrControl1.ReadICCard("1"); if (result=1) /读卡成功 ICSN =IdrControl1.GetICCardSN;/读卡序列号 . result=IdrControl1.ReadTypeABlock(0,0,1,"ffffffffffff"); /读0区0块的内容 . result=IdrControl1.WriteTypeABlock(0,0,1,"ffffffffffff"); /写0区0块的内容 . else if (result=-1) /端口初始化失败 if (result=-2) /读卡失败 实现可参照例程 test.htm 提示： 一 例程只是控件开发的简单示范，具体二次开发功能实现，由开发人员进行设计和开发 二 调试过程中请注意 找卡过程中包含选卡，目前公安部安全模块只支持一次选卡，因此如果找卡成功后，若想再次进行找卡读卡流程需将机具上卡拿开后再次放置到机具上 三ActiveX控件在网页上运行以及下载受到安全级别的限制(开发人员请注意)
