Virtrex API & Webhook nutzen

1. Was sind eine API und ein Webhook? 

Eine API (Application Programming Interface) ist eine Schnittstelle, über welche ein System mit anderen Programmen oder Applikationen kommunizieren kann. Durch die REST-API bietet Virtrex die Möglichkeit, andere Software-Dienste wie ERP, CRM oder PIM zu verknüpfen. Der Vorteil liegt darin, dass Daten aus Virtrex gezogen und in jedem anderen System verarbeitet werden können sowie umgekehrt.

Webhooks ermöglichen eine einseitige Kommunikation zwischen Applikationen. Dabei spielt der Webhook eine Antwort an das externe System, wenn eine bestimmte Aktion vollzogen wird.

2. Anwendungsfelder bei Virtrex 

Aufgrund der REST-API lassen sich Datensätze in Virtrex mit externen Diensten erstellen, lesen, bearbeiten und löschen. Bitte beachten Sie, dass sich diese Funktionalitäten je nach Bereich, dem der Datensatz zugeordnet wird, unterscheiden können. Weiterführende Informationen erhalten Sie in unserer API-Dokumentation (s.u. Bild 1.2.).

Die Funktionalität der Webhooks können Sie direkt in Virtrex auswählen. Detaillierte Informationen dazu finden Sie in Abschnitt 4. Bitte beachten Sie hier, dass die eingestellten Aktionen auf Marken-Level stattfinden und aktuell nicht für eine einzelne Expo realisierbar sind. Weiterführende Informationen erhalten Sie in unserer Webhook-Dokumentation direkt im Admin Panel.

3. API-Schlüssel

Um einen API-Schlüssel in Ihrem Virtrex Admin Panel zu generieren, benötigen Sie die entsprechenden Rechte. Wenn Sie über diese verfügen, gehen Sie in der linken Menüleiste Ihres Admin Panels auf „Settings“, öffnen dort den Bereich „API-Integration“ und klicken den Button „Neuen API-Schlüssel erstellen“ (s.u. Bild 1.1.). Bitte geben Sie dazu einen Namen für den neuen API-Schlüssel ein, der sich eindeutig seiner Funktion zuordnen lässt. Nach der Erstellung können Sie den API-Schlüssel rechts über das Icon kopieren und entsprechend weiterverwenden.

Bild 1: Unter „API-Integration“ können Sie einen neuen API-Schlüssel erstellen oder bereits vorhandene Verbindungen auflösen.  

Bitte beachten Sie, dass der API-Schlüssel nur einmalig ausgegeben wird, damit eine Mehrfachnutzung ausgeschlossen werden kann.

3.1. API-Schlüssel deaktivieren 

Sollten Sie eine API-Verbindung nicht mehr benötigen, können Sie den entsprechenden API-Schlüssel unter „API-Tokens“ löschen. Klicken Sie dazu auf das Icon rechts neben dem entsprechenden Schlüssel (s.o. Bild 1.3.). Durch das Löschen werden alle hergestellten Schnittstellen entfernt und die Funktionalitäten mit sofortiger Wirkung eingestellt.

3.2. Sicherheit des API-Schlüssels 

Bitte beachten Sie, dass ein API-Schlüssel den vollständigen Zugriff auf Ihren Virtrex Account ermöglicht und daher bestens geschützt werden sollte. Zum Schutz des Schlüssels möchten wir Ihnen folgende Sicherheitshinweise mitgeben:

• Weisen Sie jeder API-Integration einen eigenen API-Schlüssel zu, welcher einen eigenen Namen bekommt. Der Name sollte der Integration entsprechen, damit Sie bei einer Deaktivierung den entsprechenden API-Schlüssel löschen können ohne andere Integrationen zu beeinflussen.

• Teilen Sie Ihren API-Schlüssel niemals öffentlich und ausschließlich mit befugten Mitarbeitenden.

• Senden Sie niemals einen API-Schlüssel per E-Mail, da sonst Hacker im Falle eines Angriffs Zugriff auf Ihre Datensätze erhalten.

• Sobald der Account Ihrer Marke gelöscht wird, werden alle dazugehörigen APIs und Webhooks entfernt.

4. Webhook-Integration 

Damit Sie die Webhook-Integration vornehmen können, benötigen Sie die entsprechenden Rechte. Wenn Sie über diese verfügen, gehen Sie in der linken Menüleiste Ihres Admin Panels auf „Settings“, öffnen dort den Bereich „Webhook-Integration“ und klicken den Button „Neuen Webhook erstellen“. Nachdem Sie Ihre Ziel-URL eingetragen haben, öffnet sich ein neues Fenster, in welchem Sie weitere Einstellungen vornehmen können. Die Funktionalitäten, die durch den Webhook gegeben werden, sind durch Virtrex vordefiniert (s.u. Bild 2). 

Bild 2: Hier sehen Sie, wie Sie einen Webhook erstellen.

Bitte beachten Sie, dass je nach externem System eine Passworteingabe notwendig ist (s.o. Bild 2).

5. Gut zu wissen 

Um eine API oder einen Webhook mit Ihren Software-Diensten zu verknüpfen, bedarf es innerhalb Ihres Unternehmens systemadministrativer Unterstützung.