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

Koristite 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/login

Request 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

StatusErrorSolution
401missing credentialsDodajte zaglavlje X-Api-Key ili Authorization.
401invalid_api_keyProvjerite je li vaš API ključ ispravan i aktivan.
401token_expiredVaš JWT je istekao. Zatražite novi token putem /api/v1/auth/login.
403insufficient_permissionsVaš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-Limit
  • X-RateLimit-Remaining
  • X-RateLimit-Reset
  • Retry-After (samo kod 429)