中軟高科CSYJM-4微信小程序接口支付寶二代證插件讀取能力SDK 軟

1、引入插件
在小程序的app.json中，加入插件。

"plugins": {
"readcard-plugin": {
"version": "2.3.7",
"provider": "wxa2583ebacdb87a6a"
}
}
2、基礎庫
調試基礎庫 2.20.3 及以上
微信版本：
iOS 暫不支持NFC(微信未支持)，可使用藍牙外設讀卡器
Android 8.0.6及以上版本，同時支持NFC、藍牙外設讀卡器
3、使用插件功能
3.1、讀取、永居證、港澳臺居住證信息功能
在需要使用讀卡的頁面中，使用插件示例。

const plugin = requirePlugin(readcard-plugin);
var StatusCode = null;
var that = this;
var initSuccess = false;

Page({
data: {
idCardInfo: null,
},
onLoad() {
that = this;
StatusCode = plugin.StatusCodeEnum();
console.log("對照狀態碼：", StatusCode);

// 設置APPID （開始讀卡之前，必須設置）
plugin.setAppId("appid聯系我司商務獲取", "", "");

// 設置讀卡SDK參數
that.readSetting();

// 初始化讀卡
that.initRead();
},

// 設置讀卡SDK參數
readSetting(){
// 日志保存目錄
// 默認在 Android/data/com.tencent.mm/MicroMsg/wxanewfiles目錄下 搜索 zrgk_mini_log
// 不需要日志時，可以不設置
plugin.setShowLog(wx.getFileSystemManager(), wx.env.USER_DATA_PATH);

// 讀卡參數設置，根據需要自行修改參數值，參數名稱及類型不可修改。
var _Setting = {
decodeImageType: "dn1", // dn0: 無照片 dn1: 平臺解碼照片
readCardType: 2, // 2：NFC 7：藍牙外設讀卡器
saveLog: true, // 是否保存日志文件。設置true時，必須調用以上的 plugin.setShowLog(); 設置日志保存的目錄
openLocalCache: true, // 是否開啟本地緩存
// 解碼配置。
ipPortArray: [{
address: yfs4.sfzydq.com,
port: 9999,
canUse: true
}]
};
// 將參數設置給插件
plugin.readSetting(_Setting);
},

// 初始化 讀卡示例代碼
initRead() {
if (initSuccess == true) {
wx.showToast({
title: 已經初始化過了,
icon: none
});
return;
}
// 初始化并開始讀卡
plugin.startReadCard(function (code, msg, value, cardType) {
let code_msg = "code：" + code + " " + "msg：" + msg;
that.setData({
msg: code_msg,
});
switch (code) {
case StatusCode.ININ_ING.code: // 初始化中
wx.showLoading({
title: 初始化中...,
mask: true
});
break;
case StatusCode.ININ_OK.code: // 初始化成功
initSuccess = true;
wx.hideLoading();
wx.showToast({
title: 初始化成功,
icon: success
})
break;
case StatusCode.ININ_FAILE.code: // 初始化失敗
initSuccess = false;
wx.hideLoading();
if (msg.indexOf("13000") != -1) {
wx.showModal({
title: 溫馨提示,
content: 設備不支持NFC,
complete: (res) => {}
});
} else if (msg.indexOf("13001") != -1) {
wx.showModal({
title: 溫馨提示,
content: 系統NFC開關未打開,
complete: (res) => {}
});
} else {
wx.showToast({
title: msg,
icon: error
})
}
break;
case StatusCode.FIND_CARD_START.code: // 開始尋卡
wx.showToast({
title: 開始尋卡,
icon: success
})
break;
case StatusCode.FIND_CARD_SUCCESS.code: // 尋卡成功
allCount += 1;
wx.showToast({
title: 尋卡成功,
icon: success
})
break;
case StatusCode.READCARD_START.code: // 開始解碼
wx.showLoading({
title: 請勿移動卡片,
mask: true
})
break;
case StatusCode.READCARD_SUCCESS.code: // 解碼成功
wx.hideLoading();
wx.showToast({
title: 解碼成功,
icon: success
})
switch (cardType) {
case StatusCode.CARD_IC.code: // IC卡
console.log("IC卡：" , value);
break;
case StatusCode.CARD_LCT_STUDENT.code: // 綠城通學生卡
console.log("綠城通學生卡：" , value);
break;
case StatusCode.CARD_LCT_NORMAL.code: // 綠城通普通卡
console.log("綠城通普通卡：" , value);
break;
case StatusCode.CARD_LCT_OLD.code: // 綠城通老年卡
console.log("綠城通老年卡：" , value);
break;
case StatusCode.CARD_IDCARD.code: //
// 讀取到的信息
// 詳細字段說明，詳見文檔下發的附錄
var idCardInfo = JSON.parse(value);
console.log("信息：" , idCardInfo);
// 當設置平臺解碼照片時，
// idCardInfo.image字段，為base64編碼的照片字符串，可直接用于顯示
// idCardInfo.type=1080 中國居民
// idCardInfo.type=1081 新版外國居住證
// idCardInfo.type=1082 港澳臺居住證
// idCardInfo.type=1083 舊版外國居住證
break;
case StatusCode.CARD_EPASSPORT.code: // 護照/通行證
// 讀取到的護照/通行證信息
// 詳細字段說明，詳見文檔下發的附錄
var cardInfo = JSON.parse(value);
console.log("信息：" , cardInfo);
// cardInfo.image字段，為base64編碼的照片字符串，可直接用于顯示
break;
}
break;
case StatusCode.READCARD_FAILE.code: // 解碼失敗
wx.hideLoading();
wx.showToast({
title: 解碼失敗 + msg,
icon: error
})
break;
}
});
},

onUnload() {
console.log("onUnload", "界面銷毀，需要停止讀卡");
plugin.stopReadCard();
}
})



