API-Zugang
So erstellen Sie einen API-Key für die programmgesteuerte Anbindung.
Die API (Schnittstelle) ermöglicht es fortgeschrittenen Nutzerinnen und Nutzern, selbstverwalten. mit externen Programmen zu verbinden -- z. B. für eigene Auswertungen oder die Anbindung an andere Tools.
API-Schlüssel dürfen nur von Verwaltungsberechtigten erstellt werden. Ein Schlüssel gewährt je nach Einstellung weitreichenden Zugriff -- behandeln Sie ihn wie ein Passwort und geben Sie ihn nicht weiter.
Wann die API sinnvoll ist
- Automatische Abfragen aus eigenen Skripten
- Kopplung mit Buchhaltungs- oder BI-Tools (sofern vom jeweiligen Anbieter unterstützt)
- Eigenentwicklungen in der WEG (nur mit entsprechender Fachkenntnis)
Für den täglichen Gebrauch durch Eigentümer ist die normale App vorgesehen; die API ist optional.
API-Schlüssel erstellen
- Öffnen Sie die Einstellungen und den Bereich API oder Entwicklerzugang (falls aktiviert).
- Wählen Sie Neuen API-Schlüssel erstellen.
- Geben Sie einen Namen ein (z. B. „Backup-Skript Heim-PC“), damit Sie später zuordnen können.
- Wählen Sie die Berechtigungen (oft als Lesen, Schreiben, Löschen oder ähnlich bezeichnet). Nutzen Sie nur das Minimum, das Sie wirklich brauchen.
- Speichern Sie. Der Schlüssel wird einmalig angezeigt -- kopieren Sie ihn an einen sicheren Ort. Später ist er aus Sicherheitsgründen oft nicht mehr lesbar.
Verwendung in Programmen
Senden Sie bei jeder Anfrage den Schlüssel im HTTP-Header X-API-Key mit dem von Ihnen erzeugten Wert. Details zu URLs und Parametern finden Sie in der technischen Beschreibung der API.
Verfügbare Bereiche (Beispiele)
Je nach Version können u. a. folgende Daten über die API erreichbar sein:
- Einheiten und Personen
- Transaktionen (Finanzbewegungen)
- Rechnungen
- Beschlüsse
- Vorgänge
- Dokumente (Metadaten oder Downloads je nach Freigabe)
- WEG-Stammdaten
Die genaue Liste entnehmen Sie der OpenAPI-Beschreibung (siehe unten).
Grenzen und Dokumentation
- Häufigkeitsgrenze: In der Regel etwa 100 Anfragen pro Minute pro Schlüssel oder Konto (konkreter Wert in der App-Dokumentation).
- Maschinenlesbare Übersicht aller Endpunkte:
OpenAPI-Spezifikation unter/api/v1/openapi.json(vollständige URL Ihrer Installation, z. B.https://ihre-domain.de/api/v1/openapi.json).
Wenn Sie die API nicht kennen, ist das völlig in Ordnung -- für die Verwaltung im Alltag benötigen Sie sie nicht. Bei Fragen wenden Sie sich an eine IT-fachkundige Person oder den Support.