API-Übersicht

Diese Dokumentation richtet sich an Entwickler, die Leitwerk in ein eigenes System einbauen wollen. Sie konzentriert sich bewusst nur auf die Teile, die für die Integration relevant sind: Authentifizierung, Log-Ingest und Push.

Empfohlene Reihenfolge

1. Authentifizierung verstehen

Lies zuerst den Abschnitt Authentifizierung, damit klar ist, wann du eine Admin-Session, einen Kunden-API-Key oder einen Push-Client-Key brauchst.

2. Log-Ingest anbinden

Wenn du nur Logs senden willst, reicht in der Regel schon:

1. Kunde im Dashboard anlegen
2. API-Key kopieren
3. POST /api/ingest/logs aufrufen

3. Push nur bei Bedarf aktivieren

Für Push brauchst du zusätzlich:

1. optional eine Quell-App
2. einen Push-Client oder Push-Client-Key
3. eine Subscription aus dem Browser
4. eine Nachricht über die Push-API

Dokumentationsbereiche

Quick Start

• erklärt den kompletten Einbau aus Entwicklersicht
• zeigt, wann ein eigener Service sinnvoll ist
• beschreibt, was du selbst speichern musst

Authentifizierung

• Admin-Session für /api/dashboard/**
• Kunden-API-Key für Logs und kundenbezogene Push-Endpunkte
• Push-Client-Key für Browser-/Geräte-Registrierung
• öffentliche Bootstrap-Endpunkte ohne Auth

Log-Ingest

• zentraler Einstieg für externe Anwendungen
• dedupliziert gleiche Logs pro Kunde
• ideal für PHP, Node.js, Python oder andere Services

Push-API

• VAPID-Key laden
• Push-Clients registrieren
• Subscriptions speichern und löschen
• Nachrichten senden, planen und aktualisieren

Schnellstart in 5 Schritten

1. Kunde anlegen

1. Öffne Dashboard -> Kunden.
2. Lege einen Kunden an.
3. Kopiere den angezeigten API-Key sofort.

2. Erste Logs senden

Sende an /api/ingest/logs mit folgendem Header:

Authorization: Bearer ihr-api-key

3. Optionale Quell-App anlegen

Wenn du Push oder App-spezifische Filter nutzen willst:

1. Öffne System -> Apps
2. App anlegen
3. dem Kunden zuweisen

4. Push-Client registrieren

Für Browser-Push:

1. GET /api/push/vapid-public-key
2. Browser-Subscription erzeugen
3. Client über /api/push/clients/register registrieren
4. Subscription über /api/push/subscriptions speichern

5. Push senden oder planen

Nutze POST /api/push/notifications mit:

• scheduleType: "immediate" für Sofortversand
• scheduleType: "scheduled" für geplante Zustellung

Wichtige Grundregeln

Typische Pfade

Nächster Schritt

Gehe als Nächstes in der Navigation zu Quick Start, wenn du den Einbau einmal komplett von Anfang bis Ende verstehen willst.