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-here

Utilizaț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/login

Request 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

StatusErrorSolution
401missing credentialsAdăugați antetul X-Api-Key sau Authorization.
401invalid_api_keyVerificați că cheia API este corectă și activă.
401token_expiredJWT-ul dumneavoastră a expirat. Solicitați un token nou prin /api/v1/auth/login.
403insufficient_permissionsRolul dumneavoastră nu are acces la acest endpoint.

Limite de rată

Cererile API sunt limitate pe cheie API și pe endpoint. Câte cereri pe minut sunt permise depinde de planul dumneavoastră — valorile se află pe pagina de prețuri. Fiecare răspuns conține anteturile de limită.

  • X-RateLimit-Limit
  • X-RateLimit-Remaining
  • X-RateLimit-Reset
  • Retry-After (doar la 429)