Bitte lies' diese Anleitung zunächst mindestens einmal komplett durch
Voraussetzungen für die Verbindung:
- Aktiver TOPIX-Client
- Aktiver Zugang zu nexcore und die Berechtigung, die Seite "Developer" bearbeiten zu können
Bitte öffne beide Anwendungen und melde Dich an, da wir während der Einrichtung die Anwendungen wechseln
Befolge die nachstehenden Schritte, um Deinen TOPIX-Client mit nexcore zu verbinden:
- Navigiere in Deinem TOPIX-Client zu den Einstellungen
- Suche unter Schnittstellen den Eintrag "Nexato Nexcore" und klicke darauf
Die Felder API-Schlüssel, API-Key ID und ggf. Webhook URL sind bei der Ersteinrichtung leer
Nun wechsele bitte zu nexcore
Erstellen eines API-Schlüssels
- Navigiere zu "Einstellungen" > "Developer"
- Klicke den Button "API-Key anlegen"
- Gib einen Kommentar bzw. einen Namen für den API-Key ein und klicke "Speichern"
- Kopiere im folgenden Fenster API Key und API Key-ID und speichere diese zur späteren Verwendung an einem sicheren Ort
- Achtung: Der API Key wird einmal angezeigt. Beide Elemente werden für die Verbindung mit TOPIX benötigt
- Der neue angelegte API-Key Eintrag wird mit Deinem Kommentar und der API Key-ID angezeigt
Nun wechsele bitte zu TOPIX zurück
- Setze in das Feld "API-Schlüssel" (1) unseren soeben erstellten API Key ein
- Setze in das Feld "API-Key ID" (2) die passende API Key-ID aus nexcore ein
- Klicke nun auf "Verbindung testen"
- Wenn alles korrekt eingetragen wurde, erscheint folgende Meldung:
Sollte der Test nicht erfolgreich sein, prüfe bitte, ob die richtigen Werte in die Felder eingetragen wurden (Vertauscht?)
Die erfolgreiche Verbindung kannst Du auch in nexcore überprüfen:
- Klicke dafür im Bereich "Developer" auf den Tab "Logs"
- Dort sollte ein Eintrag mit dem Status "200 OK" vorhanden sein
- Unter "Response Body" soll die Message "It works" angezeigt werden
Damit hast Du die grundlegende Verbindung zwischen TOPIX und nexcore erfolgreich eingerichtet!
Möchtest Du noch Events abonnieren, lies bitte weiter
Voraussetzungen:
- Eine valide Webhook URL
Hier gibt es zwei Varianten:
- Hast Du TOPIX als Cloud-Client, erhältst Du die URL von Deinem TOPIX-Berater
- 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 (Internet) erreichbar sein und über ein gültiges SSL-Zertifikat verfügen
Bei Fragen dazu, wende Dich bitte an Deinen TOPIX-Berater
Befolge die nachstehenden Schritte, um Events zu abonnieren und Webhooks zu testen:
- Gib' im Feld "Webhook URL" (3) die URL ein
- Klicke dann auf "Events abonnieren"
- Bestätige im folgenden Fenster mit "OK"
- Nach wenigen Sekunden sollte folgende Meldung angezeigt werden:
- Klicke im Anschluss auf "Webhook" testen
- Bestätige im folgenden Fenster mit "OK"
- Nach wenigen Sekunden sollte folgende Meldung angezeigt werden:
- Nun kannst Du die Einstellungen schließen
Damit hast Du die Standard-Events erfolgreich abonniert!
Zusammenfassung aller Schritte als Kurzvideo
