Documentação da API

Base URL: · Autenticação: Bearer JWT ou header X-API-Key

Autenticação

POST/auth/login

Retorna access_token e refresh_token.

POST/auth/register

Cria workspace + usuário owner.

GET/auth/me

Usuário, tenant e permissões.

Scans e descoberta

POST/vuln-scanner/start

Scan ofensivo de API (requer e-mail verificado + domínio verificado em produção).

POST/discovery/run

Descoberta de inventário (OpenAPI, enumeração, crawl).

GET/inventory/endpoints

Lista endpoints do inventário.

Findings e relatórios

GET/findings

Vulnerabilidades do workspace.

GET/reports/compliance/{framework}

PDF (HIPAA, PCI-DSS, NIST, LGPD, …).

POST/briefing/generate

Briefing executivo (IA).

Domínios e billing

GET/domains · POST/domains

Verificação de propriedade (DNS/HTTP).

GET/auth/billing/usage

Limites e consumo do plano.

POST/auth/billing/activate

Ativação manual de plano pago (admin).

LGPD

GET/auth/privacy/export

Exportação JSON dos dados do workspace.

POST/auth/privacy/delete-scan-data

Apaga findings, inventário e assets.

Status

GET/health · GET/status

Monitoramento público.

OpenAPI interativo disponível apenas com DEBUG=true em /docs.