《SS用户需求中国电信型控件V》由会员分享，可在线阅读，更多相关《SS用户需求中国电信型控件V（22页珍藏版）》请在金锄头文库上搜索。
1、中国电信 CRM 系统身份证阅读器接入规范版本：V2.2日期: 2016-05-191 综述综述1.1 适用范围适用范围本方案用于规范身份证阅读器接入中国电信 CRM 系统。1.2 解释权解释权本方案的解释权属于中国电信集团公司。1.3 版权版权本方案的版权属于中国电信集团公司。1.4 修订历史修订历史日期日期修订号修订号描述描述著者著者2015-03-240.1新建谢基锋2015-03-250.2修改增加蓝牙技术要求和开发包规范谢基锋2015-04-020.3修改增加蓝牙加密传输流程谢基锋2015-04-150.4修改浏览器控件方法属性定义谢基锋2015-04-220.5修改删除了设备配置要
2、求史萌2015-04-240.6修改蓝牙传输加密流程，删除密钥在 APP 和设备间传输的流程，改为批量导入后台数 据库谢基锋2015-04-290.7修改蓝牙开发包提供的 API 规范谢基锋2015-05-040.8修改蓝牙传输加密密钥长度 16 字节谢基锋2015-05-051.0修改增加蓝牙设备名和 SDK 包名规范谢基锋2015-05-061.1修改增加要求支持 Firefox 浏览器谢基锋2015-05-071.2完善蓝牙传输的加密技术规范谢基锋2015-05-121.3增加统一字符编码方式谢基锋2015-06-251.4修改 Firefox 命名要求，去除扫描蓝牙接口 要求，修改 i
3、OS 蓝牙连接参数 CBPeripheral谢基锋2015-06-271.5修改 iOS 蓝牙调用类名称定义确保厂家类名 称唯一性，修改蓝牙连接方法定义谢基锋2015-11-201.6修改读取身份证内容，增加照片字段陈华荣2015-12-011.7修改蓝牙证件图片格式为 JPG谢基锋2015-12-031.8增加 USB 证件图片建议值，明确蓝牙图片 转码陈华荣2016-02-261.9为兼容云实名制认证增加读取身份证的时候 传入业务参数，包含 USB 和蓝牙接入的身 份证读取协议的变更谢基锋2016-03-042.0调整了身份证阅读器分体机的规范，增加： 2.3.5、3.5、3.6.2、4、
4、3.2.1-云识别身份证、 3.2.2-云识别身份证等篇幅，修改：2.3.1-回 参增加 isCloud谢基锋2016-05-172.1增加了对 USB 读取的身份证内容做签名和 获取浏览器控件版本号的接口谢基锋2016-05-192.2修改了获取浏览器控件版本号的接口，支持 对不同厂家的一体机控件版本更新；支持给 厂家分配不同密钥对 USB 读取的身份证内 容做签名；新增了 2.6 厂商信息分配表谢基锋2 USB 接入接入2.1 浏览器要求浏览器要求操作系统：Windows XP、Windows7（32 位和 64 位） 支持浏览器： IE 浏览器 IE7、IE8、IE9、IE10、IE11
5、 Firefox 浏览器2.2 控件规范要求控件规范要求IE 浏览器采用 OCX 控件，命名规范：CertReader.ocxFirefox 浏览器采用 DLL 控件，命名规范：npCertReader.dll浏览器网页中能统一使用下面代码来访问控件：2.3 控件方法属性控件方法属性2.3.1 连接身份证阅读器连接身份证阅读器方法名称方法名称connect提供者提供者设备提供方描述描述连接身份证阅读器，由 CRM 客户端发起连接，设备端返回连 接成功与否返回数据类型返回数据类型字符串，要求 JSON 格式方法使用例子方法使用例子var jsonStr = CertCtl.connect();1
6、、 方法入参 无 2、 返回的 JSON 字符串的属性定义属性名称属性名称约束约束类型类型长度限制长度限制描述描述取值说明取值说明resultFlag1数值1返回设备连接的结 果标识0：连接成功 -1：发生错误isCloud?数值1返回是否云读卡0：是 1：否errorMsg?字符100错误信息错误的信息描述 3、 示例“resultFlag”:-1,“errorMsg”:”XXXX”2.3.2 获取控件版本号获取控件版本号方法名称方法名称getVersion提供者提供者设备提供方描述描述获取身份证阅读器的控件版本号返回数据类型返回数据类型字符串，要求 JSON 格式方法使用例子方法使用例子v
7、ar jsonStr = CertCtl.getVersion();1、方法入参无 2、返回的 JSON 字符串的属性定义属性名称属性名称约束约束类型类型长度限制长度限制描述描述取值说明取值说明resultFlag1数值1返回接口调用的结 果标识0：连接成功 -1：发生错误versionSerial1字符10返回控件版本号控件版本号，例如 1.0venderId1数值5厂商标识厂商标识（见 2.6 厂 商信息分配表）errorMsg?字符100错误信息错误的信息描述3、示例“resultFlag”:0,“versionSerial”:”1.0”2.3.3 断开设备连接断开设备连接方法名称方法名
8、称disconnect提供者提供者设备提供方描述描述断开连接身份证阅读器，由 CRM 客户端发起连接，设备端返 回连接断开成功与否返回数据类型返回数据类型字符串，要求 JSON 格式方法使用例子方法使用例子var jsonStr = CertCtl.disconnect();1、 方法入参 无 2、 返回的 JSON 字符串的属性定义属性名称属性名称约束约束类型类型长度限制长度限制描述描述取值说明取值说明resultFlag1数值1返回结果标识0：成功断开连接 -1：发生错误errorMsg?字符100错误信息错误的信息描述 3、 示例“resultFlag”:-1,“errorMsg”:”X
9、XXX”2.3.4 获取设备的连接状态获取设备的连接状态方法名称方法名称getStatus提供者提供者设备提供方描述描述连接身份证阅读器，由 CRM 客户端发起连接，设备端返回连 接成功与否返回数据类型返回数据类型字符串，要求 JSON 格式方法使用例子方法使用例子var jsonStr = CertCtl.getStatus();1、 方法入参 无 2、 返回的 JSON 字符串的属性定义属性名称属性名称约束约束类型类型长度限制长度限制描述描述取值说明取值说明resultFlag1数值1返回结果标识0：成功获得连接状 态 -1：发生错误errorMsg?字符100错误信息错误的信息描述sta
10、tus?数值2连接状态0：正常连接 1：无连接 3、 示例“resultFlag”:-1,“errorMsg”:”XXXX”2.3.5 读取身份证内容读取身份证内容方法名称方法名称readCert提供者提供者设备提供方描述描述由 CRM 客户端调用，阅读器读取身份证内容返回给 CRM 客 户端返回数据类型返回数据类型字符串，要求 JSON 格式方法使用例子方法使用例子var jsonStr = CertCtl.readCert();1、 方法入参 无 2、 返回的 JSON 字符串的属性定义 属性名称属性名称约束约束类型类型长度限制长度限制描述描述取值说明取值说明resultFlag1数值1返
11、回成功或失败的0：成功结果标识-1：发生错误errorMsg?字符100错误信息错误的信息描述venderId1数值5厂商标识厂商标识（见 2.6 厂 商信息分配表）signature?16 进制 字符20 字节对 resultContent 实 体对象属性做数字 签名resultContent 实体对 象的属性值按照下列 表格的顺序拼接成字 符串，并在字符串末 尾拼接约定的 appSecret 字段，对最 终的字符串做数字签 名，签名采用 SHA-1 算法。 （不同厂商 appSecret 不同，见 2.6 厂商信息分配表） resultContent?实体身份证内容实体对 象身份证内容实体
12、对象， 具体参考示例resultContent 实体对象属性描述：属性名称属性名称约束约束类型类型长度限制长度限制描述描述取值说明取值说明partyName1字符20姓名要求中间无空格gender1数值1性别性别，取值为“1” （表示“男”）或“0”（表示“女”） nation1字符20民族民族，汉字即可bornDay1字符8出生日期出生日期，要求格式 为: yyyyMMdd，长度 为 8certAddress1字符100地址certNumber1字符18身份证号码居民身份号码，长度 18 位certOrg1字符20签发机关签发机关effDate1字符8起始有效期要求格式为: yyyyMMdd
13、，长度为 8expDate1字符8终止有效期要求格式为: yyyyMMdd，长度为 8，如果是长期有效则 返回：长期，中文汉 字。identityPic1字符照片要求为 JPG 进行 BASE64 编码得到的 字符串，建议 JPG 大 小不要超过 4K3、 示例“resultFlag”:0,“signature”:“6d5cf40f8353a0b7dd03861a3fdabf69af5ddaeb”，“resultContent”:“partyName”:”XXX”,“gender”:0,“nation”:”汉”,2.3.6 云识别身份证内容云识别身份证内容方法名称方法名称cloudReadCe
14、rt提供者提供者设备提供方描述描述由 CRM 客户端调用，阅读器读取身份证内容返回给 CRM 客 户端返回数据类型返回数据类型字符串，要求 JSON 格式方法使用例子方法使用例子var jsonStr = CertCtl.cloudReadCert(appId,timestamp,nonce,businessExt,signatu re);1、方法入参 属性名称属性名称约束约束类型类型长度限制长度限制描述描述取值说明取值说明appId1字符32应用 ID应用 ID 对应唯一加 密密钥timestamp1字符32时间戳时间戳nonce1字符32随机字符串随机字符串businessExt?字符30
15、0业务属性， busiSerial：业务流 水号；staffCode： 受理人工号； channelCode：渠 道编码； areaCode：地区编 码； teminalType：终 端类型； srcSystem：发起 方系统编码；可扩展字段，以 JSON（key:value）格 式表达，例如： “busiSerial”:”12345”, “staffCode”:”110011”, ”channelCode”:”2001” 。 终端类型取值： PC，IOS ，Android 。osType：操作系统 类型； browserModel：浏 览器型号； clientIP：客户端 IP 地址； de
16、viceModel：设 备型号； deviceSerial：设备 序列号signature116 进制 字符20 字节签名将上述参数值按如上 顺序排列拼接成字符 串最后拼接上 appId 对应的密钥 appSecret 得到的字符串，使用 SHA-1 算法进行签名， appId 对应的密钥由 云服务端来分配。2、返回的 JSON 字符串的属性定义 属性名称属性名称约束约束类型类型长度限制长度限制描述描述取值说明取值说明resultFlag1数值1返回读取成功或失 败的标识0：读取成功 -1：发生错误errorMsg?字符100错误信息错误的信息描述resultContent?字符2000二代身份证内容密 文返回XML 格式的字符串 （内容不允许包含单 引号、双引号、mClient.setCallBack(mCallback); /设置蓝牙连接状态回调，在回调接口 onBtState 中显示蓝牙连接的 状态 回调接口名定义：IClientCallBack 要求接口必须提供 onBtState 方法： void onBtState(final boole
