API-authenticatie

Alle API-verzoeken aan SilentShield vereisen authenticatie. Er zijn twee authenticatiemethoden, afhankelijk van het eindpunt.

API-sleutelauthenticatie

De meeste eindpunten gebruiken API-sleutelauthenticatie via de X-Api-Key header. Uw API-sleutel is beschikbaar in het dashboard onder API-sleutels.

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

Gebruik deze methode voor: Widget-eindpunten, nonce-verificatie en publieke API-aanroepen.

JWT-authenticatie

Dashboard- en beheerseindpunten gebruiken JWT (JSON Web Token)-authenticatie. Verkrijg een token door in te loggen via het authenticatie-eindpunt.

POST /api/v1/auth/login

Request Body:

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

Response:

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

Gebruik deze methode voor: Beheerseindpunten, analysequery's, teambeheer en accountinstellingen.

Authenticatiefouten

StatusErrorSolution
401missing credentialsVoeg de X-Api-Key of Authorization header toe.
401invalid_api_keyControleer of uw API-sleutel correct en actief is.
401token_expiredUw JWT is verlopen. Vraag een nieuw token aan via /api/v1/auth/login.
403insufficient_permissionsUw rol heeft geen toegang tot dit eindpunt.

Snelheidslimieten

API-verzoeken zijn snelheidsbeperkt per IP-adres. De standaardlimiet is 60 verzoeken per minuut voor beheerseindpunten en 1000 verzoeken per minuut voor widget-eindpunten. Snelheidslimitheaders worden bij elk antwoord meegestuurd.

  • X-RateLimit-Limit
  • X-RateLimit-Remaining
  • X-RateLimit-Reset
  • Retry-After (alleen bij 429)