The DataCollector SDK collects and sends device information to improve fraud detection accuracy, and identify devices.
- Requirements
- App permissions
- System Frameworks
- Installation
- How to use
- Testing the integration
- Objective-C
- Sample App
- Cross-platform frameworks
- Report Issues
- License
- Xcode 12+
- Supports iOS 10 or higher
The SDK will not ask the user for any permission but if granted to the app, they will be used to gather some information
- Location
- IDFA
The SDK uses the following system frameworks
- Foundation
- WebKit
- UIKit
- CoreTelephony
- LocalAuthentication
- MessageUI
- CFNetwork
- CoreLocation (Optional)
- AdSupport (Optional)
There are different ways to install the SDK:
- CocoaPods 1.10.1 or greater is required, please verify with:
pod --version- Add pod to Podfile (Example)
pod 'DLDataCollectorSDK', '~> 0.1.8'- Run install
pod install- Use pod update as needed to keep the sdk up to date
-
Go to Releases and download the latest version
-
Unzip & follow the apple docs to add the xcframework to your project
The first thing to do is set up the SDK on app launch, this step is necessary to initialize the SDK.
For that simply add the setup call on app startup, we recommend adding it to application:didFinishLaunchingWithOptions in the app delegate like so:
import DLDataCollectorSDK
@main
class AppDelegate: UIResponder, UIApplicationDelegate {
{...}
func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) -> Bool {
let settings = DLSettings(apiKey: "API KEY")
DLCollector.shared.setUp(settings)
return true
}
}Replacing apiKey with your key.
See the SampleApp AppDelegate for a detailed example.
If you're app is using SwiftUI and doesn't have a custom AppDelegate, put the equivalent code inside the init of the App struct like so:
@main
struct ExampleApp: App {
init() {
let settings = DLSettings(apiKey: "API KEY")
DLCollector.shared.setUp(settings)
}
}Start session will gather device information, and generate a sessionId.
This step can be done any time, but it's recommended to call it as soon as a session is present in your application state.:
try? DLCollector.shared.startSession()You can also associate additional data related to each session to improve the fraud prevention
score. The following example shows how to pass a user reference or id inside the DLAdditionalData object.
let data = DLAdditionalData(userReference: "user-id")
try? DLCollector.shared.startSession(additionalData: data)NOTE: This method runs in a background thread and doesn't block the main thread.
See the SampleApp ViewController for a detailed example
When the user starts the checkout transaction, gather the session id like so:
let sessionId = DLCollector.shared.getSessionId()Submit this value in the payment request within the additional_risk_data.device.event_uuid parameter. The method can return null if a session is not available or an error occurred.
Once integrated, you can use the .verbose log level to see if the SDK is working. This can be done by changing the setup settings like so:
let settings = DLSettings(apiKey: "SBX API KEY", env: .sandbox, logLevel: .verbose)And looking at the console, when startSession is run, we should see the folloowing logs if everything is working:
DLDataCollector 💾: Success getting session ID
DLDataCollector 💾: SessionId: 6f13dc3e-c689-4627-95f3-060c7ac525c0
We strongly recommend that you use the SANDBOX environment when testing, and only use PRODUCTION in production ready builds.
To do so, you can use the setup and DLSettings to configure a different environment, i.e:
#if DEBUG
let settings = DLSettings(apiKey: "SBX API KEY", env: .sandbox, logLevel: .verbose)
#else
let settings = DLSettings(apiKey: "PROD API KEY", env: .production, logLevel: .silent)
#endifReplacing the apiKey with yours for each environment.
If you need to use the SDK from Objcetive-C, checkout the sample app's ObjC wrapper. Then use swift interoperability as explained here
If your app is distributed through the App Store, you musst comply with the App Store rules. When using this SDK you must ensure the following:
- Add a disclaimer in the app that says that device data is collected and sent to a third party (dlocal).
- If your app uses location, please add to the info.plist NSLocatioUsageeDescription keys a disclaimer that the location data will also be used in fraud prevention.
The SDK will only use location data if the app is using it already, so it is not necessary to add a location disclaimer if location is not used.
For more information please refer to apple's documentation for more information.
In this repository there's a sample app to showcase how to use the SDK, please refer to the code for more detailed examples.
This SDK can be included in any native app, we also made available the following plugins for cross-platform frameworks:
If you have a problem or find an issue with the SDK please contact us at mobile-dev@dlocal.com
MIT License
Copyright (c) 2022 DLOCAL
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.