Kurzanleitung RuckusSmartzone-H API und Postman

Als erstes muss die aktuelle Version von Postman heruntergeladen werden (Links) zudem empfiehlt es sich noch die API-Dokumentation von Ruckus SmartZone geöffnet zu haben (Links).

Sobald man Postman installiert und gestartet hat erstellt man eine neue „Collection“. Dafür wählt man im Reiter „Collections“ den Button „New Collection“ aus. Den Namen kann man frei wählen, jedoch sollte dieser wenn möglich so Aussagekräftig sein wie möglich.
Als nächster Schritt müssen die Variablen Definiert werden, dies kann dann auf der rechten Seite auf dem „Zahnrad“ im Untermenü „Manage Environments“ definiert werden. Nun wird mittels eines Klick auf den Button „Add“ eine neue Variablensammlung definiert. In der Variablensammlung müssen folgende Werte erstellt und definiert werden:

VariableInitial ValueBemerkung
Content-Typeapplication/json;charset=UTF-8
hosthttps://IP-AdressedesvSZ-H:8443/wsg/api/publicJe nach Firmware ein andere Port
CookieJSESSIONID={JSESSIONID}
domainIDLEERWird zu einem späteren Zeitpunkt benötigt

Danach definiert man einen Namen für das erstellte Environment und speichert dies mittels eines Klick auf den Button „Add“.

Die erste Abfrage welche man an die API sendet ist das Login. Hierfür trägt man bei der Abfrage den folgenden Wert ein {{host}}/v6_0/session und wählt als Methode „Post“ aus. Nun müssen noch zwei „Header“-Informationen hinzugefügt werden. Hierfür wechselt man in den Reiter „Header“ und erstellt folgende „Heade“-Informationen:

KeyValue
Content-Typeapplication/json;charset=UTF-8
CookieJSESSIONID={JSESSIONID

Als nächster Schritt muss man die Anmeldedaten eintragen, hierfür wechselt man in den Reiter „Body“ und trägt folgenden Wert mit der Einstellung „raw“ ein:

{

  "username": "admin",

  "password": "Passwort",

  "timeZoneUtcOffset": "+02:00"

}

Wenn man die Einstellungen eingetragen hat, kann man die Anfrage absenden, hierfür muss man nur den Button „Send“ anklicken. Wenn alles korrekt verlaufen ist, bekommt man als Rückmeldung die Firmware-Version zurück. Zum Abschluss kann man die ganze Abfrage auch speichern.

Als nächsten Schritt werden die Zonen-IDs ermittelt, hierfür öffnet man einen neuen Tab. Als erstes werden die gleichen Header-Daten wie im vorherigen Schritt eingetragen. Danach wird als Anfrage folgender Wert eingetragen: {{host}}/v6_0/rkszones und als Methode wird „Get“ ausgewählt und mit „Send“ gesendet. Als Rückmeldung erhält man eine Liste mit folgenden wichtigen Werten: id und name Nun sucht man sich die Zone aus, an welcher man Veränderungen machen will aus und kopiert den „id“-Wert. Diesen Wert weisst man nun an der Variable „domainID“ zu.

Nun kann man ein Gastticket via API erstellen. Die erste Schritte sind gleich wie bei der ZonenID Ermittlung, nur wird in der Abfrage folgender Wert eingetragen: {{host}}/v6_0/identity/guestpass/generate und als Methode wird wieder „Post“ ausgewählt. Als nächstes muss man nun den „Body“ anpassen, hier mal ein Beispiel:

''{''

''  "domainId": "{{domainID}}",''

''  "guestName": "user100",''

''  "wlan": {''

''    "name": "Test2"''

''  },''

''  "zone": {''

''    "name": "Test"''

''  },''

''  "numberOfPasses": 1,''

''  "passValidFor": {''

''    "expirationValue": 15,''

''    "expirationUnit": "HOUR"''

''  },''

''  "autoGeneratedPassword": true,''

''  "passEffectSince": "CREATION_TIME",''

''  "passUseDays": 7,''

''  "maxDevices": {''

''    "maxDevicesAllowed": "LIMITED",''

''    "maxDevicesNumber": 3''

''  },''

''  "sessionDuration": {''

''    "requireLoginAgain": true,''

''    "sessionValue": 3,''

''    "sessionUnit": "DAY"''

''  },''

''  "remarks": "comment"''

''}''

Wenn man diese Werte eingetragen hat, kann man die Anfrage absenden, als Rückmeldung erhält man die ID des neuen Gastticket.

Diese Website verwendet Cookies. Durch die Nutzung der Website stimmen Sie dem Speichern von Cookies auf Ihrem Computer zu. Außerdem bestätigen Sie, dass Sie unsere Datenschutzbestimmungen gelesen und verstanden haben. Wenn Sie nicht einverstanden sind, verlassen Sie die Website.Weitere Information
  • ruckus/sz/api.txt
  • Zuletzt geändert: vor 15 Monaten