API-Übersicht

🚧 In Vorbereitung — der API-Zugriff ist noch nicht implementiert. Diese Seite beschreibt das geplante Verhalten. Das Feature-Flag api_access existiert bereits, schaltet aber aktuell keine Endpunkte frei. Routen, Controller und Token-Verwaltung folgen in einem späteren Release.

Die Mitgliederverwaltung wird eine REST-API bereitstellen, über die externe Anwendungen auf Vereinsdaten zugreifen können. Die API muss für den Verein explizit aktiviert werden.

Nach Fertigstellung muss die API-Funktion vom Super-Admin aktiviert werden (api_access). Ohne Aktivierung sind alle API-Endpunkte nicht erreichbar.

#Authentifizierung

Die API verwendet Token-basierte Authentifizierung. API-Token werden vom Administrator im Bereich Vereinseinstellungen → API generiert und verwaltet.

Jede Anfrage muss den Token als Bearer-Header übermitteln:

 1Authorization: Bearer {ihr-api-token}

#Basis-URL

 1https://{vereins-subdomain}.example.com/api/v1/

#Verfügbare Endpunkte

Methode	Pfad	Beschreibung
`GET`	`/api/v1/plots`	Alle Parzellen mit Beziehungen
`GET`	`/api/v1/plots/{id}`	Einzelne Parzelle im Detail

Weitere Endpunkte sind für zukünftige Versionen geplant.

#Antwortformat

Alle Antworten werden als JSON zurückgegeben. Listenendpunkte sind paginiert.

 1{
 2  "data": [...],
 3  "links": {...},
 4  "meta": {
 5    "current_page": 1,
 6    "total": 42
 7  }
 8}

#Fehler

HTTP-Status	Bedeutung
`401`	Kein oder ungültiger API-Token
`403`	Keine Berechtigung für diese Ressource
`404`	Ressource nicht gefunden
`422`	Validierungsfehler