FingerprintJS Pro iOS Integrations
An example app and packages demonstrating FingerprintJS Pro capabilities on the iOS platform. The repository illustrates how to retrieve a FingerprintJS Pro visitor identifier in a native mobile app. These integrations communicate with the FingerprintJS Pro API and require browser token. If you are interested in the Android platform, you can also check our FingerprintJS Pro Android integrations.
There are two typical use cases:
- Using our native library to retrieve a FingerprintJS Pro visitor identifier in the native code OR
- Retrieving visitor identifier using signals from the FingerprintJS Pro browser agent in the webview on the JavaScript level combined with vendor identifier.
Using the external library to retrieve a FingerprintJS Pro visitor identifier
This integration approach uses our library FingerprintJSPro. It collects various signals from the iOS system, sends them to the FingerprintJS Pro API for processing, and retrieves an accurate visitor identifier.
1. Installation
CocoaPods
Specify the following dependency in your Podfile:
pod 'FingerprintJSPro', '~> 1.1.0'
Swift Package Manager
Add the following dependency to your Package.swift.
dependencies: [
.package(url: "https://github.com/fingerprintjs/fingerprintjs-pro-ios-integrations", .upToNextMajor(from: "1.1.0"))
]
2. Import
import FingerprintJSPro
3. Get the visitor identifier
You can find your browser api token in your dashboard.
FingerprintJSProFactory
.getInstance(
token: "your-browser-token",
endpoint: nil, // optional
region: nil // optional
)
.getVisitorId { result in
switch result {
case let .failure(error):
print("Error: ", error.localizedDescription)
case let .success(visitorId):
print("Success: ", visitorId)
}
}
Params
token: string- API token from the FingerprintJS dashboardendpoint: URL?-nilfor default endpoint, possible format for custom endpoint:URL(string: "https://fp.yourdomain.com")region: String?-nilfor the Global region,eufor the European region
Tags support
FingerprintJSProFactory
.getInstance(
token: "your-browser-token",
endpoint: nil, // optional
region: nil // optional
)
.getVisitorId(tags: ["sessionId": sessionId]) { result in
switch result {
case let .failure(error):
print("Error: ", error.localizedDescription)
case let .success(visitorId):
print("Success: ", visitorId)
}
}
Using inside a webview with JavaScript
This approach uses signals from FingerprintJS Pro browser agent together with iOS device vendor identifier. The vendor identifier is added to the tag field in the given format. FingerprintJS Pro browser agent adds an additional set of signals and sents them to the FingerprintJS Pro API. Eventually, the API returns accurate visitor identifier.
1. Add a JavaScript interface to your webview
let vendorId = UIDevice.current.identifierForVendor.flatMap { "'\($0.uuidString)'" } ?? "undefined"
let script = WKUserScript(source: "window.fingerprintjs = { 'vendorId' : \(vendorId) }",
injectionTime: .atDocumentStart,
forMainFrameOnly: false)
webView.configuration.userContentController.addUserScript(script) // the webview should contain a webpage with injected and configured fingerprintjs-pro
2. Setup the JavaScript FingerprintJS Pro integration in your webview
function initFingerprintJS() {
// Initialize an agent at application startup.
const fpPromise = FingerprintJS.load({
token: "your-browser-token",
endpoint: "your-endpoint", // optional
region: "your-region", // optional
});
// Get the visitor identifier when you need it.
fpPromise
.then((fp) =>
fp.get({
environment: {
deviceId: window.fingerprintjs.vendorId, // use vendor ID as device ID
type: "ios",
}
})
)
.then((result) => console.log(result.visitorId));
}
Params
You can find your browser token in your dashboard. Params format and properties are the same as in JS agent
The full example content view for SwiftUI with configured fingerprintjs-pro might look like:
import SwiftUI
import WebKit
struct ContentView: View {
var body: some View {
Webview(url: URL(string: "https://eager-hermann-4ea017.netlify.app")!) // this URL should refer to the webpage with injected and configured fingerprintjs-pro
}
}
struct Webview: UIViewRepresentable {
let url: URL
func makeUIView(context: UIViewRepresentableContext<Webview>) -> WKWebView {
let webview = WKWebView()
let vendorId = UIDevice.current.identifierForVendor.flatMap { "'\($0.uuidString)'" } ?? "undefined"
let script = WKUserScript(source: "window.fingerprintjs = { 'vendorId' : \(vendorId) }", injectionTime: .atDocumentStart, forMainFrameOnly: false)
webview.configuration.userContentController.addUserScript(script)
let request = URLRequest(url: self.url, cachePolicy: .returnCacheDataElseLoad)
webview.load(request)
return webview
}
func updateUIView(_ webview: WKWebView, context: UIViewRepresentableContext<Webview>) {
let request = URLRequest(url: self.url, cachePolicy: .returnCacheDataElseLoad)
webview.load(request)
}
}
Additional Resources
FingerprintJS Pro documentation
License
This library is MIT licensed.
15 Oct 9, 2022
0 Jan 25, 2022
35 Dec 14, 2022
0 Dec 11, 2021
583 Jan 5, 2023
4 Feb 7, 2022
0 Feb 9, 2022
1 Jan 31, 2022
27 Oct 4, 2022
55 Dec 19, 2022
53 Nov 29, 2022
1 Dec 15, 2021
3 Dec 16, 2022
701 Dec 23, 2022
200 Dec 18, 2022
37 Dec 10, 2022
22 Oct 16, 2022
436 Jan 5, 2023
12 Feb 11, 2022