Catalog PyPI
PACKAGE EXPLORERView in registry

act365

PyPI

Python Client for ACT365

Versions collected1
Direct dependencies3From release 1.8.0
Last observed20 Oct, 18:28 UTC

README

Version 1.8.0 documentation

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

APIBindingCLI
POST /api/account/loginAct365Auth — automatic bearer-token login, re-login on 401, backoff on 429credentials via options or env vars

Cardholders

APIBindingCLI
List cardholders (GET /api/cardholder)Act365Client.getCardholders() — paginated, supports siteid, enabled, searchString etc. filtersact365 cardholders list
Get cardholder by IDAct365Client.getCardholderById() — client-side filter over the list endpoint, not the GET /api/cardholder/{id} endpointact365 cardholders get --id
Get cardholder by emailAct365Client.getCardholderByEmail() — client-side filter over the list endpointact365 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/*)

APIBindingCLI
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)

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Versions 1

Collected releases
VersionPublishedDirect dependenciesOpen version
1.8.011 Aug 20263

Package advisories

0
No matching advisories collected

This describes our collected data; it is not a security assessment.

Metadata history

Meaningful changes
Current collected state Current

Observed since 20 Oct, 18:28 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package:ace11eac8567c57928f1a1606b5af6af50c27e1a0b82b9612b7ca155ac6d5731