> For the complete documentation index, see [llms.txt](https://docs.radiusaas.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.radiusaas.com/fr/autre/rest-api.md). # 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 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 d’en comprendre pleinement 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 en-tête HTTP `Authorization` avec chaque requête. Cet en-tête doit contenir un [jeton d’accès](/fr/portail-dadministration/acces-et-regles/permissions.md#access-tokens): ``` Authorization: Bearer ``` ## 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 de l’API, y compris * les méthodes HTTP disponibles, * les codes de réponse HTTP, * les schémas JSON / données de formulaire pour les requêtes (corps), * les schémas JSON des corps de réponse, et * des exemples de requête-réponse pour certains points de terminaison. {% hint style="info" %} Il n’est pas possible de déclencher des appels API directement via la référence de l’API. {% endhint %}
## Scénarios ### Gérer des comptes nom d’utilisateur/mot de passe pour le BYOD ou l’accès invité L’API REST peut être utilisée pour automatiser la gestion de comptes nom d’utilisateur/mot de passe pour des scénarios BYOD ou d’accès invité. 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 désactivation 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 la **Utilisateur** points de terminaison. ### Mettre en place une supervision externe Pour surveiller la disponibilité du service et le temps de fonctionnement 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 : {% 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 : soit des données de formulaire, soit du JSON. Vous pouvez déterminer quel type de média est requis dans la documentation de l’API. Si vous n’êtes pas familier avec la syntaxe curl, vous trouverez ici deux exemples : #### 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 $'{ DONNÉES JSON REQUISES. Consultez la documentation }' ``` #### Données de formulaire ```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 This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.radiusaas.com/fr/autre/rest-api.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. 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.