API autentifikacija

Visos SilentShield API užklausos reikalauja autentifikacijos. Yra du autentifikacijos metodai, priklausomai nuo galinio taško.

API rakto autentifikacija

Dauguma galinių taškų naudoja API rakto autentifikaciją per X-Api-Key antraštę. Jūsų API raktas pasiekiamas valdymo skydelyje skiltyje API raktai.

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

Naudokite šį metodą: valdiklio galiniai taškai, nonce patikra ir viešos API užklausos.

JWT autentifikacija

Valdymo skydelio ir administravimo galiniai taškai naudoja JWT (JSON Web Token) autentifikaciją. Gaukite prieigos raktą prisijungdami per autentifikacijos galinį tašką.

POST /api/v1/auth/login

Request Body:

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

Response:

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

Authorization: Bearer eyJhbGciOiJIUzI1NiIs...

Naudokite šį metodą: valdymo galiniai taškai, analitikos užklausos, komandos valdymas ir paskyros nustatymai.

Autentifikacijos klaidos

Status	Error	Solution
`401`	`missing credentials`	Pridėkite X-Api-Key arba Authorization antraštę.
`401`	`invalid_api_key`	Patikrinkite, ar jūsų API raktas yra teisingas ir aktyvus.
`401`	`token_expired`	Jūsų JWT pasibaigė galiojimas. Užklausykite naują prieigos raktą per /api/v1/auth/login.
`403`	`insufficient_permissions`	Jūsų vaidmuo neturi prieigos prie šio galinio taško.

Užklausų limitai

API užklausos ribojamos pagal IP adresą. Numatytasis limitas yra 60 užklausų per minutę valdymo galiniams taškams ir 1000 užklausų per minutę valdiklio galiniams taškams. Užklausų limitų antraštės įtraukiamos į kiekvieną atsakymą.

X-RateLimit-Limit
X-RateLimit-Remaining
X-RateLimit-Reset
Retry-After (tik su 429)