Autenticacao da API

Todos os pedidos à API do SilentShield requerem autenticação. Existem dois métodos de autenticação, consoante o endpoint.

Autenticacao por API Key

A maioria dos endpoints utiliza autenticação por API key através do cabeçalho X-Api-Key. A sua API key está disponível no painel em API Keys.

X-Api-Key: your-api-key-here

Utilize este método para: endpoints do widget, verificação de nonce e chamadas API públicas.

Autenticacao JWT

Os endpoints do painel e de gestão utilizam autenticação JWT (JSON Web Token). Obtenha um token iniciando sessão através do endpoint de autenticação.

POST /api/v1/auth/login

Request Body:

{"email": "[email protected]", "password": "your-password"}

Response:

{"token": "eyJhbGciOiJIUzI1NiIs...", "expiresIn": 86400}

Authorization: Bearer eyJhbGciOiJIUzI1NiIs...

Utilize este método para: endpoints de gestão, consultas de análise, gestão da equipa e definições da conta.

Erros de autenticacao

Status	Error	Solution
`401`	`missing_api_key`	Adicione o cabeçalho X-Api-Key ou Authorization.
`401`	`invalid site key`	Verifique se a sua API key está correta e ativa.
`401`	`token_expired`	O seu JWT expirou. Solicite um novo token através de /api/v1/auth/login.
`403`	`insufficient_permissions`	A sua função não tem acesso a este endpoint.

Limites de frequência

Os pedidos à API são limitados por chave API e por endpoint. Quantos pedidos por minuto são permitidos depende do seu plano — os valores estão na página de preços. Cada resposta inclui os cabeçalhos de limite.

X-RateLimit-Limit
X-RateLimit-Remaining
X-RateLimit-Reset
Retry-After (apenas em 429)