Overovanie API

Všetky požiadavky API na SilentShield vyžadujú overenie. Existujú dve metódy overovania v závislosti od koncového bodu.

Overovanie API kľúčom

Väčšina koncových bodov používa overovanie API kľúčom prostredníctvom hlavičky X-Api-Key. Váš API kľúč je dostupný v paneli v sekcii API kľúče.

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

Túto metódu použite pre: koncové body widgetu, overenie nonce a verejné volania API.

Overovanie JWT

Koncové body panela a správy používajú overovanie JWT (JSON Web Token). Token získate prihlásením cez koncový bod overovania.

POST /api/v1/auth/login

Request Body:

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

Response:

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

Authorization: Bearer eyJhbGciOiJIUzI1NiIs...

Túto metódu použite pre: koncové body správy, analytické dotazy, správu tímu a nastavenia účtu.

Chyby overovania

Status	Error	Solution
`401`	`missing credentials`	Pridajte hlavičku X-Api-Key alebo Authorization.
`401`	`invalid_api_key`	Skontrolujte, či je váš API kľúč správny a aktívny.
`401`	`token_expired`	Váš JWT token vypršal. Získajte nový token cez /api/v1/auth/login.
`403`	`insufficient_permissions`	Vaša rola nemá prístup k tomuto koncovému bodu.

Limity požiadaviek

Požiadavky API sú obmedzené na IP adresu. Predvolený limit je 60 požiadaviek za minútu pre koncové body správy a 1000 požiadaviek za minútu pre koncové body widgetu. Hlavičky limitov požiadaviek sú zahrnuté v každej odpovedi.

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