> 文檔版本:1.0.1
> 編輯時間:2021.10.10
## 盛事通App身份證質量檢測(掃身份證)組件說明:
1.H5端調用App的needCardOnly 方法拉起身份證質量檢測界面,用戶需進行掃身份證的操作,此方法有3個可選參數如下:
cardNo:替H5暫存的身份證號,將會在回調時帶回
type:H5業務參數
zip:是否對身份證照片進行壓縮,如需壓縮,傳入字符串1,此時將壓縮照片至350KB以下
2.身份證掃描完成后會觸發resolve
3.H5端拿到 base64 后,根據自身業務需要進行后續的開發
4.cardOnlyImage具體返回的參數如下:
參數1:身份證號,H5在調用App的needCardOnly方法中傳的參數cardNo,App負責原樣帶回(有則返回,無則反空串)
參數2:身份證正面整體照片Base64(一定有)
參數3:身份證正面人像照片Base64(一定有)
參數4:App負責原樣帶回(有則返回,無則反空串)
5.如果此組件出現錯誤或異常則App會回調reject方法并傳入錯誤碼,例如。H5根據錯誤碼進行后續的業務,錯誤碼對照表如下:
> 1000 通用性失敗錯誤碼,不確定問題出在哪里,但就是所期望的結果未達成。
1001 用戶主動取消操作,比如用戶主動點擊了返回按鈕等用戶主動中斷業務流程的情況。
1002 用戶未授權相關操作的系統權限,比如說詢問是否可以使用手機相機的時候點擊了“否”。
1003 接口錯誤,與此業務相關的接口,沒有按照約定返回可以達成業務的返回值,導致業務處理失敗。
1004 SDK錯誤,如果此業務需要調用相應的SDK來完成,在調用SDK的過程中出現SDK的錯誤會返回此錯誤碼。
1005 用戶操作不規范所導致的錯誤,比如說用戶未按照人臉識別功能的要求做完相應的動作,導致業務無法繼續的問題。
1006 App代碼級別出現錯誤或異常導致業務無法進行。
```
const payload = {cardNo: 1,type: 2,zip: 3}
this.$hdsdk.needCardOnly(payload).then(console.log).catch(console.error)
```