API-Verbindungen (Webhooks)

Ereignisse, Endpunkt, Synchronisation, Automatisierung, Parameter, Zustandsverwaltung

Beschreibung: Dieses Werkzeug ermöglicht es dem System, automatische Echtzeit-Benachrichtigungen an externe Anwendungen und Dienste zu senden, jedes Mal wenn ein bestimmtes Ereignis innerhalb von Framework360 eintritt.

Wozu dient es? (Praktische Beispiele)

API-Connectoren sind unerlässlich, um den Datenfluss zwischen Framework360 und anderer Unternehmenssoftware zu automatisieren, manuelle Arbeit zu reduzieren und sicherzustellen, dass alle Systeme synchronisiert sind.

  • CRM-Synchronisation: Verwenden Sie es, um Ihr Customer Relationship Management (CRM) zu benachrichtigen, sobald sich ein neuer Benutzer registriert oder ein potenzieller Kunde ein Formular ausfüllt.
  • Auftrags- und Lagerverwaltung: Senden Sie automatisch die Details einer abgeschlossenen Bestellung an Ihre Lagerverwaltungssoftware oder Abrechnungssoftware.
  • Marketing-Automatisierung: Starten Sie komplexe Workflows auf externen Plattformen (z.B. SMS-Versand, Erstellung von Aufgaben), sobald ein Kunde ein bestimmtes Ziel erreicht.

Hauptfunktionen

Die Verwaltung der API-Connectoren gliedert sich in folgende Funktionen:

  • Liste und Status: Schnelle Übersicht aller konfigurierten Connectoren, einschließlich des überwachten Ereignistyps, der Zieladresse und des Status (Aktiv/Inaktiv).
  • Ereignisdefinition: Möglichkeit, aus einer vordefinierten Liste auszuwählen, welches interne Ereignis (z.B. 'Neuer Benutzer', 'Bezahlte Bestellung' usw.) die Benachrichtigung auslösen soll.
  • Zieladresse (Endpoint): Einstellung der genauen URL des externen Dienstes, der die Daten erhalten soll.
  • Datenanpassung: Fähigkeit genau festzulegen, welche zusätzlichen Informationen gesendet werden sollen (POST-Daten) und wie sie gesendet werden sollen (HEADER-Parameter).
  • Aktivierung/Deaktivierung: Sofortige Kontrolle über die Betriebsbereitschaft des Connectors ohne Löschung.

Einrichtung

Um einen API-Connector zu erstellen oder zu bearbeiten, müssen folgende Felder ausgefüllt werden:

FeldBeschreibungHinweise
TypologieWählen Sie das spezifische Ereignis innerhalb von Framework360 aus, das die Benachrichtigung auslösen soll.Beispiel: "Wenn sich ein Benutzer registriert".
Ziel-URLDie Webadresse (Endpoint) des externen Systems, das die Daten empfangen wird.Dieses Feld ist Pflicht und muss eine gültige URL sein.
AktivAktivieren Sie dieses Kontrollkästchen, um den Connector betriebsbereit zu machen.Wenn nicht aktiviert, sendet der Connector keine Benachrichtigungen.

Benutzerdefinierte Parameter

Dieser Abschnitt erlaubt es, zusätzliche Daten und Anweisungen für die externe Anwendung festzulegen. Diese Felder erfordern Eingaben in einem strukturierten Format (JSON), um sicherzustellen, dass das empfangende System diese korrekt interpretieren kann.

AbschnittZweck
POST-ParameterDaten, die im Körper der Anfrage gesendet werden. Verwendet zur Übermittlung spezifischer Nutzlastinformationen (z.B. Authentifizierungsschlüssel oder zusätzliche Daten, die nicht automatisch enthalten sind).
HEADER-ParameterZusätzliche Informationen im Kopfbereich der Anfrage. Häufig genutzt für API-Authentifizierung (Token) oder zur Angabe des Datenformats.

Wichtig: Die in diesen Abschnitten eingegebenen Daten müssen strikt dem geforderten Format entsprechen. Andernfalls speichert das System die Konfiguration nicht und zeigt eine Fehlermeldung an.

Automatische Integrationen

Dieses Modul ist das Herzstück der Echtzeitautomatisierungen.

Wenn das in der Typologie ausgewählte Ereignis eintritt (z.B. ein Kunde schließt einen Kauf ab), führt das System automatisch folgende Schritte aus:

1. Es sammelt die informationsbezogenen Daten zum Ereignis.

2. Es erstellt eine Datenanfrage unter Einbeziehung etwaiger definierter Benutzerdefinierter Parameter.

3. Es sendet diese Anfrage an die angegebene Ziel-URL, wodurch die externe Anwendung sofort informiert wird.

Dieser Vorgang läuft im Hintergrund ab und erfordert nach der Erstkonfiguration keine manuelle Interaktion durch den Benutzer mehr.