Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/fingerprintjs/fingerprint-pro-server-api-java-sdk

Java SDK for Fingerprint Pro Server API
https://github.com/fingerprintjs/fingerprint-pro-server-api-java-sdk
audio-fingerprinting browser browser-fingerprint browser-fingerprinting detection fingerprint fingerprinting fingerprintjs fingerprintjs-pro fraud fraud-detection identification java visitor-identification
Last synced: 9 days ago
JSON representation
Java SDK for Fingerprint Pro Server API
Host: GitHub
URL: https://github.com/fingerprintjs/fingerprint-pro-server-api-java-sdk
Owner: fingerprintjs
License: mit
Created: 2022-11-10T09:20:14.000Z (about 2 years ago)
Default Branch: main
Last Pushed: 2024-04-08T12:30:36.000Z (7 months ago)
Last Synced: 2024-04-08T20:04:29.622Z (7 months ago)
Topics: audio-fingerprinting, browser, browser-fingerprint, browser-fingerprinting, detection, fingerprint, fingerprinting, fingerprintjs, fingerprintjs-pro, fraud, fraud-detection, identification, java, visitor-identification
Language: Java
Homepage:
Size: 22.2 MB
Stars: 9
Watchers: 7
Forks: 4
Open Issues: 3
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: contributing.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project

README

        


    

        

            

            

            

        

    





    

    

    

    

    

    



# Fingerprint Pro Server API Java SDK

[Fingerprint](https://fingerprint.com/) is a device intelligence platform offering 99.5% accurate visitor identification. The Fingerprint Server Java SDK is an easy way to interact with the Fingerprint [Server API](https://dev.fingerprint.com/reference/pro-server-api) from your Java application. You can retrieve visitor history or individual identification events.

*Automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)*

## Requirements

The following versions of Gradle/Maven are supported

- Maven (3.8.3+)

- Gradle (7.2+)

The following versions of Java are supported

- Java 11

- Java 17

- Java 21

## Installation

### Maven users

Add this dependency to your project's POM:

```xml

    

        jitpack.io

        https://jitpack.io

    

```

```xml

  com.github.fingerprintjs

  fingerprint-pro-server-api-java-sdk

  v6.2.0

```

### Gradle users

Add this dependency to your project's build file (`build.gradle` or `build.gradle.kts`):

```groovy

// build.gradle

repositories {

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

}

dependencies {

  implementation "com.github.fingerprintjs:fingerprint-pro-server-api-java-sdk:v6.2.0"

}

```

```kotlin

// build.gradle.kts

repositories {

  maven {

    url = uri("https://jitpack.io")

  }

}

dependencies {

  implementation("com.github.fingerprintjs:fingerprint-pro-server-api-java-sdk:v6.2.0")

}

```

### Others

At first generate the JAR by executing:

```shell

./gradlew jar

```

Then manually install the following JARs:

- `target/fingerprint-pro-server-api-sdk-6.2.0.jar`

## Getting Started

