Architektur-Schichten
BFF-Pattern (Backend-for-Frontend)
Ein dediziertes Backend-for-Frontend aggregiert API-Aufrufe, transformiert Datenformate und reduziert Roundtrips zwischen Client und KI-Backend.
Server-Sent Events (SSE)
Echtzeit-Streaming statt Polling – Chatbot-Antworten, Validierungsergebnisse und Statusupdates werden sofort an den Client gepusht.
REST API (JSON)
Standardisierte RESTful Endpoints mit JSON-Payloads. OpenAPI 3.0-dokumentiert, versioniert und abwärtskompatibel.
Zentrale Endpoints
Alle APIs sind öffentlich dokumentiert, versioniert und mit interaktiver Sandbox testbar.
/api/v1/chatSendet eine Nutzereingabe an den Chatbot und erhält die KI-Antwort inkl. Feldzuweisungen./api/v1/form/{id}/schemaGibt den Entity Graph des Formulars zurück – Felder, Typen, Abhängigkeiten./api/v1/validateValidiert einzelne Felder oder den gesamten Antrag in Echtzeit./api/v1/extractExtrahiert strukturierte Daten aus Dokumenten (OCR + NLP)./api/v1/eligibility/{id}Prüft Anspruchsvoraussetzungen basierend auf den bisherigen Eingaben./api/v1/streamServer-Sent Events für Echtzeit-Streaming von Chatbot-Antworten und Validierungsergebnissen.Request-Lifecycle
Vom Client über das BFF zu den KI-Services und zurück – jeder Schritt optimiert.
Client → BFF
Das Frontend sendet Nutzereingaben an das BFF. Das BFF validiert, bündelt und leitet sie an die relevanten Microservices weiter.
BFF → KI-Services
Das BFF ruft Chat-, Validierungs- und Extraktions-Services parallel auf. Ergebnisse werden aggregiert und transformiert.
SSE-Stream
Antworten werden als Server-Sent Events zum Client gestreamt – Token für Token beim Chat, Feld für Feld bei der Validierung.
FMS-Rückschreibung
Das BFF transformiert die Ergebnisse ins FMS-Format (Formcycle / FormSolutions) und übergibt sie per REST an das Formularsystem.
API-Sicherheit
Mehrstufige Sicherheitsarchitektur für den Einsatz in öffentlichen Verwaltungen.
API-Key + JWT
Zweistufige Authentifizierung: API-Key für Service-Identifikation, JWT für Session-Token mit kurzer Laufzeit.
TLS 1.3 End-to-End
Alle API-Kommunikation über TLS 1.3 verschlüsselt. Certificate Pinning optional für On-Premise-Integrationen.
Audit-Logging
Jeder API-Aufruf wird protokolliert – inklusive Timestamp, Client-ID und Response-Code. DSGVO-konform anonymisiert.
Schema-Validierung
Eingehende Payloads werden gegen JSON-Schemas validiert, bevor sie verarbeitet werden. Input-Sanitization inklusive.
In 5 Minuten integriert
Die API ist so gestaltet, dass ein erster Chat-Request nach wenigen Minuten möglich ist – inklusive Streaming-Response via SSE.
- 1API-Key im Admin-Panel generieren
- 2Formular-Schema per GET abrufen
- 3Ersten Chat-Request senden
- 4SSE-Stream für Echtzeit-Antworten nutzen
- 5Daten ins FMS zurückschreiben
const response = await fetch(
'https://api.openadvo.de/v1/chat',
{
method: 'POST',
headers: {
'Authorization': 'Bearer pk_live_…',
'Content-Type': 'application/json',
'Accept': 'text/event-stream',
},
body: JSON.stringify({
form_id: 'wohngeld-2024',
message: 'Ich möchte Wohngeld
beantragen.',
session_id: 'sess_abc123',
}),
}
);
// SSE-Stream lesen
const reader = response.body
.getReader();
const decoder = new TextDecoder();
while (true) {
const { done, value } =
await reader.read();
if (done) break;
const chunk = decoder.decode(value);
// { type: "token",
// data: "Gerne helfe ich…" }
// { type: "field_update",
// data: { field: "name",
// value: "…" } }
console.log(JSON.parse(chunk));
}Vorkonfigurierte Integrationen
Für die gängigsten Formularsysteme bieten wir vorkonfigurierte Integrationen – die API kann aber auch direkt genutzt werden.