FingerprintJsServerApiClient class
A client for interacting with the FingerprintJS Pro Server API.
Constructors
- FingerprintJsServerApiClient({required String apiKey, Region region = Region.defaultRegion, String? baseUrl, Duration timeout = const Duration(seconds: 10), Client? client})
- Creates an instance of the API client.
Properties
- apiKey → String
-
The API key for authentication.
final
- baseUrl → String
-
The base URL of the API (determined by region if not provided).
final
- client → Client
-
HTTP client (allows dependency injection for testing).
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- region → Region
-
The geographic region for routing requests.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- timeout → Duration
-
The request timeout duration.
final
Methods
-
getEvents(
ExtractQueryParams queryParams) → Future< Map< String, dynamic> > - Fetch events using query parameters
-
getIntegrationInfo(
) → Future< IntegrationInfo> - Retrieves integration metadata from the FingerprintJS Pro API.
-
getRelatedVisitors(
RelatedVisitorsFilter filter) → Future< Map< String, dynamic> > -
Fetches related visitors data based on the provided
filter. -
getRequestPath(
String basePath, [Map< String, dynamic> ? queryParams]) → String - Constructs a properly encoded request path with optional query parameters.
-
getVisitorData(
String visitorId) → Future< Map< String, dynamic> > - Retrieves visitor data from the API.
-
getVisitorHistory(
VisitorHistoryFilter filter) → Future< Map< String, dynamic> > - Fetches visitor history using the provided VisitorHistoryFilter.
-
getVisitors(
{int limit = 10, int offset = 0}) → Future< VisitorsResponse> - Retrieves all visitors (paginated) from the API.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
searchEvents(
SearchEventsFilter filter) → Future< Map< String, dynamic> > - Search events with a SearchEventsFilter.
-
toString(
) → String -
A string representation of this object.
inherited
-
updateEvent(
EventsUpdateRequest request) → Future< Map< String, dynamic> > - Update events using event ID and updates
-
verifyFingerprint(
Map< String, dynamic> fingerprintData) → Future<Map< String, dynamic> > - Verifies a fingerprint against the API.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited