Releases: fingerprintjs/fingerprint-pro-server-api-java-sdk
Releases · fingerprintjs/fingerprint-pro-server-api-java-sdk
v7.1.0
v7.0.0
Major Changes
The underlying Server API hasn’t changed, but we made SDK type and class generation more precise, resulting in small breaking changes for the SDK itself. This change should make the SDK API a lot more stable going forward
- Rename
Webhook
class toWebhookValidation
.
Right now,Webhook
class points to the actual data model. (817b444) -
- Remove the
BrowserDetails
fieldbotProbability
. - Update the
IdentificationConfidence
fieldscore
type format:float
->double
. - Make the
RawDeviceAttributeError
fieldname
optional . - Make the
RawDeviceAttributeError
fieldmessage
optional . - events: Remove the
EventsResponse
fielderror
.- [note]: The errors are represented by
ErrorResponse
model.
- [note]: The errors are represented by
- events: Update the
HighActivity
fielddailyRequests
type format:number
->int64
. - events: Specify the
Tampering
fieldanomalyScore
type format:double
. - webhook: Make the
Webhook
fields optional:visitorId
,visitorFound
,firstSeenAt
,lastSeenAt
,browserDetails
,incognito
. - webhook: Make the
WebhookClonedApp
fieldresult
optional. - webhook: Make the
WebhookDeveloperTools
fieldresult
optional. - webhook: Make the
WebhookEmulator
fieldresult
optional. - webhook: Make the
WebhookFactoryReset
fieldstime
andtimestamp
optional. - webhook: Make the
WebhookFrida
fieldresult
optional. - webhook: Update the
WebhookHighActivity
fielddailyRequests
type format:number
->int64
. - webhook: Make the
WebhookIPBlocklist
fieldsresult
anddetails
optional. - webhook: Make the
WebhookJailbroken
fieldresult
optional. - webhook: Make the
WebhookLocationSpoofing
fieldresult
optional. - webhook: Make the
WebhookPrivacySettings
fieldresult
optional. - webhook: Make the
WebhookProxy
fieldresult
optional. - webhook: Make the
WebhookRemoteControl
fieldresult
optional. - webhook: Make the
WebhookRootApps
fieldresult
optional. - webhook: Make the
WebhookSuspectScore
fieldresult
optional. - webhook: Make the
WebhookTampering
fieldsresult
,anomalyScore
andantiDetectBrowser
optional. - webhook: Specify the
WebhookTampering
fieldanomalyScore
type format:double
. - webhook: Make the
WebhookTor
fieldresult
optional. - webhook: Make the
WebhookVelocity
fields optional:distinctIp
,distinctLinkedId
,distinctCountry
,events
,ipEvents
,distinctIpByLinkedId
,distinctVisitorIdByLinkedId
. - webhook: Make the
WebhookVirtualMachine
fieldresult
optional. - webhook: Make the
WebhookVPN
fields optional:result
,confidence
,originTimezone
,methods
. (a09ca88)
- Remove the
-
- Rename
BotdResult
->Botd
. - Rename
BotdDetectionResult
->BotdBot
:- Extract
result
type asBotdBotResult
.
- Extract
- Rename
ClonedAppResult
->ClonedApp
. - Rename
DeveloperToolsResult
->DeveloperTools
. - Rename
EmulatorResult
->Emulator
. - Refactor error models:
- Remove
ErrorCommon403Response
,ErrorCommon429Response
,ErrorEvent404Response
,TooManyRequestsResponse
,ErrorVisits403
,ErrorUpdateEvent400Response
,ErrorUpdateEvent409Response
,ErrorVisitor400Response
,ErrorVisitor404Response
,IdentificationError
,ProductError
. - Introduce
ErrorResponse
andErrorPlainResponse
.- [note]:
ErrorPlainResponse
has a different format{ "error": string }
and it is used only inGET /visitors
.
- [note]:
- Extract
error
type asError
. - Extract
error.code
type asErrorCode
.
- Remove
- Rename
EventResponse
->EventsGetResponse
. - Rename
EventUpdateRequest
->EventsUpdateRequest
. - Rename
FactoryResetResult
->FactoryReset
. - Rename
FridaResult
->Frida
. - Rename
IPLocation
->Geolocation
:- Rename
IPLocationCity
->GeolocationCity
. - Extract
subdivisions
type asGeolocationSubdivisions
. - Rename
Location
->GeolocationContinent
: - Introduce a dedicated type
GeolocationCountry
. - Rename
Subdivision
->GeolocationSubdivision
.
- Rename
- Rename
HighActivityResult
->HighActivity
. - Rename
Confidence
->IdentificationConfidence
. - Rename
SeenAt
->IdentificationSeenAt
. - Rename
IncognitoResult
->Incognito
. - Rename
IpBlockListResult
->IPBlocklist
:- Extract
details
type asIPBlocklistDetails
.
- Extract
- Rename
IpInfoResult
->IPInfo
:- Rename
IpInfoResultV4
->IPInfoV4
. - Rename
IpInfoResultV6
->IPInfoV6
. - Rename
ASN
->IPInfoASN
. - Rename
DataCenter
->IPInfoDataCenter
.
- Rename
- Rename
JailbrokenResult
->Jailbroken
. - Rename
LocationSpoofingResult
->LocationSpoofing
. - Rename
PrivacySettingsResult
->PrivacySettings
. - Rename
ProductsResponse
->Products
:- Rename inner types:
ProductsResponseIdentification
->ProductIdentification
,ProductsResponseIdentificationData
->Identification
,ProductsResponseBotd
->ProductBotd
,SignalResponseRootApps
->ProductRootApps
,SignalResponseEmulator
->ProductEmulator
,SignalResponseIpInfo
->ProductIPInfo
,SignalResponseIpBlocklist
->ProductIPBlocklist
,SignalResponseTor
->ProductTor
,SignalResponseVpn
->ProductVPN
,SignalResponseProxy
->ProductProxy
,ProxyResult
->Proxy
,SignalResponseIncognito
->ProductIncognito
,SignalResponseTampering
->ProductTampering
,SignalResponseClonedApp
->ProductClonedApp
,SignalResponseFactoryReset
->ProductFactoryReset
,SignalResponseJailbroken
->ProductJailbroken
,SignalResponseFrida
->ProductFrida
,SignalResponsePrivacySettings
->ProductPrivacySettings
,SignalResponseVirtualMachine
->ProductVirtualMachine
,SignalResponseRawDeviceAttributes
->ProductRawDeviceAttributes
,RawDeviceAttributesResultValue
->RawDeviceAttributes
,SignalResponseHighActivity
->ProductHighActivity
,SignalResponseLocationSpoofing
->ProductLocationSpoofing
,SignalResponseSuspectScore
->ProductSuspectScore
,SignalResponseRemoteControl
->ProductRemoteControl
,SignalResponseVelocity
->ProductVelocity
,SignalResponseDeveloperTools
->ProductDeveloperTools
. - Extract
identification.data
type asIdentification
.
- Rename inner types:
- Rename
RawDeviceAttributesResult
->RawDeviceAttributes
:- Extract item type as
RawDeviceAttribute
. - Extract
error
type asRawDeviceAttributeError
.
- Extract item type as
- Rename
RemoteControlResult
->RemoteControl
. - Rename
RootAppsResult
->RootApps
. - Rename
SuspectScoreResult
->SuspectScore
. - Extract new model
Tag
. - Rename
TamperingResult
->Tampering
. - Rename
TorResult
->Tor
. - Rename
VelocityResult
->Velocity
:- Rename
VelocityIntervals
->VelocityData
. - Rename
VelocityIntervalResult
->VelocityIntervals
.
- Rename
- Rename
VirtualMachineResult
->VirtualMachine
. - Rename the
Visit
fieldipLocation
typeDeprecatedIPLocation
->DeprecatedGeolocation
.- Instead of
DeprecatedIPLocationCity
use commonGeolocationCity
- Instead of
- Rename
Response
->VisitorsGetResponse
.- Omit extra inner type
ResponseVisits
- Omit extra inner type
- Rename
VpnResult
->VPN
.- Extract
confidence
type asVPNConfidence
. - Extract
methods
type asVPNMethods
.
- Extract
- Rename
WebhookVisit
->Webhook
.- Introduce new inner types:
WebhookRootApps
,WebhookEmulator
,WebhookIPInfo
,WebhookIPBlocklist
,WebhookTor
,WebhookVPN
,WebhookProxy
,WebhookTampering
,WebhookClonedApp
,WebhookFactoryReset
,WebhookJailbroken
,WebhookFrida
,WebhookPrivacySettings
,WebhookVirtualMachine
,WebhookRawDeviceAttributes
,WebhookHighActivity
,WebhookLocationSpoofing
,WebhookSuspectScore
,WebhookRemoteControl
,WebhookVelocity
,WebhookDeveloperTools
. (a09ca88)
- Introduce new inner types:
- Rename
- Rename
IsValidWebhookSignature
toisSignatureValid
inWebhookValidation
(f49c1c2)
Minor Changes
- Added new
ipEvents
,distinctIpByLinkedId
, anddistinctVisitorIdByLinkedId
fields to thevelocity
Smart Signal. (a09ca88) -
- Make the
GeolocationCity
fieldname
required. - Make the
GeolocationSubdivision
fieldisoCode
required. - Make the
GeolocationSubdivision
fieldname
required. - Make the
IPInfoASN
fieldname
required . - Make the
IPInfoDataCenter
fieldname
required. - Add optional
IdentificationConfidence
fieldcomment
. - events: Add optional
Botd
fieldmeta
. - events: Add optional
Identification
fieldcomponents
. - events: Make the
VPN
fieldoriginCountry
required. - **vis...
- Make the
v7.0.0-develop.0
Major Changes
-
- Remove the
BrowserDetails
fieldbotProbability
. - Update the
IdentificationConfidence
fieldscore
type format:float
->double
. - Make the
RawDeviceAttributeError
fieldname
optional . - Make the
RawDeviceAttributeError
fieldmessage
optional . - events: Remove the
EventsResponse
fielderror
.- [note]: The errors are represented by
ErrorResponse
model.
- [note]: The errors are represented by
- events: Update the
HighActivity
fielddailyRequests
type format:number
->int64
. - events: Specify the
Tampering
fieldanomalyScore
type format:double
. - webhook: Make the
Webhook
fields optional:visitorId
,visitorFound
,firstSeenAt
,lastSeenAt
,browserDetails
,incognito
. - webhook: Make the
WebhookClonedApp
fieldresult
optional. - webhook: Make the
WebhookDeveloperTools
fieldresult
optional. - webhook: Make the
WebhookEmulator
fieldresult
optional. - webhook: Make the
WebhookFactoryReset
fieldstime
andtimestamp
optional. - webhook: Make the
WebhookFrida
fieldresult
optional. - webhook: Update the
WebhookHighActivity
fielddailyRequests
type format:number
->int64
. - webhook: Make the
WebhookIPBlocklist
fieldsresult
anddetails
optional. - webhook: Make the
WebhookJailbroken
fieldresult
optional. - webhook: Make the
WebhookLocationSpoofing
fieldresult
optional. - webhook: Make the
WebhookPrivacySettings
fieldresult
optional. - webhook: Make the
WebhookProxy
fieldresult
optional. - webhook: Make the
WebhookRemoteControl
fieldresult
optional. - webhook: Make the
WebhookRootApps
fieldresult
optional. - webhook: Make the
WebhookSuspectScore
fieldresult
optional. - webhook: Make the
WebhookTampering
fieldsresult
,anomalyScore
andantiDetectBrowser
optional. - webhook: Specify the
WebhookTampering
fieldanomalyScore
type format:double
. - webhook: Make the
WebhookTor
fieldresult
optional. - webhook: Make the
WebhookVelocity
fields optional:distinctIp
,distinctLinkedId
,distinctCountry
,events
,ipEvents
,distinctIpByLinkedId
,distinctVisitorIdByLinkedId
. - webhook: Make the
WebhookVirtualMachine
fieldresult
optional. - webhook: Make the
WebhookVPN
fields optional:result
,confidence
,originTimezone
,methods
. (a09ca88)
- Remove the
-
- Rename
BotdResult
->Botd
. - Rename
BotdDetectionResult
->BotdBot
:- Extract
result
type asBotdBotResult
.
- Extract
- Rename
ClonedAppResult
->ClonedApp
. - Rename
DeveloperToolsResult
->DeveloperTools
. - Rename
EmulatorResult
->Emulator
. - Refactor error models:
- Remove
ErrorCommon403Response
,ErrorCommon429Response
,ErrorEvent404Response
,TooManyRequestsResponse
,ErrorVisits403
,ErrorUpdateEvent400Response
,ErrorUpdateEvent409Response
,ErrorVisitor400Response
,ErrorVisitor404Response
,IdentificationError
,ProductError
. - Introduce
ErrorResponse
andErrorPlainResponse
.- [note]:
ErrorPlainResponse
has a different format{ "error": string }
and it is used only inGET /visitors
.
- [note]:
- Extract
error
type asError
. - Extract
error.code
type asErrorCode
.
- Remove
- Rename
EventResponse
->EventsGetResponse
. - Rename
EventUpdateRequest
->EventsUpdateRequest
. - Rename
FactoryResetResult
->FactoryReset
. - Rename
FridaResult
->Frida
. - Rename
IPLocation
->Geolocation
:- Rename
IPLocationCity
->GeolocationCity
. - Extract
subdivisions
type asGeolocationSubdivisions
. - Rename
Location
->GeolocationContinent
: - Introduce a dedicated type
GeolocationCountry
. - Rename
Subdivision
->GeolocationSubdivision
.
- Rename
- Rename
HighActivityResult
->HighActivity
. - Rename
Confidence
->IdentificationConfidence
. - Rename
SeenAt
->IdentificationSeenAt
. - Rename
IncognitoResult
->Incognito
. - Rename
IpBlockListResult
->IPBlocklist
:- Extract
details
type asIPBlocklistDetails
.
- Extract
- Rename
IpInfoResult
->IPInfo
:- Rename
IpInfoResultV4
->IPInfoV4
. - Rename
IpInfoResultV6
->IPInfoV6
. - Rename
ASN
->IPInfoASN
. - Rename
DataCenter
->IPInfoDataCenter
.
- Rename
- Rename
JailbrokenResult
->Jailbroken
. - Rename
LocationSpoofingResult
->LocationSpoofing
. - Rename
PrivacySettingsResult
->PrivacySettings
. - Rename
ProductsResponse
->Products
:- Rename inner types:
ProductsResponseIdentification
->ProductIdentification
,ProductsResponseIdentificationData
->Identification
,ProductsResponseBotd
->ProductBotd
,SignalResponseRootApps
->ProductRootApps
,SignalResponseEmulator
->ProductEmulator
,SignalResponseIpInfo
->ProductIPInfo
,SignalResponseIpBlocklist
->ProductIPBlocklist
,SignalResponseTor
->ProductTor
,SignalResponseVpn
->ProductVPN
,SignalResponseProxy
->ProductProxy
,ProxyResult
->Proxy
,SignalResponseIncognito
->ProductIncognito
,SignalResponseTampering
->ProductTampering
,SignalResponseClonedApp
->ProductClonedApp
,SignalResponseFactoryReset
->ProductFactoryReset
,SignalResponseJailbroken
->ProductJailbroken
,SignalResponseFrida
->ProductFrida
,SignalResponsePrivacySettings
->ProductPrivacySettings
,SignalResponseVirtualMachine
->ProductVirtualMachine
,SignalResponseRawDeviceAttributes
->ProductRawDeviceAttributes
,RawDeviceAttributesResultValue
->RawDeviceAttributes
,SignalResponseHighActivity
->ProductHighActivity
,SignalResponseLocationSpoofing
->ProductLocationSpoofing
,SignalResponseSuspectScore
->ProductSuspectScore
,SignalResponseRemoteControl
->ProductRemoteControl
,SignalResponseVelocity
->ProductVelocity
,SignalResponseDeveloperTools
->ProductDeveloperTools
. - Extract
identification.data
type asIdentification
.
- Rename inner types:
- Rename
RawDeviceAttributesResult
->RawDeviceAttributes
:- Extract item type as
RawDeviceAttribute
. - Extract
error
type asRawDeviceAttributeError
.
- Extract item type as
- Rename
RemoteControlResult
->RemoteControl
. - Rename
RootAppsResult
->RootApps
. - Rename
SuspectScoreResult
->SuspectScore
. - Extract new model
Tag
. - Rename
TamperingResult
->Tampering
. - Rename
TorResult
->Tor
. - Rename
VelocityResult
->Velocity
:- Rename
VelocityIntervals
->VelocityData
. - Rename
VelocityIntervalResult
->VelocityIntervals
.
- Rename
- Rename
VirtualMachineResult
->VirtualMachine
. - Rename the
Visit
fieldipLocation
typeDeprecatedIPLocation
->DeprecatedGeolocation
.- Instead of
DeprecatedIPLocationCity
use commonGeolocationCity
- Instead of
- Rename
Response
->VisitorsGetResponse
.- Omit extra inner type
ResponseVisits
- Omit extra inner type
- Rename
VpnResult
->VPN
.- Extract
confidence
type asVPNConfidence
. - Extract
methods
type asVPNMethods
.
- Extract
- Rename
WebhookVisit
->Webhook
.- Introduce new inner types:
WebhookRootApps
,WebhookEmulator
,WebhookIPInfo
,WebhookIPBlocklist
,WebhookTor
,WebhookVPN
,WebhookProxy
,WebhookTampering
,WebhookClonedApp
,WebhookFactoryReset
,WebhookJailbroken
,WebhookFrida
,WebhookPrivacySettings
,WebhookVirtualMachine
,WebhookRawDeviceAttributes
,WebhookHighActivity
,WebhookLocationSpoofing
,WebhookSuspectScore
,WebhookRemoteControl
,WebhookVelocity
,WebhookDeveloperTools
. (a09ca88)
- Introduce new inner types:
- Rename
Minor Changes
- Added new
ipEvents
,distinctIpByLinkedId
, anddistinctVisitorIdByLinkedId
fields to thevelocity
Smart Signal. (a09ca88) -
- Make the
GeolocationCity
fieldname
required. - Make the
GeolocationSubdivision
fieldisoCode
required. - Make the
GeolocationSubdivision
fieldname
required. - Make the
IPInfoASN
fieldname
required . - Make the
IPInfoDataCenter
fieldname
required. - Add optional
IdentificationConfidence
fieldcomment
. - events: Add optional
Botd
fieldmeta
. - events: Add optional
Identification
fieldcomponents
. - events: Make the
VPN
fieldoriginCountry
required. - visitors: Add optional
Visit
fieldcomponents
. - webhook: Add optional
Webhook
fieldcomponents
. (a09ca88)
- Make the
- Remove
ipv4
format fromip
field inBotd
,Identification
,Visit
andWebhook
models. (d608cfe) - events: Add
antiDetectBrowser
detection method to thetampering
Smart Signal. (a09ca88)
Patch Changes
-
- Fix descriptions formatting:
- Remove extra line breaks.
...
- Remove extra line breaks.
- Fix descriptions formatting:
v6.2.0
v6.2.0-develop.0
Minor Changes
- visitors: Add the confidence field to the VPN Detection Smart Signal (aec1770)
v6.1.0
v6.1.0-develop.1
6.1.0-develop.1 (2024-09-10)
Features
- don't use
jackson-databind-nullable
to fix serialization problems withJackson
default configuration (979b800)