You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+22-3Lines changed: 22 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,7 +18,7 @@
18
18
19
19
# Fingerprint Server API Java SDK
20
20
21
-
[Fingerprint](https://fingerprint.com/) is a device intelligence platform offering industry-leading accuracy. 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 search, update, and delete identification events.
21
+
[Fingerprint](https://fingerprint.com/) is a device intelligence platform offering industry-leading accuracy. The Fingerprint Server Java SDK is an easy way to interact with the Fingerprint [Server API](https://docs.fingerprint.com/reference/server-api) from your Java application. You can search, update, and delete identification events.
22
22
23
23
24
24
*Automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)*
@@ -37,6 +37,11 @@ The following versions of Java are supported
37
37
- Java 21
38
38
- Java 25
39
39
40
+
We aim to support all Java LTS versions that are still maintained upstream.
41
+
42
+
> [!NOTE]
43
+
> This package assumes you have a Fingerprint subscription or trial, it is not compatible with the [open-source FingerprintJS](https://github.com/fingerprintjs/fingerprintjs). See our documentation to learn more about the [differences between Fingerprint and the open-source FingerprintJS](https://fingerprint.com/github/).
44
+
40
45
## Installation
41
46
42
47
### Maven users
@@ -202,7 +207,7 @@ public class FingerprintApiExample {
202
207
203
208
## Sealed results
204
209
205
-
This SDK provides utility methods for decoding [sealed results](https://dev.fingerprint.com/docs/sealed-client-results).
210
+
This SDK provides utility methods for decoding [sealed results](https://docs.fingerprint.com/docs/sealed-client-results).
206
211
```java
207
212
packagecom.fingerprint.example;
208
213
@@ -236,7 +241,21 @@ public class SealedResults {
236
241
```
237
242
To learn more, see the [Sealed results example](/examples/src/main/java/com/fingerprint/example/SealedResults.java).
238
243
239
-
## Webhook signature validation
244
+
## Webhooks
245
+
246
+
### Webhook types
247
+
248
+
A [webhook](https://dev.fingerprint.com/reference/posteventwebhook) sent by Fingerprint has the same shape as an `Event`. You can deserialize the payload directly into that type using the SDK's own JSON mapper:
Copy file name to clipboardExpand all lines: contributing.md
+18Lines changed: 18 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,6 +8,16 @@ Most files in the project are autogenerated by [openapi-generator](https://opena
8
8
-[docs](./docs) - generated documentation for models and [API Client](./docs/FingerprintApi.md).
9
9
-[sdk](./sdk) - automatically generated API client code.
10
10
11
+
## Commit messages
12
+
13
+
This project follows the [Conventional Commits](https://www.conventionalcommits.org/) standard. Each commit message should be structured as:
14
+
15
+
```
16
+
<type>: <description>
17
+
18
+
[optional body]
19
+
```
20
+
11
21
## Code generation and building the SDK
12
22
13
23
Use the Gradle build to invoke `openapi-generator` and generate the code and documentation:
@@ -18,6 +28,14 @@ Use the Gradle build to invoke `openapi-generator` and generate the code and doc
18
28
19
29
To download the latest OpenAPI schema from [fingerprintjs/fingerprint-pro-server-api-openapi](https://github.com/fingerprintjs/fingerprint-pro-server-api-openapi), run `./scripts/sync.sh`
20
30
31
+
### Updating the codegen engine and templates
32
+
33
+
The generator version is pinned as the `openapi` entry in [gradle/libs.versions.toml](./gradle/libs.versions.toml). To update it:
34
+
35
+
1. Bump the `openapi` version in that file.
36
+
2. Compare each file in [template](./template) against the matching upstream `java` or `jersey3` generator template at the new version, and merge in any upstream changes the same way you would resolve a merge conflict.
37
+
3. Update the engine and the templates in the same change. Using the new engine with old templates, or the other way around, can break code generation without a clear error.
38
+
21
39
## Testing the local source code of the SDK
22
40
23
41
Use the [./src/examples/java/com/fingerprint/example/FunctionalTests.java](./src/examples/java/com/fingerprint/example/FunctionalTests.java) file to make API requests using the local version of the SDK.
0 commit comments