Uwierzytelnianie API

Wszystkie żądania API do SilentShield wymagają uwierzytelnienia. Istnieją dwie metody uwierzytelniania w zależności od punktu końcowego.

Uwierzytelnianie kluczem API

Większość punktów końcowych używa uwierzytelniania kluczem API poprzez nagłówek X-Api-Key. Twój klucz API jest dostępny w panelu w sekcji Klucze API.

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

Użyj tej metody dla: punktów końcowych widgetu, weryfikacji nonce i publicznych wywołań API.

Uwierzytelnianie JWT

Punkty końcowe panelu i zarządzania używają uwierzytelniania JWT (JSON Web Token). Uzyskaj token, logując się przez punkt końcowy uwierzytelniania.

POST /api/v1/auth/login

Request Body:

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

Response:

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

Authorization: Bearer eyJhbGciOiJIUzI1NiIs...

Użyj tej metody dla: punktów końcowych zarządzania, zapytań analitycznych, zarządzania zespołem i ustawień konta.

Błędy uwierzytelniania

Status	Error	Solution
`401`	`missing credentials`	Dodaj nagłówek X-Api-Key lub Authorization.
`401`	`invalid_api_key`	Sprawdź, czy Twój klucz API jest poprawny i aktywny.
`401`	`token_expired`	Twój token JWT wygasł. Uzyskaj nowy token przez /api/v1/auth/login.
`403`	`insufficient_permissions`	Twoja rola nie ma dostępu do tego punktu końcowego.

Limity żądań

Żądania API są ograniczane na klucz API i punkt końcowy. Ile żądań na minutę jest dozwolonych, zależy od Państwa planu — wartości znajdują się na stronie z cennikiem. Każda odpowiedź zawiera nagłówki limitu.

X-RateLimit-Limit
X-RateLimit-Remaining
X-RateLimit-Reset
Retry-After (tylko przy 429)