# REST API

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.

{% hint style="warning" %}
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.
{% endhint %}

## 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](/de/admin-portal/settings/permissions.md#access-tokens):

```
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.

{% hint style="info" %}
Es ist nicht möglich, API-Aufrufe direkt über die API-Referenz auszulösen.
{% endhint %}

<figure><img src="/files/23f1f5943f0fdf9b6a71a617f28f402a8c794b74" alt=""><figcaption></figcaption></figure>

## 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.&#x20;

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:

{% content-ref url="/pages/e861a11d86a0393932647f1c4091552eefbb40a2" %}
[Externe Überwachung](/de/andere/rest-api/externe-uberwachung.md)
{% endcontent-ref %}

## 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.&#x20;

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

#### JSON

```bash
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

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


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.radiusaas.com/de/andere/rest-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.