📡 API PhishGuard Elite

Documentação para integração · Versão 1.0

Disponível para: Planos Advanced e Elite

Base URL: https://academia.mareginter.pt/api

🔐 Autenticação

Todos os pedidos à API requerem um token de autenticação no header:

Authorization: Bearer <SEU_TOKEN>

Como obter o token

POST /auth/token

Obter token de acesso com as credenciais do administrador.

Corpo do pedido:

{ "email": "admin@empresa.pt", "password": "senha_aqui" }

Resposta de sucesso:

{ "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...", "expires_in": 3600 }

👥 Colaboradores

GET /employees

Lista todos os colaboradores da empresa.

Resposta:

[ { "id": "uid-123456", "name": "João Silva", "email": "joao@empresa.pt", "xp": 850, "progress": { "1": { "completed": true, "score": 95 }, "2": { "completed": true, "score": 88 } } } ]

GET /employees/<id>

Detalhes de um colaborador específico.

POST /employees

Criar novo colaborador (com chave de ativação).

Corpo do pedido:

{ "name": "Ana Santos", "email": "ana@empresa.pt", "activationKey": "ABCD-EFGH-IJKL-MNOP" }

📊 Relatórios

GET /reports/company

Relatório consolidado da empresa (PDF em base64).

GET /reports/employee/<id>

Relatório individual do colaborador (PDF).

GET /reports/simulations

Relatório de simulações (Elite).

🔑 Chaves de Ativação

GET /keys

Lista todas as chaves da empresa.

POST /keys/generate

Gerar novas chaves.

Corpo do pedido:

{ "quantity": 5, "type": "basic" }

📈 KPIs (Elite)

GET /kpi/dashboard

Métricas avançadas da empresa.

Resposta:

{ "certificaveis": 15, "totalColaboradores": 20, "mediaModulos": 4.5, "ativos": 18, "taxaAcerto": 78 }

⚠️ Códigos de Erro

Código	Significado
400	Pedido inválido (dados em falta)
401	Não autenticado (token inválido)
403	Sem permissão (plano não suporta)
404	Recurso não encontrado
429	Muitos pedidos (rate limit)
500	Erro interno do servidor

📌 Exemplos

JavaScript (fetch)

const token = 'SEU_TOKEN_AQUI'; // Listar colaboradores fetch('https://academia.mareginter.pt/api/employees', { headers: { 'Authorization': `Bearer ${token}` } }) .then(response => response.json()) .then(data => console.log(data));

Python (requests)

import requests token = 'SEU_TOKEN_AQUI' headers = {'Authorization': f'Bearer {token}'} response = requests.get('https://academia.mareginter.pt/api/employees', headers=headers) print(response.json())