web精伦 idr210 ocx控件和接口文档 V4.1.0.4

iDR210 联机型身份证阅读器

插件接口说明

1 概述

为了在浏览器页面上实现通过 iDR210 读取二代身份证的信息，我们提供二次开发接口

（HTTP/HTTPS 协议和 WebSocket 协议）对身份证相关信息的获取、解析，供开发商进行二

次开发使用。本文档对开发接口的定义、调用方法及返回值等进行详细的说明，在使用接口

之前，请安装插件，安装方法参考安装手册。为了方便二次开发，本文中所有接口返回值均

为 Json 字符串。调用示例请参考安装路径下的 Http 测试页、Https 测试页或 websocket 测

试页面。

注意：如部署时发生端口号冲突，可通过修改安装目录下的 config.ini 配置文件，修改本

插件服务的端口号，修改端口号后，请同步修改代码中访问服务的端口号。

3 开发前准备工作

由于使用了 jQuery 中多种方法，使用本控件之前请引入 jQuery 脚本。引用方法如下：

<script type="text/javascript" src="res/jquery.min.js"></script>。

访问方式：GET/POST

调用示例：

//开启连接方法

function CertCtl_connect() {

var result = "";

//创建请求 第一个参数是代表以 post 方式发送；第二个是请求端口和地址；

第三个表示是否异步

CertCtl.xhr.open("POST","http://127.0.0.1:18889/api/connect",

false);

//发送请求

CertCtl.xhr.readyState = 1;

}

return result;

}

说 明：本方法用于控制 JS 控件开启 Web 浏览器与读卡器的连接，利用创建好的

XMLHttpRequest 对象发送 POST 请求给对应端口。

参 数：无。

返 回 值：返回值通用状态码请参考第 4 章。

4.2 断开读

卡器连接

function CertCtl_disconnect() {

var result = "";

//创建请求 第一个参数是代表以 post 方式发送；第二个是请求端口和地址；

第三个表示是否异步

false);

//发送请求

try {

CertCtl.xhr.send();

} catch (e) {

}

if (CertCtl.xhr.readyState == 4 && CertCtl.xhr.status == 200) {

return result;

}

说 明：本方法用于控制 JS 控件关闭 Web 浏览器与读卡器的连接，利用创建好的

XMLHttpRequest 对象发送 POST 请求给对应端口。

参 数：无。

返 回 值：返回值通用状态码请参考第 4 章。

4.3 获 取

连接状态

请求 API：

http://127.0.0.1:18889/api/getStatus

https://127.0.0.1:18891/api/getStatus

访问方式：GET/POST

调用示例：

CertCtl.xhr.open("POST","http://127.0.0.1:18889/api/getStatus",

}

if (CertCtl.xhr.readyState == 4 && CertCtl.xhr.status == 200) {

result = CertCtl.xhr.responseText;

CertCtl.xhr.readyState = 1;

}

return result;

}

说 明：本方法用于获取读卡器的连接状态，利用创建好的 XMLHttpRequest 对象发

送 POST 请求给对应端口。

参 数：无。

https://127.0.0.1:18891/api/readCert

访问方式：GET/POST

调用示例：

//执行读卡操作

function CertCtl_readCert() {

var result = "";

try {

//创建请求 第一个参数是代表以 post 方式发送；第二个是请求端口和地

址；第三个表示是否异步

CertCtl.xhr.open("POST", "http://127.0.0.1:18889/api/readCert",