ACT365

Minimal httpx based client for the ACT365 API.

API documentation: https://act365api.docs.apiary.io/#

Published on PyPI: https://pypi.org/project/act365/

API Coverage

The ACT365 API is much larger than what this library currently binds. A summary of the full API is kept in docs/ACT365-API-Spec.md; the tables below map that API surface to the Python bindings in Act365Client / Act365Auth and the act365 CLI.

Covered

Authentication

API Binding CLI
POST /api/account/login Act365Auth — automatic bearer-token login, re-login on 401, backoff on 429 credentials via options or env vars

Cardholders

API Binding CLI
List cardholders (GET /api/cardholder) Act365Client.getCardholders() — paginated, supports siteid, enabled, searchString etc. filters act365 cardholders list
Get cardholder by ID Act365Client.getCardholderById() — client-side filter over the list endpoint, not the GET /api/cardholder/{id} endpoint act365 cardholders get --id
Get cardholder by email Act365Client.getCardholderByEmail() — client-side filter over the list endpoint act365 cardholders get --email
Create cardholder (POST /api/cardholder) Act365Client.createCardholder() —
Update cardholder (PUT /api/cardholder) Act365Client.updateCardholder() —

Event Bookings (bindings use /api/* endpoints; delete uses /api2/*)

API Binding CLI
List booking sites (GET /api/Bookingsites) Act365Client.getBookingSites() —
List doors on a site (GET /api/Bookingdoors?siteid={siteid}) Act365Client.getBookingSiteDoors() —
Create booking (POST /api/Bookings) Act365Client.createBooking() —
Get booking (GET /api/Bookings?siteid={siteid}&bookingID={bookingid}) Act365Client.getBooking() act365 bookings get --id
List bookings for a site (GET /api/getbookings?siteid={siteid}&date={dd/MM/YYYY}) Act365Client.getBookings() act365 bookings list
Delete booking (DELETE /api2/Bookings?bookingID={bookingid}) Act365Client.deleteBooking() act365 bookings delete --id / --expired

Act365Client also exposes raw post() / put() / delete() passthroughs for endpoints without dedicated bindings.

Not Covered

No Python bindings exist yet for the following areas of the API:

  • Summary — quick summary of customers/sites (GET /api/summary)
  • Customers — list customers (GET /api/customers)
  • Sites — list/get sites (GET /api/sites, GET /api/sites/{siteid})
  • Site Lockdown — activate / clear / command (POST /api/lockdown/*)
  • ACUs — list, get, register, delete controllers (/api/acus)
  • Doors — list, get, doors-for-cardholder, and door commands (Pass/Normalise/Lock/Unlock, single and bulk) (/api/doors)
  • Door Groups — full CRUD (/api/doorgroups)
  • Cameras — list cameras with live feed URLs (GET /api/cameras)
  • Reports / Events — muster report, manual check-in/check-out, and all log event report variants (site, door, door group, cardholder, cardholder group, category, alarms) (/api/events)
  • Cardholders (remaining) — get by external ID, delete, bulk create/delete, enable/disable (single and bulk), random PIN, switch site, and photo get/set/thumbnail
  • Cardholder Groups — full CRUD (/api/cardholdersgroups)
  • Timezones — full CRUD (/api/timezones)
  • WebHooks — register, unregister, list (/api/webhooks)
  • Video Diagnostics — segmenter and stream diagnostics (/api/video/*)
  • Event Bookings (remaining) — update booking, bulk create, delete by filter, bulk delete by IDs
  • Booking Output Scheduling — door output schedules (POST /api2/Schedule)
  • Localisation — localised strings (GET /api/localisation)
  • Permissions — current user access rights (GET /api/permissions)

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (1.7.1)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for simonmcc from gravatar.com simonmcc

Credits

Author: Simon McCartney

Requires

Python <4.0, >=3.11

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

act365-1.7.0.tar.gz (10.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

act365-1.7.0-py3-none-any.whl (11.2 kB view details)

Uploaded Python 3

File details

Details for the file act365-1.7.0.tar.gz.

File metadata

  • Download URL: act365-1.7.0.tar.gz
  • Upload date:
  • Size: 10.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for act365-1.7.0.tar.gz
Algorithm Hash digest
SHA256 d91b835a74c5fb33e23df893977329c6437bd69bf57ce5625f057f730b155b13
MD5 687cd7616a53daccf42a584ca2c5acc3
BLAKE2b-256 384f266e1109d86d986c7b6cb371bc69edd1a15a144c928ef2393c9a7ecdbcc4

See more details on using hashes here.

Provenance

The following attestation bundles were made for act365-1.7.0.tar.gz:

Publisher: publish.yml on jobdoneright/act365

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file act365-1.7.0-py3-none-any.whl.

File metadata

  • Download URL: act365-1.7.0-py3-none-any.whl
  • Upload date:
  • Size: 11.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for act365-1.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d6aab3a12170946e5ecc0ef6d33a4e62643cf35cc3e8709f0da81fb72d84c73f
MD5 d38a0623d5ba57a53e8c78d1cc5dafff
BLAKE2b-256 6f89d7daa4eb82207d2de5f434e36e8a991c217060f79e93b769e6015dcdd3ad

See more details on using hashes here.

Provenance

The following attestation bundles were made for act365-1.7.0-py3-none-any.whl:

Publisher: publish.yml on jobdoneright/act365

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page