Skip to content

Improve error handling examples #176

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
erayaydin merged 1 commit into from
Mar 17, 2026
+135 −31
Merged

Improve error handling examples #176

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 40 additions & 8 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ Delete visitor data using `visitorId`:
import os

import fingerprint_server_sdk
from fingerprint_server_sdk import ApiException
from fingerprint_server_sdk import ApiException, ErrorResponse
from fingerprint_server_sdk.configuration import Region

# Configure API key authorization and region
Expand All @@ -111,7 +111,15 @@ visitor_id = 'visitor_id_example'
try:
api_instance.delete_visitor_data(visitor_id)
except ApiException as e:
print(f'Exception when calling FingerprintApi->delete_visitor_data: {e}\n')
if e.body is not None:
error_response = ErrorResponse.from_json(e.body)
if error_response is not None:
message = f"API request failed: {error_response.error.code} {error_response.error.message}"
else:
message = f"API request failed with unexpected error format: {e}"
else:
message = f'Exception when calling FingerprintApi->delete_visitor_data: {e}'
print(message)
```

To learn more, refer to example located in [examples/delete_visitor_example.py](examples/delete_visitor_example.py).
Expand All @@ -121,7 +129,7 @@ Fetching event details for `eventId`:
import os

import fingerprint_server_sdk
from fingerprint_server_sdk import ApiException
from fingerprint_server_sdk import ApiException, ErrorResponse
from fingerprint_server_sdk.configuration import Region

# Configure API key authorization and region
Expand All @@ -136,7 +144,15 @@ event_id = 'event_id_example'
try:
events_response = api_instance.get_event(event_id)
except ApiException as e:
print(f'Exception when calling FingerprintApi->get_event: {e}\n')
if e.body is not None:
error_response = ErrorResponse.from_json(e.body)
if error_response is not None:
message = f"API request failed: {error_response.error.code} {error_response.error.message}"
else:
message = f"API request failed with unexpected error format: {e}"
else:
message = f'Exception when calling FingerprintApi->get_event: {e}'
print(message)
```

To learn more, refer to example located in [examples/get_event_example.py](examples/get_event_example.py).
Expand All @@ -146,7 +162,7 @@ Search events with custom filters:
import os

import fingerprint_server_sdk
from fingerprint_server_sdk import ApiException, SearchEventsBot
from fingerprint_server_sdk import ApiException, SearchEventsBot, ErrorResponse
from fingerprint_server_sdk.configuration import Region

# Configure API key authorization and region
Expand All @@ -172,7 +188,15 @@ try:
api_response = api_instance.search_events(limit, pagination_key=pagination_key, visitor_id=visitor_id, bot=bot, ip_address=ip_address, linked_id=linked_id, start=start, end=end, reverse=reverse, suspect=suspect)
print(api_response)
except ApiException as e:
print(f'Exception when calling FingerprintApi->get_event: {e}\n')
if e.body is not None:
error_response = ErrorResponse.from_json(e.body)
if error_response is not None:
message = f"API request failed: {error_response.error.code} {error_response.error.message}"
else:
message = f"API request failed with unexpected error format: {e}"
else:
message = f'Exception when calling FingerprintApi->get_event: {e}'
print(message)
```

To learn more, refer to example located in [examples/search_events_example.py](examples/search_events_example.py).
Expand All @@ -182,7 +206,7 @@ Update event for `eventId`:
import os

import fingerprint_server_sdk
from fingerprint_server_sdk import ApiException, EventUpdate
from fingerprint_server_sdk import ApiException, EventUpdate, ErrorResponse
from fingerprint_server_sdk.configuration import Region

# Configure API key authorization and region
Expand All @@ -201,7 +225,15 @@ body = EventUpdate(linked_id='foo')
try:
api_instance.update_event(event_id, body)
except ApiException as e:
print(f'Exception when calling FingerprintApi->update_event: {e}\n')
if e.body is not None:
error_response = ErrorResponse.from_json(e.body)
if error_response is not None:
message = f"API request failed: {error_response.error.code} {error_response.error.message}"
else:
message = f"API request failed with unexpected error format: {e}"
else:
message = f'Exception when calling FingerprintApi->update_event: {e}'
print(message)
```

