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 administración (Admin Portal) de RADIUSaaS.

Antes de ejecutar cualquier llamada a la API que implique 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.

Autenticación

Para autenticar una llamada a la API REST, incluya en cada solicitud un Authorization header. Este encabezado debe contener un token de acceso:

Authorization: Bearer
               <Access Token>

Referencia de la API

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

• métodos HTTP disponibles,

• códigos de respuesta HTTP,

• esquemas JSON / datos de formulario para las solicitudes (cuerpos),

• esquemas JSON de los cuerpos de respuesta, y

• ejemplos de solicitud-respuesta para algunos puntos finales.

No es posible activar llamadas a la API directamente a través de la Referencia de la API.

Escenarios

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

La API REST puede utilizarse para automatizar la gestión de cuentas de nombre 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.

Un ejemplo de cómo usar la API REST para aprovisionar una cuenta de nombre de usuario/contraseña se puede encontrar en su Referencia de la API bajo los User puntos finales.

Implementar supervisión externa

Para supervisar la disponibilidad y el tiempo de actividad de su instancia RADIUSaaS con un sistema externo, o para supervisar la expiración de su certificado de servidor RADIUS, consulte la siguiente guía:

Monitorización externa

Ejemplos con cURL

En general, existen 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 dos ejemplos aquí:

JSON

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

curl -X "METHOD" "https://YOURNAME.radius-as-a-service.com/api/ROUTE/PATH" \
    -H 'Authorization: Bearer ACCESS_TOKEN' \
    -F 'KEY=VALUE'\
    -F 'KEY=VALUE'