INHALTSVERZEICHNIS
- Was sind Webhooks?
- Wie kann ich einen Webhook hinzufügen?
- Wenn du einen Webhook erhältst, kannst du erwarten, dass die Statusanzeigen den folgenden Inhalt haben:
- Antwort-Code
Was sind Webhooks?
Ein Webhook in der Webentwicklung ist eine Methode, um das Verhalten einer Webseite oder Webanwendung mit benutzerdefinierten Rückrufmethoden zu erweitern oder zu ändern. Diese Rückrufe können von Drittbenutzern und Entwicklern verwaltet, geändert und betrieben werden, die nicht unbedingt mit der ursprunglichen Webseite oder Anwendung verbunden sind. Der Begriff "Webhook" wurde 2007 von Jeff Lindsay aus dem Begriff "Hook" aus der Computerprogrammierung geprägt.
Wenn ein Ereignis eintritt, werden Informationen über einen API-Schlüssel an den Endpunkt gesendet. Die Daten des Webhook-Ereignisses können als JSON oder XML gespeichert werden.
Typische Fälle, in denen Webhooks verwendet werden, sind folgende:
- Benachrichtigungen an Kunden für schnellen Zugriff senden
- Daten zur Speicherung sammeln
- Integration mit Buchhaltungssoftware
- Bestellartikel filtern und informierende Unternehmen angeben
- Kundendaten aus der Datenbank entfernen
Wie kann ich einen Webhook hinzufügen?
Gehe ins Kontrolle-Panel > Einstellungen > Webhooks > Einen Webhook hinzufügen.
API-Schlüssel - Hier wählst du den API-Schlüssel aus. Du kannst "Standard" hinzufügen: Dies ist der, den du automatisch in deinem Shop erstellt hast. Du kannst auch einen neuen API-Schlüssel unter Einstellungen > API-Schlüssel erstellen.
Ziel-URL - Das ist die URL, an die der Webhook gesendet wird.
Aktion, wenn - Hier wählst du die Aktion aus, wann der Webhook ausgeführt werden soll.
Neue Hook-Struktur verwenden - Gibt dir die Möglichkeit, einen Webhook mit Bestellungen zu nutzen
Ein Beispiel I: Wenn eine neue Bestellung eingeht, wird die Aktion den Webhook an die angegebene Ziel-URL ausführen.
Ein Beispiel II: Hier kannst du ein Beispiel-Webhook sehen: Order.json
Wenn du einen Webhook erhältst, kannst du erwarten, dass die Statusanzeigen den folgenden Inhalt haben:
Bestellstatus: ausstehend, storniert, überfällig, abgebrochen, fehlgeschlagen, erstattet, bezahlt, vollständig
Zahlungsstatus: angefordert, ausstehend, angehalten, abgeschlossen, fehlgeschlagen, erstattet, abgebrochen, überfällig
Erfüllungsstatus: nicht_erfüllt, erfüllt
Antwort-Code
Es gibt einen Mechanismus, der den Rückgabecode des Empfängers überwacht. Wenn der Rückgabecode 200 ist, ist alles in Ordnung. Ist der Rückgabecode von 200 unterschiedlich oder dauert die Antwort länger als 5 Sekunden, wiederholen wir die Versuche, die Informationen bis zu 5 mal zu liefern.
Zeitintervall zwischen den Versuchen:
1 - Echtzeitsendung
2 - Nach 60 Sekunden vom vorherigen gesendet
3 - Nach 120 Sekunden vom vorherigen gesendet
4 - Nach 180 Sekunden vom vorherigen gesendet
5 - Nach 240 Sekunden vom vorherigen gesendet
6 - Nach 300 Sekunden vom vorherigen gesendet
Nach 6 erfolglosen Versuchen, wenn die Informationen nicht empfangen werden, wird sie nicht wieder gesendet. Wenn wir die Rückgabecodes 400, 401, 403, 404, 405, 406, 410, 411 erhalten, deaktivieren wir den Webhook in der Shopverwaltung. Wenn wir in der Antwort den Text "bitte meldet mich ab" erhalten, wird dieser Webhook aus der Shopverwaltung gelöscht.