API avtentikacija

Vse API zahteve do SilentShield zahtevajo avtentikacijo. Obstajata dve metodi avtentikacije, odvisno od končne točke.

Avtentikacija z API ključem

Večina končnih točk uporablja avtentikacijo z API ključem prek glave X-Api-Key. Vaš API ključ je na voljo na nadzorni plošči v razdelku API ključi.

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

Uporabite to metodo za: končne točke gradnika, preverjanje nonce in javne API klice.

JWT avtentikacija

Končne točke nadzorne plošče in upravljanja uporabljajo JWT (JSON Web Token) avtentikacijo. Pridobite žeton s prijavo prek končne točke za avtentikacijo.

POST /api/v1/auth/login

Request Body:

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

Response:

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

Authorization: Bearer eyJhbGciOiJIUzI1NiIs...

Uporabite to metodo za: končne točke upravljanja, poizvedbe analitike, upravljanje ekipe in nastavitve računa.

Napake avtentikacije

Status	Error	Solution
`401`	`missing credentials`	Dodajte glavo X-Api-Key ali Authorization.
`401`	`invalid_api_key`	Preverite, ali je vaš API ključ pravilen in aktiven.
`401`	`token_expired`	Vaš JWT je potekel. Zahtevajte nov žeton prek /api/v1/auth/login.
`403`	`insufficient_permissions`	Vaša vloga nima dostopa do te končne točke.

Omejitve hitrosti

API zahteve so omejene po IP naslovu. Privzeta omejitev je 60 zahtev na minuto za končne točke upravljanja in 1000 zahtev na minuto za končne točke gradnika. Glave omejitev hitrosti so vključene v vsak odgovor.

X-RateLimit-Limit
X-RateLimit-Remaining
X-RateLimit-Reset
Retry-After (samo pri 429)