APIs

Grundsätzlich ist die Aktivierung der API ein Sonderwunsch und kann damit nicht immer garantiert gewährt werden. Jede API muss einzeln aktiviert werden.

Wetter-API

Daten werden der Einfachheit halber per GET und nicht per POST übergeben.

Beispielhafter Aufruf:

Es hat 20.0 Grad Lufttemperatur und 14.3 Grad im Wasser. Wir sind an der Location Default (2). Der API-Key ist „1234567890ABCDE“ (15 Stellen).

https://api.beispiel.wachbuch.info/login-wetter.php?key=1234567890ABCDEF&location=2&wasser=14.3&luft=20.0

FehlerBedeutung
Key is not valid.Ihr API-Key ist falsch (Mitglieder-API und Wetter-API haben unterschiedliche Keys!) oder die API ist für Sie noch nicht aktiviert.
Location is not set.Der „location“-Parameter fehlt. (&location=x)
Luft und Wasser eingetragen.Beide Parameter wurden erfolgreich eingetragen.
Wasser eingetragen.Nur die Wassertemperatur (Nicht aber die Lufttemperatur) wurden eingetragen.
Luft eingetragen.Nur die Lufttemperatur (Nicht aber die Wassertemperatur) wurden eingetragen.

 

Mitglieder-API

Die Mitglieder-API stellt eine zentrale Schnittstelle zur automatisierten Verwaltung von Mitgliedsdaten im digitalen Wachbuch dar. Sie ermöglicht es, Personen beispielsweise anhand ihrer Chip-Anmeldung am Türschloss automatisch als „anwesend“ oder „abwesend“ zu markieren. Darüber hinaus können Rollenänderungen – etwa die Zuweisung oder Entziehung von Verantwortlichkeiten an einem Wachtag – direkt über die API vorgenommen werden. Dies erlaubt eine nahtlose Integration in bestehende Zutritts- und Verwaltungssysteme und reduziert den manuellen Aufwand erheblich.

Ein typisches Anwendungsszenario ist die automatische Erfassung der Anwesenheit: Sobald ein Mitglied seinen Chip am Eingangsterminal scannt, wird über die API ein Eintrag im System erzeugt, der die Person als „anwesend“ markiert. Beim Verlassen erfolgt die Austragung auf dieselbe Weise. Ebenso kann das „einchippen“ am Boot über ein internes Tool per API die Rolle eines Mitglieds zum „Bootsführer“ ändern – etwa um kurzfristig einzuspringen. Die erweiterte Dokumentation sowie der API-Key sind auf Anfrage erhältlich und ermöglichen eine sichere und flexible Integration in individuelle Systemlandschaften.

Die Mitglieder-API kommuniziert ausschließlich über das JSON-Format. Alle Anfragen, insbesondere POST-Requests, müssen gültige JSON-Objekte im Request-Body enthalten. Zur Authentifizierung ist der HTTP-Header X-APIKEY erforderlich, der bei jeder Anfrage mit einem gültigen API-Schlüssel versehen sein muss.

Basis-Dokumentation

API-URL: <Wachbuch-URL>/Wachplan.php/api/
Header: X-APIKEY

Plan
POST User

Fügt einen neuen User dem Plan hinzu. Dies kann entweder als Stationskontrolle (wenn kein Wachtag offen ist) oder zu einem Wachtag erfolgen. Kommentar und Rolle sind nicht verpflichtend. Wird keine Rolle mitgegeben wird die rolle „mitglied“ verwendet, welche die höchste Ausbildung (einstellbar in den Allgemeinen Einstellungen) auswählt. 

POST /api/plan
Body:
{
  "user": <userid>,
  "wachtag": "latestOrStationskontrolle" | "latest" | <wachtagid>,
  "kommentar": <string, nicht required>,
  "rolle": <nicht required> "mitglied" | "stat" | <ausbildungs_id>
}
Response:
201 => Eingetragen
400 => Fehler allgemein (z.B. Berechtigung für Ausbildung fehlt)
400 => "Wachtag not found or not active" falls du eine Person auf einen Wachtag eintragen willst aber keiner offen ist oder der ausgewählte nicht offen ist
409 => Person bereits eingetragen oder User-ID unbekannt
409 => Stationskontrolle voll
PATCH User

Aktualisiert entweder Kommentar oder Rolle bei einer Person. Wird die Rolle bei einer Person geändert, so wird die Person ausgetragen und mit der neuen Rolle wieder eingetragen. 

PATCH /api/plan/<userid>
Body:
{
  "comment": <string, nicht required>,
  "rolle": <nicht required> "mitglied" | "stat" | <ausbildungs_id>
}
Response:
200 => Eintrag aktualisiert
400 => Fehler allgemein (z.B. User nicht eingetragen, Berechtigung für Ausbildung fehlt, ...)
DELETE User

Trägt einen Benutzer aus dem aktuellen Wachtag / der aktuellen Stationskontrolle aus.

DELETE /api/plan/<userid>
Response:
400 => Allgemeiner Fehler
409 => Person ist gar nicht angemeldet
200 => Erfolgreich abgemeldet
GET Users

Listet alle aktuell angemeldeten Mitglieder mit ihren aktuellen Rollen auf

GET /api/plan
Response:
400 => Personen existieren nicht
200 => Person gefunden
GET User

Listet ein aktuell angemeldetes Mitglied mit seiner Rolle auf

GET /api/plan/<userid>
Response:
400 => Person existiert nicht
200 => Person gefunden
Users (Benutzerdaten)
GET Users

Listet alle im digitalen Wachbuch verfügbaren Mitglieder mit Vorname, Nachname, Mitgliedsnummer, Adminstatus, Erstellungs- sowie Aktualisierungsdatum auf.

GET /api/users
GET User

Gibt die Details von einem Nutzer mit Vorname, Nachname, Mitgliedsnummer, Adminstatus, Erstellungs- sowie Aktualisierungsdatum zurück.

GET /api/users/<userid>
Response:
400 => Person existiert nicht
200 => Person gefunden
GET User-Ausbildungen

Gibt einem die im Wachbuch eingetragenen Ausbildungen einer Person zurück. Rückgabewert sind die Ausbildungs-ID, Eintragedatum der Ausbildung, Titel und Beschreibung der Ausbildung

GET /api/users/<userid>/ausbildungen
Response:
400 => Person existiert nicht
200 => Person gefunden