REST API

A documentação da REST API está disponível em https://YOURNAME.radius-as-a-service.com/docs/api

RADIUSaaS expõe uma API REST que permite automatizar a maioria das ações que, de outra forma, teriam de ser executadas através da interface do Portal de Administração do RADIUSaaS.

Antes de executar qualquer chamada de API que leve a uma alteração de configuração, certifique-se de compreender completamente as implicações. O uso incorreto da API pode quebrar a configuração do seu serviço.

Autenticação

Para autenticar uma chamada à API REST, preencha um cabeçalho HTTP Authorization com cada solicitação. Este cabeçalho deve conter um token de acesso:

Authorization: Bearer
               <Token de Acesso>

Referência da API

A documentação da API contém uma referência completa baseada em Swagger para cada endpoint da API, incluindo

• métodos HTTP disponíveis,

• códigos de resposta HTTP,

• esquemas JSON / dados de formulário para requisições (corpos),

• esquemas JSON dos corpos de resposta, e

• exemplos de requisição-resposta para alguns endpoints.

Não é possível acionar chamadas de API diretamente através da Referência da API.

Cenários

Gerenciar Contas de Nome de Usuário/Senha para BYOD ou Acesso de Convidados

A API REST pode ser usada para automatizar o gerenciamento de contas de nome de usuário/senha para cenários de BYOD ou acesso de convidados.

Isso pode incluir o provisionamento automático de credenciais (WiFi) durante a integração de novos estudantes, inquilinos em um espaço de coworking, ... assim como a aposentadoria automática dessas contas.

Um exemplo de como usar a API REST para provisionar uma conta de nome de usuário/senha pode ser encontrado em sua Referência da API sob os endpoints de Usuário endpoints.

Implementar Monitoramento Externo

Para monitorar a disponibilidade do serviço e o tempo de atividade da sua instância RADIUSaaS com um sistema externo, ou para monitorar o vencimento do Certificado do Servidor RADIUS, consulte o seguinte guia:

Monitoramento Externo

Exemplos cURL

Em geral, existem dois tipos de conteúdo diferentes para a API REST, dados de formulário ou JSON. Você pode descobrir qual tipo de mídia é exigido na documentação da API.

Se você não está familiarizado com a sintaxe do curl, pode encontrar dois exemplos aqui:

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 $'{
            DADOS JSON NECESSÁRIOS. Dê uma olhada na documentação
        }'

Dados de Formulário

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