API-Nutzung

Evolo Chatbot benötigt drei API-Endpunkte für eine ordnungsgemäße Funktion: Session-Initialisierung, Zustimmungsverwaltung und Chat-Verarbeitung. Diese Anleitung erklärt die Anforderungen für jeden Endpunkt und bietet Implementierungsbeispiele.

Erforderliche API-Endpunkte

Der Chatbot erwartet drei Endpunkte, die über die apiEndpoint Prop konfiguriert werden:

<EvoloChatbot
  apiEndpoint={{
    session: "https://evolo-api.com/api/session",
    consent: "https://evolo-api.com/api/session/consent", 
    chat: "https://evolo-api.com/api/chat"
  }}
  // ... other props
/>

Session-Endpunkt

Zweck

Der Session-Endpunkt initialisiert eine Chat-Session und gibt den aktuellen Tracking-Zustimmungsstatus für DSGVO-Compliance zurück.

Anfrage

• Methode: POST
• URL: {apiEndpoint.session}
• Headers: Content-Type: application/json

Response

{
  "trackingConsent": "PENDING" | "GRANTED" | "DENIED"
}

Antwort-Felder

• trackingConsent: Aktueller Zustimmungsstatus
  • "PENDING": Benutzer hat noch keine Wahl getroffen (zeigt Cookie-Zustimmungsdialog)
  • "GRANTED": Benutzer hat Tracking-Cookies akzeptiert
  • "DENIED": Benutzer hat Tracking-Cookies abgelehnt

Zustimmungs-Endpunkt

Zweck

Der Zustimmungs-Endpunkt aktualisiert die Tracking-Zustimmungspräferenz des Benutzers, wenn dieser eine Wahl im Cookie-Zustimmungsdialog trifft.

Request

• Method: POST
• URL: /api/session/consent
• Headers: Content-Type: application/json

Response

• Status: 200 OK for success
• Body: Can be empty or contain a success message

Chat-Endpunkt

Zweck

Der Chat-Endpunkt verarbeitet KI-Unterhaltungen und muss mit dem useChat Hook der @ai-sdk/react Bibliothek kompatibel sein.

Request

• Method: POST
• URL: /api/chat
• Headers: Content-Type: application/json

Response

Der Endpunkt muss eine Streaming-Antwort zurückgeben, die mit dem AI SDK kompatibel ist. Dies umfasst normalerweise:

1. Streaming von Text-Chunks für Echtzeitanzeige
2. Entsprechende Content-Type-Header für Streaming
3. Kompatibles Nachrichtenformat

Server-Lösungen

Wir bieten einsatzbereite Server-Implementierungen für gängige Plattformen:

Verfügbare Lösungen

1. Node.js/Express Paket: Vollständige Server-Implementierung mit notwendigen Modulen
2. Docker Container: Containerisierte Lösung für einfache Bereitstellung

Integrations-Schritte

# Session-Endpunkt testen
curl -X POST https://evolo-api.com/api/session

# Zustimmungs-Endpunkt testen (Session-Cookie oder Bearer-Token inkludieren)
curl -X POST https://evolo-api.com/api/session/consent -H "Content-Type: application/json" -d '{"consent":"GRANTED"}'

# Chat-Endpunkt testen (Session-Cookie oder Bearer-Token inkludieren)
curl -X POST https://evolo-api.com/api/chat -H "Content-Type: application/json" -d '{"messages":[{"role":"user","content":"Hallo"}]}'

<EvoloChatbot
  apiEndpoint={{
    session: "https://evolo-api.com/api/session",
    consent: "https://evolo-api.com/api/session/consent",
    chat: "https://evolo-api.com/api/chat"
  }}
// ... other props
/>