Phishing: Campanhas GoPhish
GET /phishing/campaigns
Lista campanhas de phishing do tenant (máx. 100, ordenadas por createdAt desc).
Query params: status (PhishingCampaignStatus, ex. DRAFT | ACTIVE | COMPLETED)
POST /phishing/campaigns
Criar nova campanha. Requer que o tenant tenha pelo menos um utilizador ADMIN (usado como criador).
Body:
{
"title": "Campanha Q3 2026",
"description": "Simulação de phishing trimestral",
"template": "office365-login",
"targetCount": 50,
"scheduledAt": "2026-07-10T09:00:00Z",
"targets": [
{ "email": "joao@empresa.pt", "first_name": "João", "last_name": "Silva", "position": "Analista" }
]
}
GET /phishing/campaigns/:id
Detalhe de uma campanha (inclui contadores clickCount/reportedCount).
PATCH /phishing/campaigns/:id
Atualizar campanha (title, description, template, targetCount, scheduledAt, targets).
DELETE /phishing/campaigns/:id
Eliminar campanha.
POST /phishing/webhook
Endpoint de ingestão de eventos GoPhish (mensagens que incluam clicked, reported ou campaign complete, associadas por campaign_id ao gophishCampaignId guardado no EterShield).
Autenticação: Assinatura HMAC-SHA256 no header X-Gophish-Signature: sha256=<hex>, calculada sobre o corpo raw do pedido e validada. Fail-closed: se o segredo do webhook não estiver configurado, ou a assinatura for inválida/ausente, responde 401.
POST /api/v1/phishing/webhook
X-Gophish-Signature: sha256=<hmac-hex>
Content-Type: application/json
[
{ "campaign_id": 42, "message": "Clicked Link", "email": "joao@empresa.pt" }
]
Resposta:
{ "ok": true, "updated": 1 }
POST /phishing/campaigns/:id/launch
Lança uma campanha no GoPhish (cria o grupo de alvos e a campanha, e ativa-a).
Autenticação: ao contrário do resto desta secção, este endpoint não usa x-api-key, requer sessão de browser autenticada com role ADMIN ou MANAGER. É consumido pelo próprio dashboard.
Body: { "template": "...", "landingPage": "...", "sendingProfile": "...", "launchDate": "...", "sendByDate": "..." } (launchDate/sendByDate opcionais). Rate limit: 10/min.
Respostas: 409 se a campanha já foi lançada · 422 se não tiver destinatários · 502 em erro do GoPhish.