REST-API-Dokumentation

In der Kopfzeile unter Hilfe > REST-API-Dokumentation finden Sie eine automatisch generierte Dokumentation der REST-API.





Die Dokumentation wird in einem separaten Tab geöffnet mit der derzeit verwendeten Adresse für den Web-Client-Zugriff als Server.

Anmerkung: Die API kann sich ändern und die Dokumentation kann in Teilen auch unvollständig sein.

Sie können die Server-Variable auch ändern und somit eine andere Firewall referenzieren. Dies wird nicht empfohlen, da verschiedene Geräte mit unterschiedlichen Firmware-Versionen arbeiten und daher unterschiedliche APIs bereitstellen können.





Das Ausführen eines API-Requests gegen eine Firewall benötigt einen Auth-Token, den der Benutzer nach einem erfolreichen Login erhält. Dieses Token kann auf folgende Weise erhalten werden: Unter der Kategorie Authentication der API-Dokumentation ist auch der Login-Endpunkt enthalten, in dem Sie mit Try it out einen Login durchführen und so den Auth-Token erhalten kann. Das Feld token in der Antwort nach erfolgreichem Login enthält das Token.





Ist das Auth-Token vorhanden, kann jetzt über die Schaltfläche Authorize der Wert eingetragen werden.









Danach sollten alle in der Dokumentation aufgeführten Requests gegen die angegebene Firewall ausgeführt werden können.

www.lancom-systems.de

LANCOM Systems GmbH | A Rohde & Schwarz Company | Adenauerstr. 20/B2 | 52146 Würselen | Deutschland | E‑Mail info@lancom.de

LANCOM Logo