A API REST do CaptiveWeb permite listar, buscar e gerenciar usuários e sessões programaticamente.

Autenticação

Todas as chamadas exigem o header Authorization: Bearer SEU_TOKEN. Gere o token em Configurações → API → Tokens.

Endpoints de usuários

GET /api/v1/users
  ?page=1&per_page=50
  ?location_id=loc_xxx
  ?search=email@exemplo.com

GET /api/v1/users/:id

DELETE /api/v1/users/:id

Resposta de listagem

{
  "data": [
    {
      "id": "usr_abc123",
      "name": "João Silva",
      "email": "joao@email.com",
      "phone": "+5511999999999",
      "location_id": "loc_xyz",
      "created_at": "2026-05-01T14:00:00Z",
      "last_seen_at": "2026-05-05T09:30:00Z"
    }
  ],
  "pagination": { "total": 1240, "page": 1, "per_page": 50 }
}

Endpoints de sessões

GET /api/v1/sessions
  ?user_id=usr_abc123
  ?location_id=loc_xxx
  ?started_after=2026-05-01T00:00:00Z
  ?active=true

GET /api/v1/sessions/:id

Encerrar sessão

DELETE /api/v1/sessions/:id

Encerra a sessão via RADIUS Disconnect-Request (CoA). O equipamento de rede deve suportar CoA na porta 3799.

ℹ️
Documentação completaConsulte o artigo API — Autenticação e primeiros passos para detalhes de autenticação e limites de rate.