Ověřování API

Všechny požadavky API na SilentShield vyžadují ověření. Existují dvě metody ověřování v závislosti na koncovém bodu.

Ověřování API klíčem

Většina koncových bodů používá ověřování API klíčem prostřednictvím hlavičky X-Api-Key. Váš API klíč je dostupný v panelu v sekci API klíče.

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

Tuto metodu použijte pro: koncové body widgetu, ověření nonce a veřejná volání API.

Ověřování JWT

Koncové body panelu a správy používají ověřování JWT (JSON Web Token). Token získáte přihlášením přes koncový bod ověřování.

POST /api/v1/auth/login

Request Body:

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

Response:

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

Authorization: Bearer eyJhbGciOiJIUzI1NiIs...

Tuto metodu použijte pro: koncové body správy, analytické dotazy, správu týmu a nastavení účtu.

Chyby ověřování

Status	Error	Solution
`401`	`missing credentials`	Přidejte hlavičku X-Api-Key nebo Authorization.
`401`	`invalid_api_key`	Zkontrolujte, zda je váš API klíč správný a aktivní.
`401`	`token_expired`	Váš JWT token vypršel. Získejte nový token přes /api/v1/auth/login.
`403`	`insufficient_permissions`	Vaše role nemá přístup k tomuto koncovému bodu.

Limity požadavků

Požadavky API jsou omezeny na IP adresu. Výchozí limit je 60 požadavků za minutu pro koncové body správy a 1000 požadavků za minutu pro koncové body widgetu. Hlavičky limitů požadavků jsou zahrnuty v každé odpovědi.

X-RateLimit-Limit
X-RateLimit-Remaining
X-RateLimit-Reset
Retry-After (pouze při 429)