API-Zugang
So erstellst du 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: Behandle ihn wie ein Passwort und gib 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
- Öffne Daten & Integrationen in der Seitenleiste.
- Wähl im Bereich API-Zugang den Button Neuer API-Schlüssel.
- Gib einen Namen ein (z. B. „Backup-Skript Heim-PC" oder „DATEV-Export").
- Speichere. Der Schlüssel wird einmalig angezeigt. Kopier ihn sofort an einen sicheren Ort (z. B. einen Passwort-Manager). Danach ist er aus Sicherheitsgründen nicht mehr lesbar.
Nur WEG-Administratoren können API-Schlüssel anlegen. Jeder Schlüssel ist WEG-spezifisch und gewährt Zugriff auf genau diese eine WEG.
Verwendung in Programmen
Sende bei jeder Anfrage den Schlüssel entweder als:
- HTTP-Header
X-API-Key: <DEIN-SCHLUESSEL>, oder Authorization: Bearer <DEIN-SCHLUESSEL>
Beide Varianten sind gleichwertig. Details zu URLs, Parametern und Response-Formaten findest du in der OpenAPI-Spezifikation (siehe unten) oder in der interaktiven Swagger-UI unter /api-docs.
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 entnimmst du 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 deiner Installation, z. B.https://deine-domain.de/api/v1/openapi.json).
Wenn du die API nicht kennst, ist das völlig in Ordnung. Für die Verwaltung im Alltag brauchst du sie nicht. Bei Fragen wende dich an eine IT-fachkundige Person oder den Support.