Autenticacao da API

Todos os pedidos a API do SilentShield requerem autenticacao. Existem dois metodos de autenticacao dependendo do endpoint.

Autenticacao por API Key

A maioria dos endpoints utiliza autenticacao por API key atraves do cabecalho X-Api-Key. A sua API key esta disponivel no painel em API Keys.

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

Utilize este metodo para: endpoints do widget, verificacao de nonce e chamadas API publicas.

Autenticacao JWT

Os endpoints do painel e de gestao utilizam autenticacao JWT (JSON Web Token). Obtenha um token iniciando sessao atraves do endpoint de autenticacao.

POST /api/v1/auth/login

Request Body:

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

Response:

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

Authorization: Bearer eyJhbGciOiJIUzI1NiIs...

Utilize este metodo para: endpoints de gestao, consultas de analise, gestao da equipa e definicoes da conta.

Erros de autenticacao

Status	Error	Solution
`401`	`missing credentials`	Adicione o cabecalho X-Api-Key ou Authorization.
`401`	`invalid_api_key`	Verifique se a sua API key esta correta e ativa.
`401`	`token_expired`	O seu JWT expirou. Solicite um novo token atraves de /api/v1/auth/login.
`403`	`insufficient_permissions`	A sua funcao nao tem acesso a este endpoint.

Limites de frequencia

Os pedidos a API sao limitados por endereco IP. O limite predefinido e de 60 pedidos por minuto para endpoints de gestao e 1000 pedidos por minuto para endpoints do widget. Os cabecalhos de limite de frequencia sao incluidos em cada resposta.

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