API autentifikacija
Svi API zahtjevi prema SilentShieldu zahtijevaju autentifikaciju. Postoje dvije metode autentifikacije ovisno o krajnjoj točki.
Autentifikacija API ključem
Većina krajnjih točaka koristi autentifikaciju API ključem putem zaglavlja X-Api-Key. Vaš API ključ dostupan je na nadzornoj ploči u odjeljku API ključevi.
X-Api-Key: your-api-key-hereKoristite ovu metodu za: krajnje točke widgeta, verifikaciju nonce i javne API pozive.
JWT autentifikacija
Krajnje točke nadzorne ploče i upravljanja koriste JWT (JSON Web Token) autentifikaciju. Dobijte token prijavom putem krajnje točke za autentifikaciju.
POST /api/v1/auth/loginRequest Body:
{"email": "[email protected]", "password": "your-password"}Response:
{"token": "eyJhbGciOiJIUzI1NiIs...", "expiresIn": 86400}Authorization: Bearer eyJhbGciOiJIUzI1NiIs...Koristite ovu metodu za: krajnje točke upravljanja, upite analitike, upravljanje timom i postavke računa.
Greške autentifikacije
| Status | Error | Solution |
|---|---|---|
401 | missing credentials | Dodajte zaglavlje X-Api-Key ili Authorization. |
401 | invalid_api_key | Provjerite je li vaš API ključ ispravan i aktivan. |
401 | token_expired | Vaš JWT je istekao. Zatražite novi token putem /api/v1/auth/login. |
403 | insufficient_permissions | Vaša uloga nema pristup ovoj krajnjoj točki. |
Ograničenja brzine
API zahtjevi su ograničeni po IP adresi. Zadano ograničenje je 60 zahtjeva u minuti za krajnje točke upravljanja i 1000 zahtjeva u minuti za krajnje točke widgeta. Zaglavlja ograničenja brzine uključena su u svaki odgovor.
X-RateLimit-LimitX-RateLimit-RemainingX-RateLimit-ResetRetry-After (samo kod 429)