fingerprint-pro-server-api-sdk 2.5.0.dev2

Fingerprint Pro Server API allows you to get information about visitors and about individual events in a server environment. It can be used for data exports, decision-making, and data analysis scenarios. Server API is intended for server-side usage, it's not intended to be used from the client side, whether it's a browser or a mobile device.

Fingerprint Pro Server Python SDK

Fingerprint Pro Server API allows you to get information about visitors and about individual events in a server environment. It can be used for data exports, decision-making, and data analysis scenarios. Server API is intended for server-side usage, it's not intended to be used from the client side, whether it's a browser or a mobile device.

This Python package is automatically generated by the Swagger Codegen project:

• API version: 3
• Package version: 2.5.0dev2
• Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen

Requirements.

Python 2.7 and 3.4+

Installation & Usage

pip install

You can install the package directly from the Github

pip install git+https://github.com/fingerprintjs/fingerprint-pro-server-api-python-sdk.git

Or from the PyPI

pip install fingerprint_pro_server_api_sdk

Then import the package:

import fingerprint_pro_server_api_sdk

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import fingerprint_pro_server_api_sdk

Getting Started

Please follow the installation procedure and then run the following:

import fingerprint_pro_server_api_sdk

# Configure API key authorization and region
configuration = fingerprint_pro_server_api_sdk.Configuration(api_key="SECRET_API_KEY")
# configuration = fingerprint_pro_server_api_sdk.Configuration(api_key="SECRET_API_KEY", region="eu")

# create an instance of the API class
api_instance = fingerprint_pro_server_api_sdk.FingerprintApi(configuration)

Examples

Fetching visits using visitorId:

import fingerprint_pro_server_api_sdk
from fingerprint_pro_server_api_sdk import Response
from fingerprint_pro_server_api_sdk.rest import ApiException, KnownApiException

configuration = fingerprint_pro_server_api_sdk.Configuration(api_key="SECRET_API_KEY")
api_instance = fingerprint_pro_server_api_sdk.FingerprintApi(configuration)

visitor_id = 'visitor_id_example'  # str |
#request_id = 'request_id_example'  # str | Filter events by requestId (optional)
#linked_id = 'linked_id_example'  # str | Filter events by custom identifier (optional)
limit = 10  # int | Limit scanned results (optional)
#before = 56  # int | Used to paginate results (optional)

try:
    api_response: Response = api_instance.get_visits(visitor_id, limit=2)
    print(api_response)
except KnownApiException as e:
    structured_error = e.structured_error
    print("Error: %s\n" % structured_error.error)
except ApiException as e:
    print("Exception when calling DefaultApi->visitors_visitor_id_get: %s\n" % e)

Fetching events for requestId:

import fingerprint_pro_server_api_sdk
from fingerprint_pro_server_api_sdk import EventResponse
from fingerprint_pro_server_api_sdk.rest import ApiException, KnownApiException

configuration = fingerprint_pro_server_api_sdk.Configuration(api_key="SECRET_API_KEY")
api_instance = fingerprint_pro_server_api_sdk.FingerprintApi(configuration)

request_id = 'request_id_example'  # str

try:
    events_response: EventResponse = api_instance.get_event(request_id)

except KnownApiException as e:
    structured_error = e.structured_error
    print("Error code: %s. Error message: %s\n" % (structured_error.error.code, structured_error.error.message))
except ApiException as e:
    print("Exception when calling DefaultApi->get_event: %s\n" % e)

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
FingerprintApi	get_event	GET /events/{request_id}	Get event by requestId
FingerprintApi	get_visits	GET /visitors/{visitor_id}	Get visits by visitorId

Documentation For Models

• BotdDetectionResult
• BotdResult
• BrowserDetails
• Confidence
• ErrorEvent403Response
• ErrorEvent403ResponseError
• ErrorEvent404Response
• ErrorEvent404ResponseError
• ErrorVisits403
• EventResponse
• IPLocation
• IPLocationCity
• IdentificationError
• IpBlockListResult
• IpBlockListResultDetails
• IpInfoResult
• IpInfoResultV4
• IpInfoResultV6
• Location
• ManyRequestsResponse
• ProductError
• ProductsResponse
• ProductsResponseBotd
• ProductsResponseIdentification
• ProductsResponseIdentificationData
• RawDeviceAttributesResult
• Response
• ResponseVisits
• SeenAt
• SignalResponseClonedApp
• SignalResponseClonedAppData
• SignalResponseEmulator
• SignalResponseEmulatorData
• SignalResponseFactoryReset
• SignalResponseFactoryResetData
• SignalResponseFrida
• SignalResponseFridaData
• SignalResponseIncognito
• SignalResponseIncognitoData
• SignalResponseIpBlocklist
• SignalResponseIpInfo
• SignalResponseJailbroken
• SignalResponseJailbrokenData
• SignalResponsePrivacySettings
• SignalResponsePrivacySettingsData
• SignalResponseProxy
• SignalResponseProxyData
• SignalResponseRawDeviceAttributes
• SignalResponseRootApps
• SignalResponseRootAppsData
• SignalResponseTampering
• SignalResponseTor
• SignalResponseTorData
• SignalResponseVirtualMachine
• SignalResponseVirtualMachineData
• SignalResponseVpn
• Subdivision
• TamperingResult
• Visit
• VpnResult
• VpnResultMethods
• WebhookSignalResponseClonedApp
• WebhookSignalResponseEmulator
• WebhookSignalResponseFactoryReset
• WebhookSignalResponseFrida
• WebhookSignalResponseJailbroken
• WebhookSignalResponsePrivacySettings
• WebhookSignalResponseProxy
• WebhookSignalResponseRootApps
• WebhookSignalResponseTor
• WebhookSignalResponseVirtualMachine
• WebhookVisit

Documentation For Authorization

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

Author

[e-mail]