Please follow the [installation](#installation) instruction and execute the following Java code:

```java

package main;

import com.fingerprint.api.FingerprintApi;

import com.fingerprint.model.EventResponse;

import com.fingerprint.model.Response;

import com.fingerprint.sdk.ApiClient;

import com.fingerprint.sdk.ApiException;

import com.fingerprint.sdk.Configuration;

import com.fingerprint.sdk.Region;

public class FingerprintApiExample {

    // Fingerprint Pro Secret API Key

    private static final String FPJS_API_SECRET = "Fingerprint Pro Secret API Key";

    // A mandatory visitorId of a specific visitor

    private static final String FPJS_VISITOR_ID = "visitorId";

    // An optional requestId made by a specific visitor

    private static final String FPJS_REQUEST_ID = "requestId";

    // An optional linkedId of the visit

    private static final String FPJS_LINKED_ID = "linkedId";

    // An optional parameter limiting scanned results

    private static final Integer LIMIT = 10;

    // An optional parameter used to paginate results, see lastTimestamp

    private static final String PAGINATION_KEY = "1683900801733.Ogvu1j";

    public static void main(String... args) {

        // Create a new api client instance from Configuration with your Fingerprint Pro Server API Key and your Fingerprint Pro Server API Region.

        /*

        You can specify a region on getDefaultApiClient function's second parameter

        If you leave the second parameter empty, then Region.GLOBAL will be used as a default region

        Options for regions are:

        Region.GLOBAL

        Region.EUROPE

        Region.ASIA

        */

        ApiClient client = Configuration.getDefaultApiClient(FPJS_API_SECRET, Region.EUROPE);

        FingerprintApi api = new FingerprintApi(client);

        // Get an event with a given requestId

        try {

            // Fetch the event with a given requestId

            EventResponse response = api.getEvent(FPJS_REQUEST_ID);

            System.out.println(response.getProducts().toString());

        } catch (ApiException e) {

            System.err.println("Exception when calling FingerprintApi.getEvent:" + e.getMessage());

        }

        // Update an event with a given requestId

        try {

            EventUpdateRequest request = new EventUpdateRequest();

            request.setLinkedId("myNewLinkedId");

            api.updateEvent(FPJS_REQUEST_ID, request);

        } catch (ApiException e) {

            System.err.println("Exception when calling FingerprintApi.updateEvent:" + e.getMessage());

        }

        // Get a specific visitor's all visits

        try {

            // Fetch all visits with a given visitorId, with a page limit

            Response response = api.getVisits(FPJS_VISITOR_ID, null, null, LIMIT, null, null);

            System.out.println(response.getVisits().toString());

        } catch (ApiException e) {

            System.err.println("Exception when calling FingerprintApi.getVisits:" + e.getMessage());

        }

        // Get a specific visitor's all visits with a linkedId

        try {

            // Fetch all visits with a given visitorId, with a page limit, skipping the first visit

            Response response = api.getVisits(FPJS_VISITOR_ID, null, FPJS_LINKED_ID, LIMIT, PAGINATION_KEY, null);

            System.out.println(response.getVisits().toString());

        } catch (ApiException e) {

            System.err.println("Exception when calling FingerprintApi.getVisits:" + e.getMessage());

        }

        // Use all the parameters on getVisits

        try {

            // Fetch the visitor's all visits with a given requestId and linkedId with a page limit while skipping the first visit

            Response response = api.getVisits(FPJS_VISITOR_ID, FPJS_REQUEST_ID, FPJS_LINKED_ID, LIMIT, PAGINATION_KEY, null);

            System.out.println(response.getVisits().toString());

        } catch (ApiException e) {

            System.err.println("Exception when calling FingerprintApi.getVisits:" + e.getMessage());

        }

        // Delete visitor data with a given visitorID

        try {

            api.deleteVisitorData(FPJS_VISITOR_ID);

        } catch (ApiException e) {

            System.err.println("Exception when calling FingerprintApi.deleteVisitorData:" + e.getMessage());

        }

    }

}

```

## Sealed results

This SDK provides utility methods for decoding [sealed results](https://dev.fingerprint.com/docs/sealed-client-results).

```java

package com.fingerprint.example;

import com.fingerprint.Sealed;

import com.fingerprint.model.EventResponse;

import java.util.Base64;

public class SealedResults {

    public static void main(String... args) throws Exception {

        // Sealed result from the frontend.

        String SEALED_RESULT = System.getenv("BASE64_SEALED_RESULT");

        // Base64 encoded key generated in the dashboard.

        String SEALED_KEY = System.getenv("BASE64_KEY");

        final EventResponse event = Sealed.unsealEventResponse(

                Base64.getDecoder().decode(SEALED_RESULT),

                // You can provide more than one key to support key rotation. The SDK will try to decrypt the result with each key.

                new Sealed.DecryptionKey[]{

                        new Sealed.DecryptionKey(

                                Base64.getDecoder().decode(SEALED_KEY),

                                Sealed.DecryptionAlgorithm.AES_256_GCM

                        )

                }

        );

        // Do something with unsealed response, e.g: send it back to the frontend.

    }

}

```

To learn more, refer to example located in [src/examples/java/com/fingerprint/example/SealedResults.java](src/examples/java/com/fingerprint/example/SealedResults.java).

## Webhook signature validation

This SDK provides utility method for verifying the HMAC signature of the incoming webhook request.

Here is an example implementation using Spring Boot: 

```java

import com.fingerprint.sdk.Webhook;

@RestController

class WebhookController {

    @PostMapping("/api/webhook")

    public ResponseEntity webhookHandler(@RequestBody byte[] webhook, @RequestHeader HttpHeaders headers) {

        final String secret = System.getenv("WEBHOOK_SIGNATURE_SECRET");

        if (secret == null || secret.isEmpty()) {

            return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body("Secret key is not configured");

        }

        final String signature = headers.getFirst("fpjs-event-signature");

        if (signature == null || signature.isEmpty()) {

            return ResponseEntity.status(HttpStatus.BAD_REQUEST).body("Missing fpjs-event-signature header");

        }

        final boolean isValidSignature = Webhook.isValidWebhookSignature(signature, webhook, secret);

        if (!isValidSignature) {

            return ResponseEntity.status(HttpStatus.BAD_REQUEST).body("Webhook signature is not valid");

        }

        return ResponseEntity.ok("Webhook received");

    }

}

```

## Documentation for API Endpoints

All URIs are relative to *https://api.fpjs.io*

Class | Method | HTTP request | Description

------------ | ------------- | ------------- | -------------

*FingerprintApi* | [**deleteVisitorData**](docs/FingerprintApi.md#deleteVisitorData) | **DELETE** /visitors/{visitor_id} | Delete data by visitor ID

*FingerprintApi* | [**getEvent**](docs/FingerprintApi.md#getEvent) | **GET** /events/{request_id} | Get event by request ID

*FingerprintApi* | [**getVisits**](docs/FingerprintApi.md#getVisits) | **GET** /visitors/{visitor_id} | Get visits by visitor ID

*FingerprintApi* | [**updateEvent**](docs/FingerprintApi.md#updateEvent) | **PUT** /events/{request_id} | Update an event with a given request ID

*FingerprintApi* | [**webhookTrace**](docs/FingerprintApi.md#webhookTrace) | **TRACE** /webhook | 

## Documentation for Models

 - [ASN](docs/ASN.md)

 - [BotdDetectionResult](docs/BotdDetectionResult.md)

 - [BotdResult](docs/BotdResult.md)

 - [BrowserDetails](docs/BrowserDetails.md)

 - [ClonedAppResult](docs/ClonedAppResult.md)

 - [Common403ErrorResponse](docs/Common403ErrorResponse.md)

 - [Confidence](docs/Confidence.md)

 - [DataCenter](docs/DataCenter.md)

 - [DeprecatedIPLocation](docs/DeprecatedIPLocation.md)

 - [DeprecatedIPLocationCity](docs/DeprecatedIPLocationCity.md)

 - [DeveloperToolsResult](docs/DeveloperToolsResult.md)

 - [EmulatorResult](docs/EmulatorResult.md)

 - [Error](docs/Error.md)

 - [ErrorCommon403Response](docs/ErrorCommon403Response.md)

 - [ErrorCommon429Response](docs/ErrorCommon429Response.md)

 - [ErrorCommon429ResponseError](docs/ErrorCommon429ResponseError.md)

 - [ErrorEvent404Response](docs/ErrorEvent404Response.md)

 - [ErrorEvent404ResponseError](docs/ErrorEvent404ResponseError.md)

 - [ErrorUpdateEvent400Response](docs/ErrorUpdateEvent400Response.md)

 - [ErrorUpdateEvent400ResponseError](docs/ErrorUpdateEvent400ResponseError.md)

 - [ErrorUpdateEvent409Response](docs/ErrorUpdateEvent409Response.md)

 - [ErrorUpdateEvent409ResponseError](docs/ErrorUpdateEvent409ResponseError.md)

 - [ErrorVisitor400Response](docs/ErrorVisitor400Response.md)

 - [ErrorVisitor400ResponseError](docs/ErrorVisitor400ResponseError.md)

 - [ErrorVisitor404Response](docs/ErrorVisitor404Response.md)

 - [ErrorVisitor404ResponseError](docs/ErrorVisitor404ResponseError.md)

 - [ErrorVisits403](docs/ErrorVisits403.md)

 - [EventResponse](docs/EventResponse.md)

 - [EventUpdateRequest](docs/EventUpdateRequest.md)

 - [FactoryResetResult](docs/FactoryResetResult.md)

 - [FridaResult](docs/FridaResult.md)

 - [HighActivityResult](docs/HighActivityResult.md)

 - [IPLocation](docs/IPLocation.md)

 - [IPLocationCity](docs/IPLocationCity.md)

 - [IdentificationError](docs/IdentificationError.md)

 - [IncognitoResult](docs/IncognitoResult.md)

 - [IpBlockListResult](docs/IpBlockListResult.md)

 - [IpBlockListResultDetails](docs/IpBlockListResultDetails.md)

 - [IpInfoResult](docs/IpInfoResult.md)

 - [IpInfoResultV4](docs/IpInfoResultV4.md)

 - [IpInfoResultV6](docs/IpInfoResultV6.md)

 - [JailbrokenResult](docs/JailbrokenResult.md)

 - [Location](docs/Location.md)

 - [LocationSpoofingResult](docs/LocationSpoofingResult.md)

 - [PrivacySettingsResult](docs/PrivacySettingsResult.md)

 - [ProductError](docs/ProductError.md)

 - [ProductsResponse](docs/ProductsResponse.md)

 - [ProductsResponseBotd](docs/ProductsResponseBotd.md)

 - [ProductsResponseIdentification](docs/ProductsResponseIdentification.md)

 - [ProductsResponseIdentificationData](docs/ProductsResponseIdentificationData.md)

 - [ProxyResult](docs/ProxyResult.md)

 - [RawDeviceAttributesResultValue](docs/RawDeviceAttributesResultValue.md)

 - [RemoteControlResult](docs/RemoteControlResult.md)

 - [Response](docs/Response.md)

 - [ResponseVisits](docs/ResponseVisits.md)

 - [RootAppsResult](docs/RootAppsResult.md)

 - [SeenAt](docs/SeenAt.md)

 - [SignalResponseClonedApp](docs/SignalResponseClonedApp.md)

 - [SignalResponseDeveloperTools](docs/SignalResponseDeveloperTools.md)

 - [SignalResponseEmulator](docs/SignalResponseEmulator.md)

 - [SignalResponseFactoryReset](docs/SignalResponseFactoryReset.md)

 - [SignalResponseFrida](docs/SignalResponseFrida.md)

 - [SignalResponseHighActivity](docs/SignalResponseHighActivity.md)

 - [SignalResponseIncognito](docs/SignalResponseIncognito.md)

 - [SignalResponseIpBlocklist](docs/SignalResponseIpBlocklist.md)

 - [SignalResponseIpInfo](docs/SignalResponseIpInfo.md)

 - [SignalResponseJailbroken](docs/SignalResponseJailbroken.md)

 - [SignalResponseLocationSpoofing](docs/SignalResponseLocationSpoofing.md)

 - [SignalResponsePrivacySettings](docs/SignalResponsePrivacySettings.md)

 - [SignalResponseProxy](docs/SignalResponseProxy.md)

 - [SignalResponseRawDeviceAttributes](docs/SignalResponseRawDeviceAttributes.md)

 - [SignalResponseRemoteControl](docs/SignalResponseRemoteControl.md)

 - [SignalResponseRootApps](docs/SignalResponseRootApps.md)

 - [SignalResponseSuspectScore](docs/SignalResponseSuspectScore.md)

 - [SignalResponseTampering](docs/SignalResponseTampering.md)

 - [SignalResponseTor](docs/SignalResponseTor.md)

 - [SignalResponseVelocity](docs/SignalResponseVelocity.md)

 - [SignalResponseVirtualMachine](docs/SignalResponseVirtualMachine.md)

 - [SignalResponseVpn](docs/SignalResponseVpn.md)

 - [Subdivision](docs/Subdivision.md)

 - [SuspectScoreResult](docs/SuspectScoreResult.md)

 - [TamperingResult](docs/TamperingResult.md)

 - [TooManyRequestsResponse](docs/TooManyRequestsResponse.md)

 - [TorResult](docs/TorResult.md)

 - [VelocityIntervalResult](docs/VelocityIntervalResult.md)

 - [VelocityIntervals](docs/VelocityIntervals.md)

 - [VelocityResult](docs/VelocityResult.md)

 - [VirtualMachineResult](docs/VirtualMachineResult.md)

 - [VpnResult](docs/VpnResult.md)

 - [VpnResultMethods](docs/VpnResultMethods.md)

 - [WebhookVisit](docs/WebhookVisit.md)

## Documentation for Authorization

Authentication schemes defined for the API:

### ApiKeyHeader

- **Type**: API key

- **API key parameter name**: Auth-API-Key

- **Location**: HTTP header

### ApiKeyQuery

- **Type**: API key

- **API key parameter name**: api_key

- **Location**: URL query string

## Documentation for sealed results

- [Sealed](docs/Sealed.md)

- [DecryptionKey](docs/DecryptionKey.md)

## Recommendation

It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues.

## Support

To report problems, ask questions or provide feedback, please use [Issues](https://github.com/fingerprintjs/fingerprint-pro-server-api-java-sdk/issues).

If you need private support, you can email us at [[email protected]](mailto:[email protected]).

## License

This project is licensed under the [MIT License](https://github.com/fingerprintjs/fingerprint-pro-server-api-java-sdk/blob/main/LICENSE).