API autentimine

Kõik SilentShield API päringud nõuavad autentimist. Sõltuvalt lõpp-punktist on kaks autentimismeetodit.

API-võtmega autentimine

Enamik lõpp-punkte kasutab API-võtme autentimist X-Api-Key päise kaudu. Teie API-võti on saadaval töölaua jaotises API-võtmed.

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

Kasutage seda meetodit: vidina lõpp-punktid, nonce'i kontrollimine ja avalikud API-kutsed.

JWT autentimine

Töölaua ja halduse lõpp-punktid kasutavad JWT (JSON Web Token) autentimist. Saate tokeni sisselogimise lõpp-punkti kaudu.

POST /api/v1/auth/login

Request Body:

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

Response:

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

Authorization: Bearer eyJhbGciOiJIUzI1NiIs...

Kasutage seda meetodit: halduse lõpp-punktid, analüütika päringud, meeskonna haldamine ja konto seaded.

Autentimise vead

Status	Error	Solution
`401`	`missing credentials`	Lisage X-Api-Key või Authorization päis.
`401`	`invalid_api_key`	Kontrollige, et teie API-võti on õige ja aktiivne.
`401`	`token_expired`	Teie JWT on aegunud. Taotlege uut tokenit endpointilt /api/v1/auth/login.
`403`	`insufficient_permissions`	Teie rollil puudub juurdepääs sellele lõpp-punktile.

Päringute piiramine

API päringuid piiratakse IP-aadressi kohta. Vaikimisi piirang on 60 päringut minutis halduse lõpp-punktidele ja 1000 päringut minutis vidina lõpp-punktidele. Päringute piiramise päised on lisatud igale vastusele.

X-RateLimit-Limit
X-RateLimit-Remaining
X-RateLimit-Reset
Retry-After (ainult 429 korral)