API autentifikācija

Visiem SilentShield API pieprasījumiem nepieciešama autentifikācija. Ir divas autentifikācijas metodes atkarībā no galapunkta.

API atslēgas autentifikācija

Lielākā daļa galapunktu izmanto API atslēgas autentifikāciju, izmantojot X-Api-Key galveni. Jūsu API atslēga ir pieejama vadības panelī sadaļā API atslēgas.

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

Izmantojiet šo metodi: logrīka galapunktiem, nonce verifikācijai un publiski pieejamiem API izsaukumiem.

JWT autentifikācija

Vadības paneļa un pārvaldības galapunkti izmanto JWT (JSON Web Token) autentifikāciju. Iegūstiet žetonu, piesakoties caur autentifikācijas galapunktu.

POST /api/v1/auth/login

Request Body:

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

Response:

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

Authorization: Bearer eyJhbGciOiJIUzI1NiIs...

Izmantojiet šo metodi: pārvaldības galapunktiem, analītikas vaicājumiem, komandas pārvaldībai un konta iestatījumiem.

Autentifikācijas kļūdas

Status	Error	Solution
`401`	`missing_api_key`	Pievienojiet X-Api-Key vai Authorization galveni.
`401`	`invalid site key`	Pārbaudiet, vai jūsu API atslēga ir pareiza un aktīva.
`401`	`token_expired`	Jūsu JWT ir beidzies. Pieprasiet jaunu žetonu caur /api/v1/auth/login.
`403`	`insufficient_permissions`	Jūsu lomai nav piekļuves šim galapunktam.

Ātruma ierobežojumi

API pieprasījumi ir ierobežoti katrai API atslēgai un galapunktam. Cik pieprasījumu minūtē ir atļauts, ir atkarīgs no jūsu plāna — vērtības ir cenu lapā. Katrā atbildē ir ierobežojuma galvenes.

X-RateLimit-Limit
X-RateLimit-Remaining
X-RateLimit-Reset
Retry-After (tikai pie 429)