Giter VIP home page Giter VIP logo

aev's Introduction

FingerprintJS

Discord server

Android minAPI status Latest release

Android Application Environment Verification API

Android library to verify application environments.

Make sure every API call from a device is safe and trusted.

Instantly detect rooted devices or emulators.

The library sends a set of signals to the server.

The server verifies safety of the application environment.

Table of Contents

  1. Quick start
  2. API keys
  3. Demo App

Quick start

Add the repository to the build.gradle.

If your version of Gradle is earlier than 7, add these lines to your build.gradle.

allprojects {	
  repositories {
  ...
  maven { url 'https://jitpack.io' }	
}}

If your version of Gradle is 7 or newer, add these lines to your settings.gradle.

repositories {
  ...
  maven { url "https://jitpack.io" }
}

Add dependencies

This library depends on kotlin-stdlib, fingerprint-android

Add these lines to build.gradle of a module.

If your application is written in Java, add kotlin-stdlib dependency first (it's lightweight and has excellent backward and forward compatibility).

dependencies {
  implementation "com.github.fingerprintjs:fingerprint-android:1.2"
  implementation "com.github.fingerprintjs:aev:1.0.2"
  // Add this line only if you use this library with Java
  implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
}

Get an API keys

A free API keys are required to connect to our Application Environment Verification API. Use the Public one on the client side, and the Secret one on the server side.

To get your API keys, please ping us on Discord or email us at [email protected] (just type API keys in the email subject, no need to compose a body)

Get the request ID

Kotlin

// Initialization
val aevClient = AevClientFactory.getInstance(
    applicationContext,
    YOUR_PUBLIC_API_KEY
)


// Get the RequestID
aevClient.getRequestId(
                listener = { requestId ->
                    // Handle the string with requestId
                },
                errorListener = { error ->
                    // Handle the error string
                })

See the client API reference

Get the results of verification by the request ID

Request

curl https://aev.fpapi.io/api/v1/verify \
  -H 'Content-Type: application/json' \
  -d '{"secretKey": "YOUR_PRIVATE_API_KEY", "requestId": "YOUR_REQUEST_ID"}'

Response

{
  "deviceId": "1xu9l9Ure84KB8CnEbABmteHhhc",
  "results": {
    "rootManagementAppsDetected": true,
    "emulatorDetected": true
  }
}

See the server API reference

Demo app

Try all the features in the Demo App.

PlaygroundApp

Android API support

Android application protection library supports API versions from 21 (Android 5.0) and higher.

License

This library is MIT licensed. Copyright FingerprintJS, Inc. 2020-2022.

aev's People

Contributors

alexey-verkhovsky avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.