Legiti防欺诈
Legiti防欺诈SDK,用于Swift(iOS应用)集成。
描述
Legiti是一款帮助您的公司避免欺诈交易的产品。此README文件应帮助您通过几个步骤将Legiti iOS库集成到您的产品中。
备注:库是用Swift编写的,这里展示的所有代码也都是Swift。
如何使用
Legiti iOS库可以通过CocoaPods进行安装。要安装,请按照以下步骤操作:
- 将我们的库添加到Podfile中(
pod Legiti
) - 运行
pod install
命令
备注:在导入Legiti库时,您会发现您实际上安装了不止一个库,因为Legiti iOS库有一些依赖关系。
API文档
有关我们前端库和一般集成的更多详细文档,请参阅此处。
库设置
为了正确地向外传递信息给Legiti处理管道,您需要提供您特定的认证凭证
- authToken(由Legiti提供)
提示:在非生产环境中,请务必使用沙箱authToken
有了这些,您就可以实例化Legiti跟踪实例。我们的集成库实例化一个单例实例以防止实例化多个跟踪器,否则可能会导致向Legiti传递的重复或不一致的数据。除此之外,单例将使您只需配置一次库。
以下是如何实例化单例实例:
do {
try Legiti.sharedInstance().setup(authToken: "authToken")
} catch TrackerException.requiredConfig(let code, let message) {
print("code: \(code) - message: \(message)")
} catch {
print("Error")
}
请注意,如果您传递无效的authToken(空字符串或格式不正确),则此函数可能会抛出异常。
我们强烈建议您在应用程序中的AppDelegate
中的didFinishLaunchingWithOptions
函数中实例化Legiti库,因为这样可以将库配置在应用加载时,从而允许调用库函数。
所有对Legiti函数的访问都是通过调用Legiti.sharedInstance()
来实现的。
该函数只接受一个参数
参数 | 必须 | 类型 | 描述 |
---|---|---|---|
authToken | 是 | 字符串 | 一个唯一的标识符,Legiti团队会提供给您 |
提示:始终记得使用import Legiti
导入库
库调用
如果您已经阅读了Legiti通用文件,您应该知道所有的Legiti请求和收集函数。
在此,我们将向您展示在调用Legiti跟踪函数时应注意的一些细节。
我们所有的跟踪函数都可以抛出异常,但它们唯一会抛出的异常是如果您在调用其中一个之前忘记配置Legiti库。因此,Legiti类有一个名为isConfigured()
的函数,该函数返回一个布尔值,说明您是否已配置Legiti库。我们建议您在调用我们的任何跟踪函数时检查Legiti库是否已配置。以下是如何这样做的一个示例
if (Legiti.sharedInstance().isConfigured()) {
try! Legiti.sharedInstance().trackUserCreation(userId: "123")
}
TrackScreenView
与 Legiti Javascript 库不同,用户页面浏览跟踪(screenview)不是自动完成的。您需要在每个新页面上添加 trackPageView
函数。我们 强烈建议 您将函数添加到应用程序中每个 ViewController 的 viewDidLoad
中,因为这样我们可以在页面浏览/屏幕浏览操作发生时立即跟踪。下面是这种实现的一个示例。
override func viewDidLoad() {
super.viewDidLoad()
if (Legiti.sharedInstance().isConfigured()) {
try! Legiti.sharedInstance().trackPageView(pageTitle: "login-page")
}
}
用户位置
Legiti iOS 库可以利用用户位置来帮助我们提供更准确的结果,但它将 永远 不会要求这样做。如果您的应用程序已经有访问用户位置的权限,库将自动捕获它,否则它不会将位置发送给我们。
模型
如果您是从我们的后端库中来的,您会注意到我们前端库中不使用模型(例如,Account、Sale)。这里您只需要发送给我们模型的 ID(例如,销售 ID、账户 ID)。
更多信息
更多详情请参阅 Legiti 前端文档