# API REST

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 provoque un cambio de configuración, asegúrese de comprender plenamente 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` header con cada solicitud. Este encabezado debe contener un [token de acceso](/es/portal-de-administracion/settings/permissions.md#access-tokens):

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

## Referencia de la API

La documentación de la API contiene una referencia completa de la API basada en Swagger para cada endpoint de la API, incluyendo

* métodos HTTP disponibles,
* 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 endpoints.

{% hint style="info" %}
No es posible activar llamadas a la API directamente a través de la Referencia de la API.
{% endhint %}

<figure><img src="/files/9489e283c2d4755ff01f40e15c11d92f9c47343d" alt=""><figcaption></figcaption></figure>

## Escenarios

### Administrar cuentas de usuario/contraseña para BYOD o acceso de invitados

La API REST se puede utilizar para automatizar la administración de cuentas de usuario/contraseña para escenarios de BYOD o acceso de invitados.&#x20;

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 baja automática de esas cuentas.

Puede encontrar un ejemplo sobre cómo usar la API REST para aprovisionar una cuenta de usuario/contraseña en su Referencia de la API, en los **Usuario** endpoints.

### Implementar monitorización externa

Para monitorizar la disponibilidad del servicio y el tiempo de actividad de su instancia de RADIUSaaS con un sistema externo, o para monitorizar 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 distintos para la API REST: datos de formulario o JSON. Puede averiguar qué tipo de medio se requiere en la documentación de la API.&#x20;

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: 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/es/otro/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.