πŸ“š VermieterBox API Dokumentation

Version 2.0.0 | REST API

πŸ” Authentifizierung

POST /api/auth/login
Anmeldung mit E-Mail und Passwort
{
  "email": "admin@vermieterbox.lan",
  "password": "admin123"
}
POST /api/auth/logout πŸ”’ Auth Required
Abmelden und Token invalidieren
GET /api/auth/verify πŸ”’ Auth Required
Token verifizieren und User-Info abrufen

🏒 Objekte

GET /api/objekte πŸ”’ Auth Required
Liste aller Objekte abrufen
GET /api/objekte/:id πŸ”’ Auth Required
Einzelnes Objekt abrufen
POST /api/objekte πŸ”’ Auth Required
Neues Objekt erstellen
PUT /api/objekte/:id πŸ”’ Auth Required
Objekt aktualisieren
DELETE /api/objekte/:id πŸ”’ Auth Required
Objekt lΓΆschen

🏠 Einheiten

GET /api/einheiten πŸ”’ Auth Required
Liste aller Einheiten
GET /api/einheiten/:id πŸ”’ Auth Required
Einzelne Einheit abrufen
GET /api/einheiten/:id/bewohner πŸ”’ Auth Required
Bewohner einer Einheit abrufen
POST /api/einheiten πŸ”’ Auth Required
Neue Einheit erstellen
PUT /api/einheiten/:id πŸ”’ Auth Required
Einheit aktualisieren

🧩 Addon System

GET /api/addons πŸ”’ Auth Required
Liste aller installierten Addons
GET /api/addons/:id πŸ”’ Auth Required
Addon-Details abrufen
POST /api/addons/:id/enable πŸ”’ Auth Required
Addon aktivieren
POST /api/addons/:id/disable πŸ”’ Auth Required
Addon deaktivieren
GET /api/addons/:id/config πŸ”’ Auth Required
User-spezifische Addon-Konfiguration
POST /api/addons/:id/config πŸ”’ Auth Required
Addon-Konfiguration speichern
POST /api/addons/install πŸ”’ Auth Required
Addon aus .vbaddon Datei installieren

βš™οΈ Settings

GET /api/settings πŸ”’ Auth Required
User-Settings abrufen
POST /api/settings πŸ”’ Auth Required
User-Settings speichern
{
  "general": {
    "company": "Meine Hausverwaltung",
    "street": "Musterstr. 1",
    "zip": "12345",
    "city": "Berlin"
  },
  "appearance": {
    "darkmode": true,
    "themeColor": "#667eea"
  }
}

πŸ“ Allgemeine Hinweise

πŸš€ Quick Start

# 1. Login
curl -X POST /api/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email":"admin@vermieterbox.lan","password":"admin123"}'

# 2. Use Token for API Calls
curl /api/objekte \
  -H "Authorization: Bearer YOUR_TOKEN_HERE"