Technische Anforderung (Integration)
Dieses Dokument beschreibt die technischen Anforderungen für die Integration von melibo mit einem externen Backend-System. Es definiert die unterstützten API-Typen, Authentifizierungsmethoden, Antwortformate und gibt eine Checkliste zur Vorbereitung.
🧰Voraussetzungen
Ein Backend-System mit einer REST- oder GraphQL-API
Unterstützung einer der aufgeführten Authentifizierungsverfahren
Möglichkeit, eine Antwort innerhalb von 9 Sekunden bereitzustellen
Dokumentation zu Endpunkten, Authentifizierung und Antwortschema
🔄 Funktionsweise
melibo stellt eine Server-zu-Server-HTTP-Anfrage an dein Backend-System.
Die Anfrage wird ausgelöst, wenn ein Benutzerpfad im Dialog einen Integrationsknoten erreicht.
Zurückgelieferte Daten werden in der aktuellen melibo-Sitzung gespeichert und stehen für deren Dauer zur Verfügung.
Wenn deine API besondere Anforderungen hat (z. B. spezielle Authentifizierung, unübliche Anfrage-/Antworttypen oder komplexe Verarbeitung), kontaktiere bitte deinen melibo-Ansprechpartner.
🔧 Unterstützte API-Typen
REST
GraphQL
⚡ Anforderungen an die API-Response
Antwort muss innerhalb von 9 Sekunden erfolgen.
Rückgabe im JSON-Format wird bevorzugt.
🔐 Unterstützte Authentifizierungsverfahren
Von melibo werden folgende Verfahren unterstützt:
API-Schlüssel
Bearer Token
Basic Authentication
OAuth 2.0
🚫 Einschränkungen
Keine Webhooks oder Datenexporte
Keine mehreren API-Aufrufe innerhalb einer Anfrage (verkettete unabhängige APIs sind erlaubt)
Keine Endpunkte mit umfangreicher Datenaufbereitung
✅ Checkliste zur API-Vorbereitung
Bevor du die Integration startest, überprüfe bitte folgende Punkte:
✅ Ist die API mit für Nutzer relevante Daten „durchsuchbar“ (z. B. Daten aus CRM)?
✅ Enthält die API-Antwort alle Informationen, die deinen Anwendungsfall abdecken?
✅ Wenn mehrere Systeme beteiligt sind: Konsolidierst du die Daten über eine Zwischenschicht?
✅ Ist klar definiert, wann die API welche HTTP-Statuscodes zurückgibt (200, 400, 404)?
✅ Was liefert die API bei ungültigen oder fehlerhaften Eingaben zurück?
✅ Gibt es ein festgelegtes Rate Limit?
✅ Wie lange dauert die Antwortzeit im Durchschnitt?
📄 Bereitzustellende Informationen
Für eine erfolgreiche Integration halte bitte Folgendes bereit:
Dokumentation zu:
Authentifizierung
Anfrageparametern / Request-Body
Antwortschema
(Optional) Eine Postman-Sammlung
Testdaten für typische Szenarien
🏁 Ergebnis
Wenn alle Anforderungen erfüllt und die notwendigen Informationen bereitgestellt sind, kann die melibo-Integration reibungslos durchgeführt werden.
Zuletzt aktualisiert
War das hilfreich?