Übersicht

Voraussetzungen

1. Schnittstelle in TOPIX einrichten

2. Erstellen eines API-Schlüssels in nexcore

3. API-Schlüssel und KEY-ID in TOPIX eintragen

4. Einrichtung von Webhooks

5. Zusammenfassung (Video)

Voraussetzungen für die Verbindung:

1. Aktiver TOPIX-Client.
2. Aktiver Zugang zu nexcore und die Berechtigung, die Seite "Developer" bearbeiten zu können.

1. Schnittstelle in TOPIX einrichten

• Navigiere in Deinem TOPIX-Client zu den Einstellungen

• Suche unter Schnittstellen den Eintrag "Nexato Nexcore" und klicke darauf

2. Erstellen eines API-Schlüssels in nexcore

1. Wechsle nun von TOPIX zu nexcore und navigiere dort unter den Einstellungen zum Bereich Developer.
2. Im Tab "API" findest Du im unteren Bereich die API-Key-Liste. Klicke dort auf den Button "API-Key erstellen"
   
   
3. Gib im nun erscheinenden PopUp-Fenster einen Kommentar bzw. einen Namen für den API-Key ein und klicke "API-Key erstellen"
   
   
   
4. Kopiere aus dem im Folgenden erscheinenden Fenster API Key und API Key-ID. 
   
   Achtung: Der API-Key wird einmal angezeigt. Beide Elemente werden für die Verbindung mit TOPIX benötigt.
   
   
5. Der neue angelegte API-Key Eintrag wird mit Deinem Kommentar und der API-ID nun in der API-Key-Liste angezeigt.

3. API-Schlüssel und KEY-ID in TOPIX eintragen

1. Wechsle nun zurück zu TOPIX.
2. Setze in das Feld "API-Schlüssel" (1) den soeben erstellten API-Key ein
3. Setze in das Feld "API-Key ID" (2) die passende API Key-ID aus nexcore ein
   
   
4. Klicke nun auf "Verbindung testen"
   
   
   
5. Wenn alles korrekt eingetragen wurde, erscheint folgende Meldung:
   
   

Die erfolgreiche Verbindung kannst Du auch in nexcore überprüfen:

1. Klicke dafür unter Einstellungen im Bereich Developer auf den Tab "Logs"
2. Dort sollte ein Eintrag mit dem Status "200 OK" vorhanden sein
3. Unter "Response Body" soll die Message "It works" angezeigt werden

✅ Damit hast Du die grundlegende Verbindung zwischen TOPIX und nexcore erfolgreich eingerichtet!

4. Einrichtung von Webhooks

Voraussetzungen:

• Eine valide Webhook-URL

Hier gibt es zwei Varianten:

1. Hast Du TOPIX als Cloud-Client, erhältst Du die URL von Deinem TOPIX-Berater
2. Hast Du TOPIX auf einem lokalen Server installiert (On-Premise), muss die notwendige URL von Deinem Admin zusammen mit Eurem TOPIX-Berater erstellt werden.
   
   Wichtig: die URL muss von außen d.h. über das Internet erreichbar sein und über ein gültiges SSL-Zertifikat verfügen.

Befolge die nachstehenden Schritte, um Events zu abonnieren und Webhooks zu testen:

1. Gib' im Feld "Webhook URL" (3) die URL ein
   
   
2. Klicke dann auf "Events abonnieren"
   
   
   
3. Bestätige im folgenden Fenster mit "OK"
   
   
   
4. Nach wenigen Sekunden sollte folgende Meldung angezeigt werden:
   
   
5. Klicke im Anschluss auf "Webhook" testen
   
   
6. Bestätige im folgenden Fenster mit "OK"
   
   
   
7. Nach wenigen Sekunden sollte folgende Meldung angezeigt werden:
   
   
8. Nun kannst Du die Einstellungen schließen

✅ Damit hast Du die Standard-Events erfolgreich abonniert!

Zusammenfassung aller Schritte (Kurzvideo)