收集 SDK 返回值
要获取 SDK 的响应,您必须在您的 controller 中实现 ZaigIosFaceRecognitionControllerDelegate 代理,如旁边的示例所示。
class ViewController: UIViewController, ZaigIosFaceRecognitionControllerDelegate {
// Do something if QI Tech FaceRecognition's SDK succesfully collected document picture
func zaigIosFaceRecognitionController(_ faceRecognitionViewController: ZaigIosFaceRecognitionController, didFinishWithResults response: ZaigIosFaceRecognitionControllerResponse) {
}
// Do something if QI Tech FaceRecognition's SDK found any error when collecting document picture
func zaigIosFaceRecognitionController(_ faceRecognitionViewController: ZaigIosFaceRecognitionController, didFailWithError error: ZaigIosFaceRecognitionControllerError) {
}
// Do something if the user canceled the picture collection on any steps
func zaigIosFaceRecognitionControllerDidCancel(_ faceRecognitionViewController: ZaigIosFaceRecognitionController) {
}
}
ZaigIosFaceRecognitionControllerResponse
ZaigIosFaceRecognitionControllerResponse 类用于接收来自 QI Tech SDK 的响应。
下表中包含此类所有属性的详细信息:
属性
注意:
与 Device Scan 集成 从版本 6.1.0 起,Face Recognition 服务会自动内部调用 Device Scan。因此,成功返回值将包含 DeviceScanSessionId 字段。此密钥标识内部执行的设备扫描会话,可在 QI Tech 生态系统的其他服务中集成使用。
| 名称 | 类型 | 描述 |
|---|---|---|
FaceRecognitionKey | String | 存储在 QI Tech 中的面部照片唯一标识符。重要: 请保存此值以便在验证 API 中发送(例如:Onboarding API)。 |
DeviceScanSessionId | String | 内部执行的设备扫描会话唯一标识符。 |
ZaigIosFaceRecognitionControllerError
当发生导致 SDK 关闭的错误时,将触发 ZaigIosFaceRecognitionControllerError 类。
重要提示!
从版本 5.0.0 起,错误结构已重构以提供更详细的诊断信息。
主要变化:
- 新错误类型:
InvalidToken(替代InvalidMobileToken) - 新增可用属性:
status_code:错误的 HTTP 状态码reason:错误原因标识符description:错误的详细描述
错误结构(SDK 5.0.0+)
示例:InvalidToken
{
status_code: 401,
reason: "INVALID_TOKEN",
description: "Authentication token expired or invalid"
}
错误类型
SDK 5.0.0 及以后版本
| 错误 | Status Code | 描述 |
|---|---|---|
InvalidToken | 401 | 认证令牌已过期或无效(替代 InvalidMobileToken) |
5.0.0 之前的版本
| 错误类 | 描述 |
|---|---|
InvalidMobileToken | 配置中发送的 MobileToken 无效 (在 v5.0.0+ 中被 InvalidToken 替代) |
MissingPermission | 某些必要权限未被授予 |
NetworkFailure | 验证期间网 络连接中断 |
ServerFailure | QI Tech 服务器返回错误响应 |
MissingStorage | 存储空间不足 |
LowImageQuality | 图片质量不足以进行验证 |