Autenticazione API

Tutte le richieste API a SilentShield richiedono l'autenticazione. Esistono due metodi di autenticazione a seconda dell'endpoint.

Autenticazione tramite API Key

La maggior parte degli endpoint utilizza l'autenticazione tramite API key attraverso l'intestazione X-Api-Key. La tua API key è disponibile nel pannello sotto API Keys.

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

Usa questo metodo per: endpoint del widget, verifica del nonce e chiamate API pubbliche.

Autenticazione JWT

Gli endpoint del pannello e di gestione utilizzano l'autenticazione JWT (JSON Web Token). Ottieni un token effettuando l'accesso tramite l'endpoint di autenticazione.

POST /api/v1/auth/login

Request Body:

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

Response:

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

Usa questo metodo per: endpoint di gestione, query di analisi, gestione del team e impostazioni dell'account.

Errori di autenticazione

StatusErrorSolution
401missing credentialsAggiungi l'intestazione X-Api-Key o Authorization.
401invalid_api_keyVerifica che la tua API key sia corretta e attiva.
401token_expiredIl tuo JWT è scaduto. Richiedi un nuovo token tramite /api/v1/auth/login.
403insufficient_permissionsIl tuo ruolo non ha accesso a questo endpoint.

Limiti di frequenza

Le richieste API sono limitate per indirizzo IP. Il limite predefinito è di 60 richieste al minuto per gli endpoint di gestione e 1000 richieste al minuto per gli endpoint del widget. Le intestazioni sui limiti di frequenza sono incluse in ogni risposta.

  • X-RateLimit-Limit
  • X-RateLimit-Remaining
  • X-RateLimit-Reset
  • Retry-After (solo su 429)