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.
Project description
Fingerprint Pro Server Python SDK
Fingerprint is a device intelligence platform offering 99.5% accurate visitor identification. The Fingerprint Server Python SDK is an easy way to interact with the Fingerprint Server API from your Python application. You can retrieve visitor history or individual identification events.
This Python package is automatically generated by the Swagger Codegen project:
- API version: 3
- Package version: 6.0.0
- Build package: io.swagger.codegen.v3.generators.python.PythonClientCodegen
Requirements
The following Python versions are supported:
- Python >= 3.8
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)
Sealed results
This SDK provides utility methods for decoding sealed results.
import base64
import os
from dotenv import load_dotenv
from fingerprint_pro_server_api_sdk import EventResponse
from fingerprint_pro_server_api_sdk.sealed import unseal_events_response, DecryptionKey, DecryptionAlgorithm
load_dotenv()
sealed_result = base64.b64decode(os.environ["BASE64_SEALED_RESULT"])
key = base64.b64decode(os.environ["BASE64_KEY"])
try:
events_response: EventResponse = unseal_events_response(sealed_result, [DecryptionKey(key, DecryptionAlgorithm['Aes256Gcm'])])
print("\n\n\nEvent response: \n", events_response.products)
except Exception as e:
print("Exception when calling unsealing events response: %s\n" % e)
exit(1)
print("Unseal successful!")
exit(0)
To learn more, refer to example located in sealed_results_example.py.
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
- ASN
- BotdDetectionResult
- BotdResult
- BrowserDetails
- ClonedAppResult
- Confidence
- DataCenter
- DeprecatedIPLocation
- DeprecatedIPLocationCity
- EmulatorResult
- ErrorEvent403Response
- ErrorEvent403ResponseError
- ErrorEvent404Response
- ErrorEvent404ResponseError
- ErrorVisits403
- EventResponse
- FactoryResetResult
- FridaResult
- HighActivityResult
- IPLocation
- IPLocationCity
- IdentificationError
- IncognitoResult
- IpBlockListResult
- IpBlockListResultDetails
- IpInfoResult
- IpInfoResultV4
- IpInfoResultV6
- JailbrokenResult
- Location
- LocationSpoofingResult
- ManyRequestsResponse
- PrivacySettingsResult
- ProductError
- ProductsResponse
- ProductsResponseBotd
- ProductsResponseIdentification
- ProductsResponseIdentificationData
- ProxyResult
- RawDeviceAttributesResult
- Response
- ResponseVisits
- RootAppsResult
- SeenAt
- SignalResponseClonedApp
- SignalResponseEmulator
- SignalResponseFactoryReset
- SignalResponseFrida
- SignalResponseHighActivity
- SignalResponseIncognito
- SignalResponseIpBlocklist
- SignalResponseIpInfo
- SignalResponseJailbroken
- SignalResponseLocationSpoofing
- SignalResponsePrivacySettings
- SignalResponseProxy
- SignalResponseRawDeviceAttributes
- SignalResponseRootApps
- SignalResponseSuspectScore
- SignalResponseTampering
- SignalResponseTor
- SignalResponseVirtualMachine
- SignalResponseVpn
- Subdivision
- SuspectScoreResult
- TamperingResult
- TorResult
- VirtualMachineResult
- Visit
- VpnResult
- VpnResultMethods
- 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
Documentation for sealed results
Support
To report problems, ask questions or provide feedback, please use Issues. If you need private support, you can email us at oss-support@fingerprint.com.
License
This project is licensed under the MIT License.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for fingerprint-pro-server-api-sdk-6.0.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0055eafbccfdf27eca721d663565e2d3a0211fabead67a552d9609b6d98e1e10 |
|
MD5 | c2d53d4342987ecca494103248754e20 |
|
BLAKE2b-256 | 63be1e828727928656e89e578b94e7a61fd4d5095c2d8af966c59087d9ba9868 |
Hashes for fingerprint_pro_server_api_sdk-6.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f024f37796408c76e3813f9c207b6030869c756d6a13185ea379fa806134c462 |
|
MD5 | aa2766c1be7a0a11c22f7d0efd4ea7f8 |
|
BLAKE2b-256 | ae87bd1da60406ac25d912448883352bc0c6f45c50231519c8038054e4d942e8 |