API REST

A documentação da API REST 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 de utilizador do RADIUSaaS Admin Portal.

Antes de executar qualquer chamada de API que resulte numa alteração de configuração, certifique-se de que compreende totalmente as implicações. A utilização incorreta da API pode comprometer a configuração do seu serviço.

Autenticação

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

Authorization: Bearer
               <Access Token>

Referência da API

A documentação da API contém uma referência completa da API 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 o pedido (corpos),
• esquemas JSON dos corpos de resposta, e
• exemplos de pedido-resposta para alguns endpoints.

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

Cenários

Gerir contas de nome de utilizador/palavra-passe para BYOD ou acesso de convidados

A API REST pode ser utilizada para automatizar a gestão de contas de nome de utilizador/palavra-passe para cenários de BYOD ou de acesso de convidados.

Isto pode incluir o aprovisionamento automático de credenciais (WiFi) durante o registo de novos estudantes, inquilinos num espaço de coworking, ... bem como a desativação automática dessas contas.

Um exemplo de como utilizar a API REST para aprovisionar uma conta de nome de utilizador/palavra-passe pode ser encontrado na sua Referência da API, em Utilizador endpoints.

Implementar monitorização externa

Para monitorizar a disponibilidade do serviço e o tempo de atividade da sua instância RADIUSaaS com um sistema externo, ou para monitorizar a expiração do certificado do seu servidor RADIUS, consulte o seguinte guia:

Monitorização externa

Exemplos de cURL

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

Se não estiver 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. Consulte a 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 'KEY=VALUE'\
    -F 'KEY=VALUE'