REST-API

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

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

Bevor Sie einen API-Aufruf ausführen, der eine Konfigurationsänderung zur Folge hat, stellen Sie sicher, dass Sie die Auswirkungen vollständig verstehen. Unsachgemäße Verwendung der API kann die Konfiguration Ihres Dienstes beschädigen.

Authentifizierung

Um einen Aufruf der REST-API zu authentifizieren, fügen Sie jeder Anfrage einen HTTP Authorization Header hinzu. Dieser Header muss ein gültiges access token:

Authorization: Bearer
               <Access Token>

API-Referenz

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

• verfügbarer 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

Verwaltung von Benutzername/Passwort-Konten für BYOD- oder Gastzugänge

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

Dies kann die automatische Bereitstellung von (WLAN-)Zugangsdaten während der Onboarding-Phase neuer Studierender, Mieter in einem Coworking-Space usw. sowie die automatische Stilllegung dieser Konten umfassen.

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

Externes Monitoring implementieren

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

Externes Monitoring

cURL-Beispiele

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

Wenn 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. Werfen Sie einen Blick in die Dokumentation
        }'

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'