N‑central bietet mit der Version 2023.9 erstmals moderne REST‑APIs an – noch intuitiver und wartungsfreundlicher im Vergleich zu älteren SOAP‑APIs. Mit dem integrierten API-Explorer können Sie diese ohne großes API-Vorwissen bedienen, um Informationen Ihrer Agents bzw. Ihres Servers abzufragen oder zu konfigurieren.
Dieser Artikel hilft Ihnen dabei, den API-Only-Benutzer zu erstellen und die API erfolgreich zu verwenden.
1.1 Melden Sie sich zunächst an Ihrem N-central-Server als Administrator an.
1.2 Navigieren Sie über die Menüleiste links auf die Punkte Administration → User Management → Users.
1.4 Zudem benötigt der User folgende Konfiguration:
Tipp: Der API-Only-User-Zugriff verhindert den Zugriff auf die N-central-UI. Dies ist besonders wichtig, da die 2-Faktor-Authentifizierung deaktiviert wurde.
1.5 Bestätigen Sie anschließend mit "Save".
Sobald der User erstellt wurde, wählen Sie diesen über die E-Mail-Adresse aus und wechseln auf den Reiter API-Access.
1.6 Erstellen Sie nun ein JSON Web Token und speichern Sie sich diesen ab.
2.1 Um den API Explorer zu öffnen, wählen Sie in der Menüleiste unter "My Links" den Punkt API Explorer aus. Alternativ können Sie diesen erreichen, indem Sie Ihrer N-central-FQDN die Endung "/api-explorer" anhängen.
2.2 Scrollen Sie etwas nach unten, bis Sie auf einen grünen Authorize-Button stoßen. Wenn Sie ihn gefunden haben, öffnen Sie ihn und tragen Sie den zuvor erstellten JSON Web Token in das erste freie Feld ein. Bestätigen Sie dies anschließend mit "Authorize".
2.3 Navigieren Sie jetzt zu folgendem API-Befehl: Authentication → Try it out → Execute.
2.4 Als Antwort sollten Sie einen Code 200 mit einem Token des Typs Bearer erhalten.
2.5 Kopieren Sie diesen Token und fügen Sie ihn anschließend wieder über den Authorize-Button im freien Feld unten ein. Bestätigen Sie dies erneut mit "Authorize".
Die Authentifizierung an der API ist jetzt abgeschlossen und Sie können alle Funktionen des API-Explorers verwenden.