Individuelle Schnittstelle

Lesen Sie hier ein Beispiel zu einer individuellen Schnittstelle zwischen zwei Anwendungen auf Basis von REST-APIs und Webhooks. In dem Beispiel geht es um eine CRM- und eine Shop-Software. Aus dem Shopsystem werden Bestelldaten ausgelesen und in das CRM eingestellt. Die Autorisierung erfolgt in beiden Fällen über API-Keys.

Die Serveranwendung
Für die Kommunikation über die Schnittstelle wird eine auf JavaScript basierte Serveranwendung erstellt. Die Anwendung wird passwortgeschützt auf einem über das Internet erreichbaren Server installiert.

API-Keys
Die beiden benötigten API-Keys werden vom Anwendungsadministrator über ein Online-Formular eingegeben und in einer Datenbank auf dem Server gespeichert.

Webhooks
Bei der Eingabe des Keys für das Shopsystem werden Webhooks für neue Bestellungen abonniert. Die Serveranwendung wird per Webhooks über neue Ereignisse benachrichtigt.

Abruf neuer Bestellungen
Die Serveranwendung erhält nun Meldungen zu neuen Bestellungen und kann diese über die REST-API des Shopsystems abrufen.

Verarbeitung der Bestellungen
Die Bestellungen aus dem Shopsystem werden über die REST-API des CRM-Systems in geeignete Datenstrukturen eingestellt.

Logging
Empfangen von Ereignissen, Abruf von Bestelldaten und anderen Ereignissen, insbesondere zu Verarbeitungsfehlern, werden protokolliert.

Entwicklungstätigkeiten
Bei der Entwicklung einer Anwendung gemäß obigem Beispiel fallen insbesondere folgende Tätigkeiten an:

• Detailfestlegung und Abstimmung
• Serverbereitstellung, beispielsweise virtuellen Server anmieten und konfigurieren
• Web-Anwendung realisieren
  • Datenbank erstellen
  • Passwortänderungsdialog
  • API-Keys verwalten
  • Webhooks abonnieren/abbestellen
  • Bestellungen abrufen und verarbeiten
  • Protokollierung
• Dokumentation und Benutzeranweisung erstellen
• Anwendung testen