API-autentisering

Alla API-förfrågningar till SilentShield kräver autentisering. Det finns två autentiseringsmetoder beroende på slutpunkten.

API-nyckelautentisering

De flesta slutpunkter använder API-nyckelautentisering via X-Api-Key-huvudet. Din API-nyckel finns tillgänglig i instrumentpanelen under API-nycklar.

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

Använd denna metod för: Widget-slutpunkter, nonce-verifiering och publika API-anrop.

JWT-autentisering

Instrumentpanels- och hanteringsslutpunkter använder JWT (JSON Web Token)-autentisering. Hämta en token genom att logga in via autentiseringsslutpunkten.

POST /api/v1/auth/login

Request Body:

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

Response:

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

Authorization: Bearer eyJhbGciOiJIUzI1NiIs...

Använd denna metod för: Hanteringsslutpunkter, analysfrågor, teamhantering och kontoinställningar.

Autentiseringsfel

Status	Error	Solution
`401`	`missing credentials`	Lägg till X-Api-Key- eller Authorization-huvudet.
`401`	`invalid_api_key`	Kontrollera att din API-nyckel är korrekt och aktiv.
`401`	`token_expired`	Din JWT har gått ut. Begär en ny token via /api/v1/auth/login.
`403`	`insufficient_permissions`	Din roll har inte åtkomst till denna slutpunkt.

Hastighetsbegränsningar

API-förfrågningar är hastighetsbegränsade per IP-adress. Standardgränsen är 60 förfrågningar per minut för hanteringsslutpunkter och 1000 förfrågningar per minut för widget-slutpunkter. Hastighetsbegränsningshuvuden inkluderas i varje svar.

X-RateLimit-Limit
X-RateLimit-Remaining
X-RateLimit-Reset
Retry-After (endast vid 429)