API Reference

SDK for Mobile Integration

Koin's iOS SDK for Mobile Fingerprinting

Installation (CocoaPods)

KoinFingerprint is available through CocoaPods. To install it, simply add the following line to your Podfile:

    pod 'KoinFingerprint'

Note: If you want to learn more about CocoaPods for dependency management, check out their Using CocoaPods guide.

Manually

  • Open the folder location of KoinFingerprint-xcframework.zip and unzip it.
  • Drag the KoinFingerprint.xcframework into the Project Navigator of you Xcode project.
  • When prompt with the options for adding files:
    Make sure that Copy items if needed is checked, as well as the target you want to add the library to.
  • Check your target's "Frameworks, Libraries, and Embedded Content" section and make sure the library embed option is set to "Embed & Sign"
    If the framework does not appear there, click the + button and select it from the list of available frameworks
  • Check your target's "Build Phases" section and make sure the library was added to the "Link Binary With Libraries" status is set to "Required"
    If the framework does not appear there, click the + button and select it from the list of available frameworks

Usage

First, import the library on you AppDelegate or main file 

import KoinFingerprint

Now, initiate the beacon at the end of didFinishLaunchingWithOptions or applicationDidFinishLaunching:

KoinFingerprinter.register(organizationId: "YOUR_ORG_ID")

For production environments an override of the default url is needed, learn more here.

After your organization is registered, you can proceed with profiling the device to get the sessionId.

let sessionId = KoinFingerprinter.profile()

The sessionId returned needs to be provided by the backend when using Koin's Gateway or Fraud Prevention services.
Custom sessionId and timeout can be provided when profiling, learn more here.