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.

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.

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:

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.

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

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.

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:

Monitoreo externo

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.

Si no está familiarizado con la sintaxis de curl, puede encontrar aquí dos ejemplos:

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'