To learn more, refer to example located in [examples/update_event_example.py](examples/update_event_example.py).
Expand Down
56 changes: 44 additions & 12 deletions docs/FingerprintApi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ Please [contact our support team](https://fingerprint.com/support/) to enable it
import os

import fingerprint_server_sdk
from fingerprint_server_sdk.rest import ApiException
from fingerprint_server_sdk import ApiException, ErrorResponse
from fingerprint_server_sdk.configuration import Region
from pprint import pprint

Expand All @@ -64,8 +64,16 @@ visitor_id: str = 'visitor_id_example' # The [visitor ID](https://docs.fingerpri
try:
# Delete data by visitor ID
api_instance.delete_visitor_data(visitor_id)
except Exception as e:
print("Exception when calling FingerprintApi->delete_visitor_data: %s\n" % e)
except ApiException as e:
if e.body is not None:
error_response = ErrorResponse.from_json(e.body)
if error_response is not None:
message = f"API request failed: {error_response.error.code} {error_response.error.message}"
else:
message = f"API request failed with unexpected error format: {e}"
else:
message = f'Exception when calling FingerprintApi->delete_visitor_data: {e}'
print(message)
```

### Parameters
Expand Down Expand Up @@ -112,7 +120,7 @@ import os

import fingerprint_server_sdk
from fingerprint_server_sdk.models.event import Event
from fingerprint_server_sdk.rest import ApiException
from fingerprint_server_sdk import ApiException, ErrorResponse
from fingerprint_server_sdk.configuration import Region
from pprint import pprint

Expand All @@ -133,8 +141,16 @@ try:
api_response = api_instance.get_event(event_id, ruleset_id=ruleset_id)
print("The response of FingerprintApi->get_event:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling FingerprintApi->get_event: %s\n" % e)
except ApiException as e:
if e.body is not None:
error_response = ErrorResponse.from_json(e.body)
if error_response is not None:
message = f"API request failed: {error_response.error.code} {error_response.error.message}"
else:
message = f"API request failed with unexpected error format: {e}"
else:
message = f'Exception when calling FingerprintApi->get_event: {e}'
print(message)
```

### Parameters
Expand Down Expand Up @@ -204,7 +220,7 @@ from fingerprint_server_sdk.models.event_search import EventSearch
from fingerprint_server_sdk.models.search_events_bot import SearchEventsBot
from fingerprint_server_sdk.models.search_events_sdk_platform import SearchEventsSdkPlatform
from fingerprint_server_sdk.models.search_events_vpn_confidence import SearchEventsVpnConfidence
from fingerprint_server_sdk.rest import ApiException
from fingerprint_server_sdk import ApiException, ErrorResponse
from fingerprint_server_sdk.configuration import Region
from pprint import pprint

Expand Down Expand Up @@ -262,8 +278,16 @@ try:
api_response = api_instance.search_events(limit=limit, pagination_key=pagination_key, visitor_id=visitor_id, bot=bot, ip_address=ip_address, asn=asn, linked_id=linked_id, url=url, bundle_id=bundle_id, package_name=package_name, origin=origin, start=start, end=end, reverse=reverse, suspect=suspect, vpn=vpn, virtual_machine=virtual_machine, tampering=tampering, anti_detect_browser=anti_detect_browser, incognito=incognito, privacy_settings=privacy_settings, jailbroken=jailbroken, frida=frida, factory_reset=factory_reset, cloned_app=cloned_app, emulator=emulator, root_apps=root_apps, vpn_confidence=vpn_confidence, min_suspect_score=min_suspect_score, developer_tools=developer_tools, location_spoofing=location_spoofing, mitm_attack=mitm_attack, proxy=proxy, sdk_version=sdk_version, sdk_platform=sdk_platform, environment=environment, proximity_id=proximity_id, total_hits=total_hits, tor_node=tor_node)
print("The response of FingerprintApi->search_events:\n")
pprint(api_response)
except Exception as e:
print("Exception when calling FingerprintApi->search_events: %s\n" % e)
except ApiException as e:
if e.body is not None:
error_response = ErrorResponse.from_json(e.body)
if error_response is not None:
message = f"API request failed: {error_response.error.code} {error_response.error.message}"
else:
message = f"API request failed with unexpected error format: {e}"
else:
message = f'Exception when calling FingerprintApi->search_events: {e}'
print(message)
```

### Parameters
Expand Down Expand Up @@ -353,7 +377,7 @@ import os

import fingerprint_server_sdk
from fingerprint_server_sdk.models.event_update import EventUpdate
from fingerprint_server_sdk.rest import ApiException
from fingerprint_server_sdk import ApiException, ErrorResponse
from fingerprint_server_sdk.configuration import Region
from pprint import pprint

Expand All @@ -372,8 +396,16 @@ event_update: EventUpdate = fingerprint_server_sdk.EventUpdate() #
try:
# Update an event
api_instance.update_event(event_id, event_update)
except Exception as e:
print("Exception when calling FingerprintApi->update_event: %s\n" % e)
except ApiException as e:
if e.body is not None:
error_response = ErrorResponse.from_json(e.body)
if error_response is not None:
message = f"API request failed: {error_response.error.code} {error_response.error.message}"
else:
message = f"API request failed with unexpected error format: {e}"
else:
message = f'Exception when calling FingerprintApi->update_event: {e}'
print(message)
```

### Parameters
Expand Down
14 changes: 11 additions & 3 deletions template/api_doc_example.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import {{{packageName}}}
{{#vendorExtensions.x-py-example-import}}
{{{.}}}
{{/vendorExtensions.x-py-example-import}}
from {{{packageName}}}.rest import ApiException
from {{{packageName}}} import ApiException, ErrorResponse
from {{packageName}}.configuration import Region
from pprint import pprint

Expand All @@ -29,6 +29,14 @@ try:
print("The response of {{classname}}->{{operationId}}:\n")
pprint(api_response)
{{/returnType}}
except Exception as e:
print("Exception when calling {{classname}}->{{operationId}}: %s\n" % e)
except ApiException as e:
if e.body is not None:
error_response = ErrorResponse.from_json(e.body)
if error_response is not None:
message = f"API request failed: {error_response.error.code} {error_response.error.message}"
else:
message = f"API request failed with unexpected error format: {e}"
else:
message = f'Exception when calling {{classname}}->{{operationId}}: {e}'
print(message)
```
48 changes: 40 additions & 8 deletions template/common_README.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Delete visitor data using `visitorId`:
import os

import {{packageName}}
from {{packageName}} import ApiException
from {{packageName}} import ApiException, ErrorResponse
from {{packageName}}.configuration import Region

{{> python_doc_auth_partial}}
Expand All @@ -29,7 +29,15 @@ visitor_id = 'visitor_id_example'
try:
api_instance.delete_visitor_data(visitor_id)
except ApiException as e:
print(f'Exception when calling FingerprintApi->delete_visitor_data: {e}\n')
if e.body is not None:
error_response = ErrorResponse.from_json(e.body)
if error_response is not None:
message = f"API request failed: {error_response.error.code} {error_response.error.message}"
else:
message = f"API request failed with unexpected error format: {e}"
else:
message = f'Exception when calling FingerprintApi->delete_visitor_data: {e}'
print(message)
```

To learn more, refer to example located in [examples/delete_visitor_example.py](examples/delete_visitor_example.py).
Expand All @@ -39,7 +47,7 @@ Fetching event details for `eventId`:
import os

import {{packageName}}
from {{packageName}} import ApiException
from {{packageName}} import ApiException, ErrorResponse
from {{packageName}}.configuration import Region

{{> python_doc_auth_partial}}
Expand All @@ -51,7 +59,15 @@ event_id = 'event_id_example'
try:
events_response = api_instance.get_event(event_id)
except ApiException as e:
print(f'Exception when calling FingerprintApi->get_event: {e}\n')
if e.body is not None:
error_response = ErrorResponse.from_json(e.body)
if error_response is not None:
message = f"API request failed: {error_response.error.code} {error_response.error.message}"
else:
message = f"API request failed with unexpected error format: {e}"
else:
message = f'Exception when calling FingerprintApi->get_event: {e}'
print(message)
```

To learn more, refer to example located in [examples/get_event_example.py](examples/get_event_example.py).
Expand All @@ -61,7 +77,7 @@ Search events with custom filters:
import os

import {{packageName}}
from {{packageName}} import ApiException, SearchEventsBot
from {{packageName}} import ApiException, SearchEventsBot, ErrorResponse
from {{packageName}}.configuration import Region

{{> python_doc_auth_partial}}
Expand All @@ -84,7 +100,15 @@ try:
api_response = api_instance.search_events(limit, pagination_key=pagination_key, visitor_id=visitor_id, bot=bot, ip_address=ip_address, linked_id=linked_id, start=start, end=end, reverse=reverse, suspect=suspect)
print(api_response)
except ApiException as e:
print(f'Exception when calling FingerprintApi->get_event: {e}\n')
if e.body is not None:
error_response = ErrorResponse.from_json(e.body)
if error_response is not None:
message = f"API request failed: {error_response.error.code} {error_response.error.message}"
else:
message = f"API request failed with unexpected error format: {e}"
else:
message = f'Exception when calling FingerprintApi->get_event: {e}'
print(message)
```

To learn more, refer to example located in [examples/search_events_example.py](examples/search_events_example.py).
Expand All @@ -94,7 +118,7 @@ Update event for `eventId`:
import os

import {{packageName}}
from {{packageName}} import ApiException, EventUpdate
from {{packageName}} import ApiException, EventUpdate, ErrorResponse
from {{packageName}}.configuration import Region

{{> python_doc_auth_partial}}
Expand All @@ -110,7 +134,15 @@ body = EventUpdate(linked_id='foo')
try:
api_instance.update_event(event_id, body)
except ApiException as e:
print(f'Exception when calling FingerprintApi->update_event: {e}\n')
if e.body is not None:
error_response = ErrorResponse.from_json(e.body)
if error_response is not None:
message = f"API request failed: {error_response.error.code} {error_response.error.message}"
else:
message = f"API request failed with unexpected error format: {e}"
else:
message = f'Exception when calling FingerprintApi->update_event: {e}'
print(message)
```

To learn more, refer to example located in [examples/update_event_example.py](examples/update_event_example.py).
Expand Down
Loading