Endpoints da API¶

Documentacao detalhada dos principais endpoints da API REST.

Monitoring¶

Listar Monitors¶

GET /api/v1/monitoring/

Parametros de Query:

Parametro	Tipo	Descricao
`search`	string	Busca por nome ou keywords
`status`	string	Filtro por status: `active`, `paused`, `error`
`ordering`	string	Ordenacao: `created_at`, `-created_at`, `name`
`page`	integer	Numero da pagina (paginacao)
`page_size`	integer	Itens por pagina (default: 20, max: 100)

Response (200):

{
  "count": 42,
  "next": "https://dashboard.oodaintel.com/api/v1/monitoring/?page=2",
  "previous": null,
  "results": [
    {
      "uuid": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Monitor Dominio Principal",
      "keywords_count": 5,
      "frequency": "1h",
      "status": "active",
      "last_run": "2026-03-19T10:30:00Z",
      "alerts_count": 12,
      "created_at": "2026-01-15T08:00:00Z"
    }
  ]
}

Criar Monitor¶

POST /api/v1/monitoring/

Body:

{
  "name": "Novo Monitor",
  "keywords": ["keyword1", "keyword2"],
  "frequency": "1h",
  "alerts": {
    "email": true,
    "slack": false,
    "webhook": null
  }
}

Keywords Encriptadas

As keywords sao armazenadas criptografadas com Fernet. A API aceita e retorna texto plano, a criptografia e transparente.

Data Leaks¶

Buscar Vazamentos¶

GET /api/v1/leaks/search/?q=dominio.com.br

Parametros:

Parametro	Tipo	Descricao
`q`	string	Obrigatorio. Termo de busca
`type`	string	Tipo: `credential`, `card`, `document`
`date_from`	date	Data inicial (YYYY-MM-DD)
`date_to`	date	Data final (YYYY-MM-DD)

Incidents¶

Criar Incidente¶

POST /api/v1/incidents/

Body:

{
  "title": "Phishing detectado",
  "severity": "high",
  "description": "Pagina de phishing imitando o login corporativo",
  "iocs": [
    {
      "type": "url",
      "value": "https://phishing-site.example.com/login"
    },
    {
      "type": "ip",
      "value": "192.168.1.100"
    }
  ],
  "assigned_to": "user-uuid-here"
}

Paginacao¶

Todos os endpoints de listagem usam paginacao com os parametros page e page_size:

GET /api/v1/monitoring/?page=2&page_size=50

Filtros e Ordenacao¶

A maioria dos endpoints suporta:

search - Busca textual
ordering - Ordenacao (prefixe com - para descendente)
Filtros especificos - Variam por endpoint

Codigos de Status¶

Codigo	Significado
`200`	Sucesso
`201`	Criado com sucesso
`400`	Requisicao invalida
`401`	Nao autenticado
`403`	Sem permissao
`404`	Nao encontrado
`429`	Rate limit excedido
`500`	Erro interno