Das Add-on Easy Affiliate Developer Tools erweitert Easy Affiliate um eine vollständige REST-API und eine vollständige Webhook-Event-Fähigkeit. Das bedeutet, dass Sie das Add-on verwenden können, um Easy Affiliate mit Plattformen und Plugins von Drittanbietern zu integrieren.
Dieses Dokument gibt einen grundlegenden Überblick über das Add-on und seine Möglichkeiten.
Anmerkung: Das Easy Affiliate Developer Tools Add-on ist mit dem Easy Affiliate Pro-Abo erhältlich.
Video-Setup-Anweisungen
Installation des Add-ons Easy Affiliate Developer Tools
Sie können das Add-on Developer Tools auf die gleiche Weise installieren wie jedes andere Add-on für Easy Affiliate:
- Navigieren Sie in Ihrem WordPress-Dashboard zu Leichtes Affiliate > Add-ons;
- Suche nach Entwickler-Toolsoder durchsuchen Sie die Liste der Add-ons;
- Klicken Sie auf das Add-on installieren Taste.
Sobald das Plugin installiert ist, können Sie die Optionen der Entwicklertools von Ihrem WordPress Dashboard > Leichtes Affiliate > Entwickler.
Hier finden Sie die folgenden Optionen:
Webhaken
Easy Affiliate verwendet Webhook-URLs, um mit jeder Plattform oder jedem Plugin eines Drittanbieters über die von Ihnen erstellten Integrationen zu kommunizieren.
Im Rahmen der Webhaken Menü können Sie für jede Ihrer Integrationen eine Webhook-URL hinzufügen. Um weitere Webhooks zu erstellen, klicken Sie einfach auf die Schaltfläche "+" Symbol.
Nach der Erstellung wird jede Webhook-URL mit dem Fortgeschrittene wird verwendet, um Ereignisse auszuwählen, die an diesen Webhook gesendet werden sollen.
Hier können Sie auswählen Alle Ereignisse oder die spezifischen für diesen Webhook.
Webhook-Schlüssel
Sie können den Schlüssel verwenden, um Webhook-POST-Anfragen zu authentifizieren. Dieser Schlüssel wird automatisch durch das Add-on Developer Tools generiert.
Anmerkung: Wenn Sie glauben, dass Ihr Webhook-Schlüssel kompromittiert wurde, können Sie jederzeit einen neuen Webhook-Schlüssel erzeugen, indem Sie auf die Schaltfläche Symbol für sich drehende Pfeile (Symbol "Webhook-Schlüssel neu generieren") neben dem Schlüsselfeld.
Um die Webhook-Anfrage zu validieren, holen Sie die HTTP-Header und suchen Sie nach dem esaf-webhook-key. Hier ist ein Beispiel für einen HTTP-Header mit dem empfangenen Webhook-Schlüssel:
Veranstaltungen
Die Veranstaltungen können Sie eine dynamische Dokumentation der verfügbaren Webhook-Ereignisse anzeigen.
Sie können ein beliebiges Ereignis auswählen, um Einzelheiten darüber zu erhalten, wann dieses Ereignis ausgelöst wird, sowie ein Beispiel für die damit verbundene JSON-Antwort.
Sie können Ereignisse auch testen, indem Sie eine POST-Anfrage für ein ausgewähltes Ereignis an alle Webhooks senden, die unter der Option Webhaken Option.
REST-API
Die REST-API enthält Ihren API-Schlüssel und eine Liste von URLs für alle verfügbaren Easy Affiliate REST API-Routen.
Ihr eindeutiger API-Schlüssel wird automatisch durch das Add-on Developer Tools generiert und kann zur Authentifizierung bei der REST-API verwendet werden. Bei Bedarf können Sie den API-Schlüssel neu generieren, indem Sie auf die Schaltfläche Symbol für sich drehende Pfeile.
Hinweis: Regenerierung API- und Webhook-Schlüssel kann bestehende Integrationen unterbrechen die Sie erstellt haben. Wenn Sie Schlüssel neu generieren, stellen Sie sicher, dass Ihre Integrationen aktualisiert werden, um die neuen Schlüssel zu verwenden falls erforderlich.
Hier finden Sie auch eine dynamische Dokumentation zu REST-API-Routen. Wählen Sie die API-Route aus, die Sie benötigen, und prüfen Sie alle zugehörigen Details:
- URL
- Beispielanfrage
- Argumente
- Beispielhafte Antwort
