A API REST do CaptiveWeb permite integrar o sistema com plataformas externas, automatizar operações e criar integrações customizadas.

ℹ️
Base URLTodas as chamadas à API usam: https://sistema.captiveweb.com.br/api/

1. Autenticação na API

A API usa autenticação por Bearer Token. Para obter seu token:

  1. Acesse Configurações → API

    No painel do CaptiveWeb, vá em Configurações → Integrações → API.

  2. Gere um token

    Clique em "Gerar novo token de API". Guarde-o em local seguro — ele não será exibido novamente.

2. Sua primeira chamada

curl -X GET https://sistema.captiveweb.com.br/api/health \
  -H "Authorization: Bearer SEU_TOKEN_AQUI" \
  -H "Content-Type: application/json"

Resposta esperada:

{"status": "ok", "services": {"postgres": true, "redis": true}}

3. Principais endpoints

MétodoEndpointDescrição
GET/api/users/Listar usuários cadastrados
GET/api/sessions/Listar sessões ativas
POST/api/vouchers/Criar voucher
GET/api/vouchers/Listar vouchers
DELETE/api/vouchers/{id}/Invalidar voucher
GET/api/reports/access/Relatório de acessos

4. Rate limiting

A API permite 1.000 requisições por hora por token. Exceder esse limite retorna HTTP 429.

⚠️
SegurançaNunca exponha seu token de API no código frontend (JavaScript do navegador). Use sempre server-side.