Inhalt dieses Artikels
- Vorbemerkungen
- Erstellung eines Callbacks
- Hinzufügen einer Authentifizierung (optional)
1. Vorbemerkungen
Um Daten bei einer Erstellung oder Veränderung automatisiert an Drittsysteme zu übertragen können Callbacks angelegt werden. Die Anlage und die Verwaltung erfolgt auf Mandantenebene.
2. Erstellung eines Callbacks
- Öffnen des Menüpunkts Einstellungen / Entwicklung / Callbacks
- Klick auf die Option "+ Erstellen eines Callback" in der Aktionsleiste
- Angabe der Ziel-URL für die Datenübermittlung im Feld "URL des eigenen Webservice"
- Im Bereich "Callback Typ" werden die gewünschten Ereignisse ausgewählt, welche übermittelt werden sollen
- Für die Option "Kunde" können beispielsweise die Ereignisse "Erstellen" und "Ändern" ausgewählt werden um über die Erstellung und Änderung von Kunden-Datensätzen informiert zu werden
- Im Bezug auf Rechnungen könnten beispielsweise für die Optionen "Rechnung", "Rechnungsstornierung" & "Rechnungskorrektur" jeweils das Ereignis "Erstellen" ausgewählt werden um innerhalb eines Callback über die Erstellung, Stornierung und Korrektur von Rechnungen informiert zu werden
- Natürlich sind auch andere Anwendungen denkbar. Die Zusammensetzung der einzelnen Callbacks richtet sich dabei immer nach dem gewünschten Informationen und ich hoch individuell.
- Nach der Auswahl aller gewünschten Optionen und Ereignisse wird der Callback über den Button "Speichern" gesichert.
Hinweis: Ein Callback kann erst aktiviert werden, nachdem eine URL im Feld URL des eigenen Webservice hinterlegt ist. Ist das nicht der Fall ist die Checkbox Aktiviert nicht nutzbar. |
3. Hinzufügen einer Authentifizierung (optional)
Soll die Datenübermittlung per Callback abgesichert werden stehen verschieden Optionen zur Authentifizierung zur Verfügung. Die Daten zur Authentifizierung können
- bei der Anlage des Callbacks angegeben werden
- nachträglich verändert werden
- auf eine andere Authentifizierungsmethode aktualisiert werden
Hinweis: Auch wenn eine Authentifizierung grundsätzlich optional ist, empfiehlt es sich in vielen Fällen einen solchen Sicherheitsmechanismus zu nutzen. |
Methode 1: Authentifizierung per Benutzername und Passwort
Durch die Verwendung einer Basic Authentification per Benutzernamen und Passworts 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 plenigo enthalten.
Vorgehen:
- Öffnen des Menüpunkts Einstellungen / Entwicklung / Callbacks
- Klick auf die Option "+ Erstellen eines Callback" oder "Bearbeiten" in der Aktionsleiste
- Aktivierung der Checkbox "Endpunkt benötigt Authentifizierung"
- Eingabe der Daten für Benutzername und Passwort
- Nach der Auswahl aller gewünschten Optionen und Ereignisse wird der Callback über den Button "Speichern" gesichert.
Methode 2: Authentifizierung per HTTP-Header
HTTP-Header können zusätzlich zur Authentifizierung gegenüber einem Dienst verwendet werden.
Vorgehen:
- Öffnen des Menüpunkts Einstellungen / Entwicklung / Callbacks
- Klick auf die Option "+ Erstellen eines Callback" oder "Bearbeiten" in der Aktionsleiste
- Aktivierung der Checkbox "Endpunkt benötigt Authentifizierung"
- Eingabe der relevanten Authentifizierungsinformationen in den Feldern "Key" und "Value"
- Nach der Auswahl aller gewünschten Optionen und Ereignisse wird der Callback über den Button "Speichern" gesichert.