API REST

La documentation de l'API REST est disponible à l'adresse https://YOURNAME.radius-as-a-service.com/docs/api

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

Avant d'exécuter tout appel d'API entraînant un changement de configuration, assurez-vous de bien comprendre les implications. Une mauvaise utilisation de l'API peut casser la configuration de votre service.

Authentification

Pour authentifier un appel à l'API REST, remplissez un en-tête HTTP Authorization avec chaque requête. Cet en-tête doit contenir un jeton d'accès:

Authorization: Bearer
               <Jeton d'accès>

Référence API

La documentation de l'API contient une référence complète basée sur Swagger pour chaque point de terminaison API incluant

• méthodes HTTP disponibles,

• codes de réponse HTTP,

• schémas JSON / données de formulaire pour les requêtes (corps),

• schémas JSON des corps de réponse, et

• exemples requête-réponse pour certains points de terminaison.

Il n'est pas possible de déclencher des appels d'API directement via la Référence API.

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

Cela peut inclure le provisionnement automatique d'identifiants (WiFi) lors de l'intégration de nouveaux étudiants, locataires dans un espace de coworking, ... ainsi que la suppression 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 API sous les Utilisateur points de terminaison.

Mettre en œuvre une surveillance externe

Pour surveiller la disponibilité et le temps de fonctionnement (uptime) de votre instance RADIUSaaS avec un système externe, ou pour surveiller l'expiration de votre certificat de serveur RADIUS, veuillez vous référer au guide suivant :

Surveillance externe

Exemples cURL

En général, il existe deux types de contenu pour l'API REST : soit des données de formulaire, soit du JSON. Vous pouvez savoir quel type de média est requis dans la documentation de l'API.

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

JSON

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

Données de formulaire

curl -X "METHODE" "https://VOTRENOM.radius-as-a-service.com/api/ROUTE/PATH" \
    -H 'Authorization: Bearer JETON_D_ACCES' \
    -F 'CLE=VALEUR'\
    -F 'CLE=VALEUR'