REST API

Die REST API-Dokumentation ist unter https://YOURNAME.radius-as-a-service.com/docs/api verfügbar

RADIUSaaS stellt eine REST-API bereit, mit der Sie die meisten Aktionen automatisieren können, die sonst über die RADIUSaaS Admin Portal UI ausgeführt werden müssten.

Bevor Sie einen API-Aufruf ausführen, der zu einer Konfigurationsänderung führt, stellen Sie sicher, dass Sie die Auswirkungen vollständig verstehen. Eine falsche Verwendung der API kann die Konfiguration Ihres Dienstes beschädigen.

Authentifizierung

Um einen Aufruf an die REST-API zu authentifizieren, fügen Sie einen HTTP Authorization Header mit jeder Anfrage hinzu. Dieser Header muss ein gültiges Zugriffstoken:

Authorization: Bearer
               <Access Token>

API-Referenz

Die API-Dokumentation enthält eine vollständige Swagger-basierte API-Referenz für jeden API-Endpunkt, einschließlich

• verfügbaren HTTP-Methoden,

• HTTP-Antwortcodes,

• JSON-Schemata / Formulardaten für Anfragen (Bodies),

• JSON-Schemata der Antwort-Bodies und

• Anfrage-Antwort-Beispiele für einige Endpunkte.

Es ist nicht möglich, API-Aufrufe direkt über die API-Referenz auszulösen.

Szenarien

Benutzername-/Passwortkonten für BYOD- oder Gastzugang verwalten

Die REST-API kann verwendet werden, um die Verwaltung von Benutzername-/Passwortkonten für BYOD- oder Gastzugangsszenarien zu automatisieren.

Dies kann die automatische Bereitstellung von (WLAN-)Zugangsdaten während des Onboardings neuer Studierender, Mieter in einem Coworking-Space, ... sowie die automatische Außerbetriebnahme dieser Konten umfassen.

Ein Beispiel dafür, wie die REST-API zur Bereitstellung eines Benutzername-/Passwortkontos verwendet werden kann, finden Sie in Ihrer API-Referenz unter den Benutzer Endpunkten.

Externe Überwachung implementieren

Um die Serviceverfügbarkeit und Betriebszeit Ihrer RADIUSaaS-Instanz mit einem externen System zu überwachen oder den Ablauf Ihres RADIUS-Serverzertifikats zu überwachen, lesen Sie bitte die folgende Anleitung:

Externe Überwachung

cURL-Beispiele

Im Allgemeinen gibt es zwei verschiedene Inhaltstypen für die REST-API, entweder Formulardaten oder JSON. In der API-Dokumentation erfahren Sie, welcher Medientyp erforderlich ist.

Falls Sie mit der curl-Syntax nicht vertraut sind, finden Sie hier zwei Beispiele:

JSON

curl -X "METHOD" "https://YOURNAME.radius-as-a-service.com/api/ROUTE/PATH" \
    -H 'Authorization: Bearer ACCESS_TOKEN' \
    -H 'Content-Type: application/json' \
    -d $'{
            ERFORDERLICHE JSON-DATEN. Schauen Sie in der Dokumentation nach
        }'

Formulardaten

curl -X "METHOD" "https://YOURNAME.radius-as-a-service.com/api/ROUTE/PATH" \
    -H 'Authorization: Bearer ACCESS_TOKEN' \
    -F 'KEY=VALUE'\
    -F 'KEY=VALUE'