Awtentikazzjoni tal-API
It-talbiet kollha tal-API lil SilentShield jeħtieġu awtentikazzjoni. Hemm żewġ metodi ta' awtentikazzjoni skont l-endpoint.
Awtentikazzjoni biċ-Ċavetta API
Il-biċċa l-kbira tal-endpoints jużaw awtentikazzjoni biċ-ċavetta API permezz tal-header X-Api-Key. Iċ-ċavetta API tiegħek tinsab fid-dashboard taħt API Keys.
X-Api-Key: your-api-key-hereUża din il-metodu għal: Endpoints tal-widget, verifika tan-nonce, u sejħiet API pubbliċi.
Awtentikazzjoni JWT
L-endpoints tad-dashboard u tal-ġestjoni jużaw awtentikazzjoni JWT (JSON Web Token). Ikseb token billi tidħol permezz tal-endpoint tal-awtentikazzjoni.
POST /api/v1/auth/loginRequest Body:
{"email": "[email protected]", "password": "your-password"}Response:
{"token": "eyJhbGciOiJIUzI1NiIs...", "expiresIn": 86400}Authorization: Bearer eyJhbGciOiJIUzI1NiIs...Uża din il-metodu għal: Endpoints tal-ġestjoni, mistoqsijiet tal-analitika, ġestjoni tat-tim, u settings tal-kont.
Żbalji tal-Awtentikazzjoni
| Status | Error | Solution |
|---|---|---|
401 | missing credentials | Żid il-header X-Api-Key jew Authorization. |
401 | invalid_api_key | Iċċekkja li ċ-ċavetta API tiegħek hija korretta u attiva. |
401 | token_expired | Il-JWT tiegħek skada. Itlob token ġdid permezz ta' /api/v1/auth/login. |
403 | insufficient_permissions | Ir-rwol tiegħek m'għandux aċċess għal dan l-endpoint. |
Limiti tar-Rata
It-talbiet tal-API huma llimitati fir-rata għal kull indirizz IP. Il-limitu default huwa 60 talba kull minuta għall-endpoints tal-ġestjoni u 1000 talba kull minuta għall-endpoints tal-widget. Il-headers tal-limitu tar-rata huma inklużi f'kull risposta.
X-RateLimit-LimitX-RateLimit-RemainingX-RateLimit-ResetRetry-After (only on 429)