SynapsVerify 0.0.6

SynapsVerify 0.0.6

由以下人员维护:Florian Le GoffAdmin SynapsRiwan LasmiJamy Bailly



  • Synaps

Synaps verify

Swift Version Build Status License CocoaPods Compatible Platform PRs Welcome

Synaps 是一个全功能的合规平台。它提供了简单、快速、安全的方式以满足大规模合规要求。

访问 Synaps.io | 阅读 Synaps 文档

enter image description here

安装

CocoaPods

pod 'SynapsVerify'

Carthage

github "synaps-io/ios-verify"

Swift 包管理器

dependencies: [
    .package(url: "https://github.com/synaps-io/ios-verify", from: "1.0.0")
]

使用

import SynapsVerify

SwiftUI

...
@State private var sessionId = ""
var body: some View {
    ...
    VerifyView(
        sessionId: self.$sessionId,
        lang: .french,
    )
    ...

Storyboard

如何设置它

这个库允许您使用标准 View 的所有功能,并带来许多新奇的功能。

首先,在 Storyboard 中的视图控制器中拖放一个新 View。

然后将 View 类设置为 VerifyUiView 并将您的视图链接到 ViewController 中相同类型的变量。

如何启动它

Swift

import UIKit
import SynapsVerify

class VerifyViewController : UIViewController {
    @IBOutlet weak var verifyView: VerifyUiView!

    var sessionId: String = ""

    override func viewDidLoad() {
        super.viewDidLoad()
        
        verifyView.startSession(sessionId: sessionId, lang: .french)
    }
}

您可以自由使用 VerifyUiView 而不使用 Storyboard。

首先,您应该设置会话 ID。会话 ID 可以称为客户验证会话。 更多信息

参数列表

参数名 参数类型 默认值 必需 描述
sessionId 字符串 '' 会话可以称为客户验证会话。 更多信息
lang VerifyLang .english 您可以设置用户预定义的语言。Synaps 已经利用浏览器语言为最终用户显示相关语言,但如果您的用户已将语言选项设置为您的网站,您绝对可以将其作为选项传递。
tier 整数 层是分割工作流程的一种简单方法。当您根据客户的验证级别提供不同的功能时,它非常有用。 更多信息

配置

在启动 Verify 会话之前。您的应用程序项目需要一些配置。

NFC

应用必须声明使用 NFC 芯片,并且必须具有 NFC 权限

<key>com.apple.developer.nfc.readersession.formats</key>
<array>
    <string>TAG</string>
</array>

Info.plist 文件必须包含字段 NFCReaderUsageDescription

您的应用程序的 Info.plist 文件必须包含用于扫描文件的所需应用程序 ID。

<key>com.apple.developer.nfc.readersession.iso7816.select-identifiers</key>
<array>
    <string>A0000002471001</string>
    <string>A0000002472001</string>
    <string>E80704007F00070302</string>
    <string>A000000167455349474E</string>
    <string>A0000002480100</string>
    <string>A0000002480200</string>
    <string>A0000002480300</string>
    <string>A00000045645444C2D3031</string>
    <string>D2760000850101</string>
    <string>00000000000000</string>
</array>

更多信息请参阅: https://developer.apple.com/documentation/corenfc/nfciso7816tag

相机

Info.plist 文件必须包含字段 NSCameraUsageDescription

为了能够拍照和分析身份证明文件,需要使用相机权限,并且必须在构建 Verify 视图之前(SwiftUI 或 UIKit)声明这些权限。如果视图构建时未获得这些权限,Verify 视图将触发 fatalError

AVCaptureDevice.requestAccess(
    for: .video,
    completionHandler: { accessGranted in
        ...
    }
)

监听器

现在您已准备好通过回调使用监听器来监听 Verify 事件。

Swift UI

VerifyView(
    ...
)
.onReady {
    ...
}
.onFinished {
    ...
}

UIKit

verifyView.onReady {
    ...
}
verifyView.onFinished {
    ...
}

监听器列表

参数名 参数类型 默认值 必需 描述
onReady () => Void 当页面完全加载时调用的监听器
onFinished () => Void 当用户完成验证时调用的监听器

元数据

@synaps

https://github.com/synaps-hub/ios-verify