README.md

Fingerprint’s Device Intelligence platform for Android helps you to accurately identify the devices on which your mobile app is being used. The platform also provides high-quality Smart Signals that will help you identify risky transactions before they happen. The Fingerprint Pro Demo App for Android allows you to effortlessly experience the capabilities of our device intelligence platform.

Fingerprint Pro Demo App in Google Play

About

This repository contains the source code for the Fingerprint Pro Demo App for Android. It shall serve as a good example

• For integrating the Fingerprint Identification SDK in your Android app, complimenting our Getting Started Guide;
• For best practices to follow when using the Fingerprint Identification SDK in your app.

Getting started

Install the app

You can install the app using one of the following methods:

1. Install from Google Play
2. Download and install .apk file from the Releases page
3. Build the app from sources

Build the app from sources

Build the app from sources in a few simple steps:

1. Clone the repository:

   git clone https://github.com/fingerprintjs/fingerprint-device-intelligence-android-demo.git

2. Open the cloned repository in Android Studio.

3. In file app/src/main/java/com/fingerprintjs/android/fpjs_pro_demo/constants/Credentials.kt,

   • Replace the value for apiKey with your Public API Key. You can find the Public API Key in your dashboard under API Keys.

     import com.fingerprintjs.android.fpjs_pro.Configuration
     
     object Credentials {
       val apiKey: String = "YOUR_PUBLIC_API_KEY"
     }

   • If you do not have a custom sub-domain or a proxy integration, then the value of endpointUrl should match the region you specified when registering your app with Fingerprint.

     import com.fingerprintjs.android.fpjs_pro.Configuration
     
     object Credentials {
       val endpointUrl: String = Configuration.Region.US.endpointUrl
     }

   • If you have set up a have a custom sub-domain or a proxy integration, then the value of endpointUrl should represent the endpoint through which you want to route the requests.

     import com.fingerprintjs.android.fpjs_pro.Configuration
     
     object Credentials {
       val endpointUrl: String = "https://fingerprint.example.com"
     }

4. In the "Build Variants" tool window, choose a build variant that suits your needs. All the available build variants are listed under buildTypes{...} in file app/build.gradle.kts

   💡 The debug and debugOptimized variants of the app include an icon that allows you to iteratively build the UI without making an actual request to our Fingerprint servers. And save API calls!

5. Run the app on the selected device

Fingerprint Identification SDK

Following up on the information provided in our Getting Started Guide, you might refer to this repository for an example of:

Getting the response

• The SDK configuration code is located at the di package of the app module.
• The method getVisitorId() method is abstracted in IdentificationProvider class.

Examining the response

The method IdentificationProvider.getVisitorId() is called in the file HomeViewModel.kt file. The result is displayed by the EventDetailsView composable either in prettified or raw format.

License

The source code in this repository is licensed under the MIT license.