REST API

La documentación de la REST API 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 API que conduzca 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.

Autenticación

Para autenticar una llamada a la API REST, complete un HTTP Authorization header con cada solicitud. Este encabezado debe contener un access token:

Authorization: Bearer
               <Access Token>

Referencia de la API

La documentación de la API contiene una referencia completa 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 las solicitudes (cuerpos),

• esquemas JSON de los cuerpos de respuesta, y

• ejemplos de solicitud-respuesta para algunos endpoints.

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

Escenarios

Gestionar 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 sobre cómo usar la API REST para aprovisionar una cuenta de nombre de usuario/contraseña puede encontrarse en su Referencia de la API bajo los Usuario endpoints.

Implementar monitoreo externo

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:

Monitoreo externo

Ejemplos cURL

En general, hay dos tipos de contenido diferentes para la API REST, o 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'