4、獲取 deviceId
由于openid是由微信生成，網絡獲取可能存在延時。需在插件初始化成功后再獲取。
成功獲取到ID，都是以 “wxMini_” 開頭。


返回微信綁定ID。更換微信號或小程序宿主 ID會變。
需要將 https://epassport.sfzydq.com 配置合法域名
/
plugin.getDeviceId();
5、配置TCP合法域名
必須將參數配置時，配置的 ipPortArray 參數中的所有地址，加入到合法的TCP域名，
否則無法訪問到。
如配置：

tcp://yfs4.sfzydq.com
tcp://yfs3.sfzydq.com
tcp://yjm2.sfzydq.com
tcp://yfs3.sfzydq.com
tcp://passport.sfzydq.com
tcp://test.sfzydq.com
6、附錄
詳細信息IdCardData
字段 類型 注釋
type int 1080:中國居民
address string 家庭住址
birthday string 出生日期
dn string dn碼
endDate string 結束時間
startDate string 生效時間
id string 號碼
image String base64照片
issue string 簽發
name string 姓名
nation string 民族
sex string 性別
uuid string uuid
外國人居住證IdCardData：
字段 類型 注釋
type int 1081:新版外國人居住證 1083:舊版外國人居住證
birthday string 出生日期
dn string dn碼
endDate string 結束時間
startDate string 生效時間
id string 號碼
issue string 簽發
sex string 性別
uuid string uuid
image String base64照片
nameChinese string 中文姓名
nameEnglish string 英文姓名
nameEnglishAdd string 英文姓名備用
nationlity string 國籍
cardVersion string 卡版本號
cardType string 卡類型
historicalNumber string 既往版本號碼關聯項
renewalNumber string 換證次數
港澳臺居住證詳細信息IdCardData
字段 類型 注釋
type int 1082:港澳臺居住證
address string 家庭住址
birthday string 出生日期
dn string dn碼
endDate string 結束時間
startDate string 生效時間
id string 號碼
image String base64照片
issue string 簽發
name string 姓名
nation string 民族
sex string 性別
uuid string uuid
passCheckId string 通行證號碼
issuesNumber string 簽發次數
護照通行證詳細信息
字段 類型 注釋
nameOfHolder string 中文姓名
primaryIdentifier string 姓
secondaryIdentifier string 名
gender string 性別 M男 F女
dateOfBirth string 生日
nationality string 碼
dateOfExpiry string 有效期
documentNumber string 護照號碼
duration long 解碼時長
mrz string 機讀碼
personNumber string 個人號碼
idNumber string 號碼
image String base64照片