API удостоверяване

Всички API заявки към SilentShield изискват удостоверяване. Има два метода за удостоверяване в зависимост от крайната точка.

Удостоверяване с API ключ

Повечето крайни точки използват удостоверяване с API ключ чрез заглавката X-Api-Key. Вашият API ключ е наличен в таблото в секцията API ключове.

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

Използвайте този метод за: крайни точки на уиджета, верификация на nonce и публични API извиквания.

JWT удостоверяване

Крайните точки за табло и управление използват JWT (JSON Web Token) удостоверяване. Получете токен чрез влизане през крайната точка за удостоверяване.

POST /api/v1/auth/login

Request Body:

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

Response:

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

Authorization: Bearer eyJhbGciOiJIUzI1NiIs...

Използвайте този метод за: крайни точки за управление, заявки за анализи, управление на екипа и настройки на акаунта.

Грешки при удостоверяване

Status	Error	Solution
`401`	`missing credentials`	Добавете заглавката X-Api-Key или Authorization.
`401`	`invalid_api_key`	Проверете дали вашият API ключ е правилен и активен.
`401`	`token_expired`	Вашият JWT е изтекъл. Заявете нов токен чрез /api/v1/auth/login.
`403`	`insufficient_permissions`	Вашата роля няма достъп до тази крайна точка.

Лимити на заявките

API заявките са ограничени по IP адрес. Лимитът по подразбиране е 60 заявки в минута за крайни точки за управление и 1000 заявки в минута за крайни точки на уиджета. Заглавки за лимити на заявките са включени във всеки отговор.

X-RateLimit-Limit
X-RateLimit-Remaining
X-RateLimit-Reset
Retry-After (само при 429)