Callback erstellen

Vorbemerkungen

Was sind Callbacks?

Callbacks ermöglichen es, Informationen zu definierten Ereignissen im Frisbii Media-System in quasi Echtzeit auf andere Systeme zu übertragen.

Bei der Integration von Frisbii Media ist es möglicherweise gewünscht, dass Drittsysteme Informationen zu Ereignissen empfangen, die im Frisbii Media System auftreten, damit diese Systeme entsprechend Aktionen ausführen können. Zu diesem Zweck können für bestimmte Ereignisse sogenannte Callbacks im Merchant Backend definiert werden. Die Anlage und die Verwaltung erfolgt auf Mandantenebene.

Hinweis zum Datenschutz:

Bei der Verwendung der meisten Callback-Typen werden personenbezogene Daten übertragen. Das empfangende System kann daher aus Sicht der geltenden Rechtsprechung als zusätzlicher Auftragsdatenverarbeiter definiert werden. Dies sollte bei der Verwendung von Callbacks berücksichtigt werden.  

Für Beispiele der Payloads haben wir einen eigenen Eintrag erstellt: Payloads - Beispiele  

Callbacks erstellen und aktivieren

Callback erstellen (ohne Authentifizierung)  

1. In der Aktionsleiste + Callback erstellen anklicken.

2. URL des eigenen Webservice eintragen. 
   Sobald die URL eingetragen wurde, kann die Checkbox Aktiviert angeklickt werden, um den Callback zu aktivieren.

3. Callback-Typ über das Dropdown-Menü auswählen (z. B. "Kunde erstellen").

4. Einstellungen speichern.

Nach dem Speichern generiert das Frisbii Media System automatisch für jeden Callback ein eigenes Callback Secret, das beim Öffnen des Callbacks in der Detailansicht eingesehen werden kann.

Callback erstellen (mit Authentifizierung)

Hinweis: Wir empfehlen grundsätzlich den Sicherheitsmechanismus durch Authentifizierung zu nutzen. 

• In der Aktionsleiste + Callback erstellen anklicken.

• Checkbox Endpunkt benötigt Authentifizierung aktivieren.

• Methode 1: Authentifizierung per Benutzername und Passwort
  Durch die Verwendung einer Basic Authentification per Benutzername und Passwort kann die Übertragung der Daten abgesichert werden. Dabei legt in den meisten Fällen das empfangende System die Daten zu Authentifizierung fest. Bei der Verwendung des so abgesicherten Callbacks sind die Daten zu Authentifizierung in jedem Request von Frisbii Media enthalten.

• Methode 2: Authentifizierung per HTTP-Header
  HTTP-Header können zusätzlich zur Authentifizierung gegenüber einem Dienst verwendet werden.
  Dazu ein oder mehrere key-value-Paar(e) eintragen.

Nach dem Speichern generiert das Frisbii Media System automatisch für jeden Callback ein eigenes Callback Secret, das beim Öffnen des Callbacks in der Detailansicht eingesehen werden kann.

Callbacks verwalten

Alle erstellten Callbacks werden auf der Übersichtsseite aufgelistet.

• Weitere Informationen zu einem bestimmten Callback können durch Klicken auf Details aufgerufen werden.

• Callbacks können bearbeitet werden, indem Bearbeiten angeklickt wird.
  Dies kann notwendig sein, um den Callback zu deaktivieren oder zu aktivieren, oder um bei fehlgeschlagenen Versuchen die URL des Webservice zu ändern oder den Callback-Typ anzupassen.

• Das Callback Log kann nach einer bestimmten Callback-ID durchsucht werden, indem Log durchsuchen angeklickt wird.
  Das  Callback Log öffnet sich und der Filter für diese spezifische Callback-ID ist bereits gesetzt.

Beispiel Header

In folgendem Beispiel wurde sowohl Methode 1 als auch Methode 2 des Sicherheitsmechanismus verwendet. Im Merchant Backend sehen die Einstellungen wie folgt aus:

Die Authentifizierung wird im Header des Callbacks übertragen. Die fettgedruckten Werte sind die entsprechenden Authentifizierungs-Daten, die im Merchant Backend eingestellt wurden. Zudem ist jeder Callback mit einer "plenigo-signature" signiert. Wie die Signatur geprüft werden kann, wird in folgendem Eintrag näher erläutert: plenigo-Signatur