Skip to main content

​
Server API v4 support coming soon

This server SDK currently supports Server API v3. If you need Server API v4 today, use it directly or see the current integration compatibility table.

​
How to install

​
Using Maven

Add this dependency to your project’s POM:
XML
<repositories>
  <repository>
    <id>jitpack.io</id>
    <url>https://jitpack.io</url>
  </repository>
</repositories>
XML
<dependency>
  <groupId>com.github.fingerprintjs</groupId>
  <artifactId>fingerprint-pro-server-api-java-sdk</artifactId>
  <version>v7.0.0</version>
</dependency>

​
Using Gradle

Add this dependency to your project’s build file:
Groovy
repositories {
    maven { url 'https://jitpack.io' }
}

dependencies {
    implementation "com.github.fingerprintjs:fingerprint-pro-server-api-java-sdk:v7.0.0"
}

​
Others

Generate the JAR file:
Bash
./gradlew jar
Then manually install target/fingerprint-pro-server-api-sdk-7.0.0.jar.

​
Usage

Initialize the client instance and use it to make API requests. You need to specify your secret API key and region (if it is not US/Global).
Java
import com.fingerprint.api.FingerprintApi;
import com.fingerprint.model.EventsGetResponse;
import com.fingerprint.model.VisitorsGetResponse;
import com.fingerprint.sdk.ApiClient;
import com.fingerprint.sdk.ApiException;
import com.fingerprint.sdk.Configuration;
import com.fingerprint.sdk.Region;

public class FingerprintApiExample {
  public static void main(String... args) {
    ApiClient client = Configuration.getDefaultApiClient(
      "<SECRET_API_KEY>",
      // Region.EUROPE
    );
    FingerprintApi api = new FingerprintApi(client);

    // Get visit history of a specific visitor
    try {
      VisitorsGetResponse response = api.getVisits("<visitorID>");
      System.out.println(response.getVisits().toString());
    } catch (ApiException e) {
      System.err.println(e.getMessage());
    }

    // Get a specific identification event
    try {
      EventsGetResponse response = api.getEvent("<requestID>");
      System.out.println(response.getProducts().toString());
    } catch (ApiException e) {
      System.err.println(e.getMessage());
    }
  }
}

​
Documentation

You can find the full documentation in the official GitHub repository.