API-hitelesítés

A SilentShield felé irányuló összes API-kérés hitelesítést igényel. A végponttól függően két hitelesítési módszer létezik.

API-kulcsos hitelesítés

A legtöbb végpont API-kulcsos hitelesítést használ az X-Api-Key fejlécen keresztül. API-kulcsa a vezérlőpulton, az API-kulcsok szakaszban érhető el.

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

Használja ezt a módszert a következőkhöz: widget-végpontok, nonce-ellenőrzés és nyilvános API-hívások.

JWT-hitelesítés

A vezérlőpult és a kezelési végpontok JWT (JSON Web Token) hitelesítést használnak. Tokent a hitelesítési végponton keresztüli bejelentkezéssel szerezhet.

POST /api/v1/auth/login

Request Body:

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

Response:

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

Authorization: Bearer eyJhbGciOiJIUzI1NiIs...

Használja ezt a módszert a következőkhöz: kezelési végpontok, analitikai lekérdezések, csapatkezelés és fiókbeállítások.

Hitelesítési hibák

Status	Error	Solution
`401`	`missing_api_key`	Adja hozzá az X-Api-Key vagy az Authorization fejlécet.
`401`	`invalid site key`	Ellenőrizze, hogy API-kulcsa helyes és aktív-e.
`401`	`token_expired`	JWT-tokenje lejárt. Kérjen új tokent a /api/v1/auth/login végponton.
`403`	`insufficient_permissions`	Szerepköre nem rendelkezik hozzáféréssel ehhez a végponthoz.

Kéréskorlátok

Az API-kéréseket API-kulcsonként és végpontonként korlátozzuk. Hogy percenként hány kérés engedélyezett, a csomagjától függ — az értékek az árazási oldalon találhatók. Minden válasz tartalmazza a korlát fejléceit.

X-RateLimit-Limit
X-RateLimit-Remaining
X-RateLimit-Reset
Retry-After (csak 429 esetén)