# API REST

RADIUSaaS expose une API REST qui vous permet d’automatiser la plupart des actions qui devraient autrement être effectuées via l’interface utilisateur du portail d’administration RADIUSaaS.

{% hint style="warning" %}
Avant d’exécuter tout appel d’API entraînant une modification de configuration, assurez-vous de bien comprendre toutes les implications. Une utilisation incorrecte de l’API peut endommager la configuration de votre service.
{% endhint %}

## Authentification

Pour authentifier un appel à l’API REST, renseignez un HTTP `Authorization` en-tête avec chaque requête. Cet en-tête doit contenir un [jeton d’accès](/fr/portail-dadministration/settings/permissions.md#access-tokens):

```
Authorization: Bearer
               <Access Token>
```

## Référence de l’API

La documentation de l’API contient une référence complète de l’API basée sur Swagger pour chaque point de terminaison d’API, y compris

* les méthodes HTTP disponibles,
* les codes de réponse HTTP,
* les schémas JSON / les données de formulaire pour les requêtes (corps),
* les schémas JSON des corps de réponse, et
* des exemples requête-réponse pour certains points de terminaison.

{% hint style="info" %}
Il n’est pas possible de déclencher directement des appels d’API via la Référence de l’API.
{% endhint %}

<figure><img src="/files/0d22fe35612ac1b40889b1bec26fec5d77ff59fa" alt=""><figcaption></figcaption></figure>

## Scénarios

### Gérer des comptes nom d’utilisateur/mot de passe pour BYOD ou l’accès invité

L’API REST peut être utilisée pour automatiser la gestion des comptes nom d’utilisateur/mot de passe pour les scénarios BYOD ou d’accès invité.&#x20;

Cela peut inclure le provisionnement automatique d’identifiants (Wi‑Fi) lors de l’intégration de nouveaux étudiants, de locataires dans un espace de coworking, ... ainsi que la mise hors service automatique de ces comptes.

Un exemple d’utilisation de l’API REST pour provisionner un compte nom d’utilisateur/mot de passe se trouve dans votre Référence de l’API sous les **Utilisateur** points de terminaison.

### Mettre en place une supervision externe

Pour surveiller la disponibilité et le temps de fonctionnement de votre instance RADIUSaaS avec un système externe, ou pour surveiller l’expiration du certificat de votre serveur RADIUS, veuillez vous reporter au guide suivant :

{% content-ref url="/pages/00d46faa7fa162126b7ceb3d9296d02f97c8a500" %}
[Surveillance externe](/fr/autre/rest-api/surveillance-externe.md)
{% endcontent-ref %}

## Exemples cURL

En général, il existe deux types de contenu différents pour l’API REST : des données de formulaire ou du JSON. Vous pouvez déterminer le type de média requis dans la documentation de l’API.&#x20;

Si vous n’êtes pas familier avec la syntaxe curl, vous pouvez trouver deux exemples ici :

#### JSON

```bash
curl -X "MÉTHODE" "https://VOTRENOM.radius-as-a-service.com/api/ROUTE/CHEMIN" \
    -H 'Authorization: Bearer ACCESS_TOKEN' \
    -H 'Content-Type: application/json' \
    -d $'{
            DONNÉES JSON NÉCESSAIRES. Consultez la documentation
        }'
```

#### Données de formulaire

```bash
curl -X "MÉTHODE" "https://VOTRENOM.radius-as-a-service.com/api/ROUTE/CHEMIN" \
    -H 'Authorization: Bearer ACCESS_TOKEN' \
    -F 'CLÉ=VALEUR'\
    -F 'CLÉ=VALEUR'
```


---

# 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/fr/autre/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.