> 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/es/otro/rest-api.md). # API REST La documentación de la API REST está disponible en https\://YOURNAME.radius-as-a-service.com/docs/api RADIUSaaS expone una API REST que le permite automatizar la mayoría de las acciones que de otro modo tendrían que realizarse a través de la interfaz de usuario del Portal de administración de RADIUSaaS. {% hint style="warning" %} Antes de ejecutar cualquier llamada a la API que lleve a un cambio de configuración, asegúrese de comprender completamente las implicaciones. El uso incorrecto de la API puede romper la configuración de su servicio. {% endhint %} ## Autenticación Para autenticar una llamada a la API REST, incluya un HTTP `Authorization` en el encabezado con cada solicitud. Este encabezado debe contener un [token de acceso](/es/portal-de-administracion/acceso-y-reglas/permissions.md#access-tokens): ``` Authorization: Bearer ``` ## Referencia de la API La documentación de la API contiene una referencia completa de la API basada en Swagger para cada punto de conexión de la API, incluidas * los métodos HTTP disponibles, * los códigos de respuesta HTTP, * esquemas JSON / datos de formulario para la solicitud (cuerpos), * esquemas JSON de los cuerpos de respuesta, y * ejemplos de solicitud-respuesta para algunos puntos de conexión. {% hint style="info" %} No es posible activar llamadas a la API directamente a través de la Referencia de la API. {% endhint %}
## Escenarios ### Administrar cuentas de usuario/contraseña para BYOD o acceso de invitados La API REST puede utilizarse para automatizar la gestión de cuentas de usuario/contraseña para escenarios de BYOD o acceso de invitados. Esto puede incluir el aprovisionamiento automático de credenciales (WiFi) durante la incorporación de nuevos estudiantes, inquilinos en un espacio de coworking, ... así como la retirada automática de esas cuentas. Puede encontrar un ejemplo de cómo usar la API REST para aprovisionar una cuenta de usuario/contraseña en su Referencia de la API bajo el **Usuario** extremos. ### Implementar monitoreo externo Para supervisar la disponibilidad del servicio y el tiempo de actividad de su instancia de RADIUSaaS con un sistema externo, o para supervisar la expiración del certificado de su servidor RADIUS, consulte la siguiente guía: {% content-ref url="/pages/421b1d61dd93d0db453060061f9db268bdc4492a" %} [Supervisión externa](/es/otro/rest-api/supervision-externa.md) {% endcontent-ref %} ## Ejemplos de cURL En general, hay dos tipos de contenido diferentes para la API REST: datos de formulario o JSON. Puede averiguar qué tipo de medio se requiere en la documentación de la API. Si no está familiarizado con la sintaxis de curl, puede encontrar aquí dos ejemplos: #### 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 $'{ DATOS JSON NECESARIOS. Consulte la documentación }' ``` #### Datos de formulario ```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/es/otro/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.