身份证读卡器（IDCardReader）

身份证读卡 readIdCard

● 接口函数

zwexplorer.IDCardReader.readIdCard

● 接口说明

读身份证信息，个别型号的外设不能连续读取，连续读取需要拿起身份证重新放上

● Typescript 类型参考

type ResBody = {
    resultCode: number, resultMessage: string, data: {} | {
        resultMessage:string,
        cardType:string,
        birthday:string,
        photoType:string,
        photoData:string,
        photoSize:string,
        issueOrgan:string,
        validDateStart:string,
        validDateExpire:string,
        address:string,
        citizenId:string,
        fingerprintData:string,
        fingerprintSize:string,
        credType:string,
        nation:string,
        issueCount:string,
        passportId:string,
        enName:string,
        version:string,
        residenceId2017:string,
        residenceId2023:string,
        regionCode:string,
        nationality:string,
        renewalCount:string,
    }
}

zwexplorer.FingerPrint.readIdCard(data: {}, callback?: (res: ResBody)=>void): Promise<ResBody>

● 返回数据

参数	类型	必然存在	说明
res.resultCode	Number	是	状态码，0 为正常，其它为异常 [状态码参考]
res.data	Object	否	接口返回的详细数据
res.resultMessage	String	否	接口消息
res.data.cardType	String	是	身份证类型
（0:大陆居民身份证 1:2017版外国人永久居留证 2:中国港澳台居住证 3:新版外国人永久居留证）
res.data.name	String	是	姓名，外国人居留证的话是中文名
res.data.sex	String	是	性别
res.data.birthday	String	是	出生日期，格式为 yyyymmdd
res.data.photoType	String	是	图片格式，png、jpg 等
res.data.photoData	String	是	图片数据缓存区
res.data.photoSize	String	是	图片数据长度
res.data.issueOrgan	String	是	签发机关，外国人居留证的话是受理机关代码
res.data.validDateStart	String	是	证件有效期起始日期，格式为 yyyymmdd
res.data.validDateExpire	String	是	证件有效期结束日期，格式为 yyyymmdd
（大陆身份证和港澳台居住证通用数据域）
res.data.address	String	是	住址，户口所在地
res.data.citizenId	String	是	公民身份证号
res.data.fingerprintData	String	是	指纹数据缓存区
res.data.fingerprintSize	String	是	指纹数据长度
（港澳台居住证和外国人居留证通用数据域）
res.data.credType	String	是	证件类别，港澳台固定为'J'，外国人居留证固定为'I'
（大陆身份证特有数据域）
res.data.nation	String	是	民族
（港澳台居住证特有数据域）
res.data.issueCount	String	是	签发次数
res.data.passportId	String	是	通行证号码
（外国人居留证特有数据域）
res.data.enName	String	是	外国人英文
res.data.version
res.data.residenceId	String	是	永久居留证号码（有新版号码取新版，无则取旧版）
res.data.regionCode	String	是	国际地区代码
res.data.nationality	String	是	国籍
res.data.residenceId2023	String	是	新版永久居留证号码 (V3.0.2+)
res.data.residenceId2017	String	是	2017版永久居留证号码 (V3.0.2+)
res.data.renewalCount	String	是	换证次数（V3.0.2+,新版外国人居留证新增字段）

● 示例

zwexplorer.IDCardReader.readIdCard({}, (res) => {
  // 返回数据
});

连续读卡 readIdCardCyclically

● 接口函数

zwexplorer.IDCardReader.readIdCardCyclically

● 接口说明

轮询方式读身份证信息，个别型号的外设不能连续读取，连续读取需要拿起身份证重新放上

● 参数说明

参数	类型	必填	说明
data.timeout	Number	否	连续读卡的超时时间（默认 30s，单位 s）

● 返回数据

参数	类型	必然存在	说明
res.resultCode	Number	是	状态码，0 为正常，其它为异常 [状态码参考]
res.data	Object	否	同上 readIdCard
res.resultMessage	String	否	接口消息

● 示例

zwexplorer.IDCardReader.readIdCardCyclically({ timeout: 30 }, (res) => {
  // 返回数据
});

取消连续读卡 cancelReadCard

● 接口函数

zwexplorer.IDCardReader.cancelReadCard

● 接口说明

轮询读卡时取消自助读卡

● 返回数据

参数	类型	必然存在	说明
res.resultCode	Number	是	状态码，0 为正常，其它为异常 [状态码参考]
res.data	Object	否	接口返回的详细数据
res.resultMessage	String	否	接口消息

● 示例

zwexplorer.IDCardReader.cancelReadCard({}, (res) => {
  // 返回数据
});