Autentificarea API
Toate cererile API către SilentShield necesită autentificare. Există două metode de autentificare în funcție de endpoint.
Autentificare cu cheie API
Majoritatea endpoint-urilor utilizează autentificarea cu cheie API prin antetul X-Api-Key. Cheia API este disponibilă în tabloul de bord în secțiunea Chei API.
X-Api-Key: your-api-key-hereUtilizați această metodă pentru: endpoint-uri widget, verificare nonce și apeluri API publice.
Autentificare JWT
Endpoint-urile tabloului de bord și de gestionare utilizează autentificarea JWT (JSON Web Token). Obțineți un token prin autentificare la endpoint-ul de autentificare.
POST /api/v1/auth/loginRequest Body:
{"email": "[email protected]", "password": "your-password"}Response:
{"token": "eyJhbGciOiJIUzI1NiIs...", "expiresIn": 86400}Authorization: Bearer eyJhbGciOiJIUzI1NiIs...Utilizați această metodă pentru: endpoint-uri de gestionare, interogări de analiză, gestionarea echipei și setările contului.
Erori de autentificare
| Status | Error | Solution |
|---|---|---|
401 | missing credentials | Adăugați antetul X-Api-Key sau Authorization. |
401 | invalid_api_key | Verificați că cheia API este corectă și activă. |
401 | token_expired | JWT-ul dumneavoastră a expirat. Solicitați un token nou prin /api/v1/auth/login. |
403 | insufficient_permissions | Rolul dumneavoastră nu are acces la acest endpoint. |
Limite de rată
Cererile API sunt limitate per adresă IP. Limita implicită este de 60 cereri pe minut pentru endpoint-urile de gestionare și 1000 cereri pe minut pentru endpoint-urile widget. Anteturile de limită de rată sunt incluse în fiecare răspuns.
X-RateLimit-LimitX-RateLimit-RemainingX-RateLimit-ResetRetry-After (doar la 429)