API-todennus

Kaikki SilentShieldin API-pyynnöt vaativat todennuksen. Todennusmenetelmiä on kaksi päätepisteestä riippuen.

API-avaintodennus

Useimmat päätepisteet käyttävät API-avaintodennusta X-Api-Key-otsikon kautta. API-avaimesi on saatavilla hallintapaneelissa kohdassa API-avaimet.

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

Käytä tätä menetelmää: Widget-päätepisteet, nonce-vahvistus ja julkiset API-kutsut.

JWT-todennus

Hallintapaneelin ja hallintapäätepisteet käyttävät JWT (JSON Web Token) -todennusta. Hanki tunnus kirjautumalla sisään todennuspäätepisteen kautta.

POST /api/v1/auth/login

Request Body:

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

Response:

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

Authorization: Bearer eyJhbGciOiJIUzI1NiIs...

Käytä tätä menetelmää: Hallintapäätepisteet, analytiikkakyselyt, tiimin hallinta ja tiliasetukset.

Todennusvirheet

Status	Error	Solution
`401`	`missing credentials`	Lisää X-Api-Key- tai Authorization-otsikko.
`401`	`invalid_api_key`	Tarkista, että API-avaimesi on oikein ja aktiivinen.
`401`	`token_expired`	JWT-tunnuksesi on vanhentunut. Pyydä uusi tunnus osoitteesta /api/v1/auth/login.
`403`	`insufficient_permissions`	Roolillasi ei ole pääsyä tähän päätepisteeseen.

Nopeusrajoitukset

API-pyynnöt ovat nopeusrajoitettuja IP-osoitteen mukaan. Oletusraja on 60 pyyntöä minuutissa hallintapäätepisteille ja 1000 pyyntöä minuutissa widget-päätepisteille. Nopeusrajoitusotsikot sisältyvät jokaiseen vastaukseen.

X-RateLimit-Limit
X-RateLimit-Remaining
X-RateLimit-Reset
Retry-After (vain 429-virheessä)