Autenticación de la API

Todas las solicitudes a la API de SilentShield requieren autenticación. Existen dos métodos de autenticación según el endpoint.

Autenticación con API Key

La mayoría de los endpoints utilizan autenticación mediante API key a través del encabezado X-Api-Key. Su API key está disponible en el panel en API Keys.

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

Use este método para: Endpoints del widget, verificación de nonce y llamadas a la API públicas.

Autenticación JWT

Los endpoints del panel y de gestión utilizan autenticación JWT (JSON Web Token). Obtenga un token iniciando sesión a través del endpoint de autenticación.

POST /api/v1/auth/login

Request Body:

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

Response:

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

Use este método para: Endpoints de gestión, consultas de análisis, gestión del equipo y configuración de la cuenta.

Errores de Autenticación

StatusErrorSolution
401missing credentialsAñada el encabezado X-Api-Key o Authorization.
401invalid_api_keyVerifique que su API key sea correcta y esté activa.
401token_expiredSu JWT ha expirado. Solicite un nuevo token a través de /api/v1/auth/login.
403insufficient_permissionsSu rol no tiene acceso a este endpoint.

Límites de Velocidad

Las solicitudes a la API están limitadas por dirección IP. El límite predeterminado es de 60 solicitudes por minuto para endpoints de gestión y 1000 solicitudes por minuto para endpoints del widget. Los encabezados de límite de velocidad se incluyen en cada respuesta.

  • X-RateLimit-Limit
  • X-RateLimit-Remaining
  • X-RateLimit-Reset
  • Retry-After (solo en 429)