Puntos de conexión de CaseBender
Ver el archivo de especificación OpenAPI
Autenticación
Todos los puntos de conexión de la API requieren autenticación mediante claves de API. Incluya su clave de API en cada solicitud utilizando uno de los siguientes métodos:Recomendado: Token Bearer
Incluya su clave de API como token Bearer en el encabezadoAuthorization:
Alternativa: Encabezado X-Api-Key
También puede utilizar el encabezadoX-Api-Key:
Crear claves de API
Para crear claves de API:- Inicie sesión en su instancia de CaseBender
- Vaya a Cuenta → Claves de API
- Haga clic en Crear clave de API
- Configure el nombre, la descripción, el nivel (tier) y los ámbitos (scopes) de la clave
- Guarde la clave inmediatamente: se muestra solo una vez y no se puede recuperar después
Usar claves de API
Incluya la clave de API en todas las solicitudes:Con cURL
Con Python (biblioteca requests)
Con JavaScript/Node.js (fetch)
Niveles de claves de API
A las claves de API se les asignan niveles que determinan los límites de tasa:Ámbitos de claves de API
Al crear una clave de API, puede limitar su acceso a operaciones específicas:alerts:read- Leer alertasalerts:write- Crear y actualizar alertascases:read- Leer casoscases:write- Crear y actualizar casosobservables:read- Leer observablesobservables:write- Crear y actualizar observablesusers:read- Leer información de usuariosadmin:*- Operaciones administrativas
Errores de autenticación comunes
-
401 Unauthorized:
- Falta el encabezado
Authorization - Clave de API inválida o expirada
- La clave de API ha sido revocada o suspendida
- Falta el encabezado
-
403 Forbidden:
- La clave de API carece del ámbito requerido para la operación
- Restricciones de acceso TLP/PAP
-
429 Too Many Requests:
- Se superó el límite de tasa para su nivel
Buenas prácticas de seguridad
- Nunca comparta su clave de API: trátela como una contraseña
- Rote las claves de API con regularidad: revoque las claves antiguas y cree nuevas periódicamente
- Use claves diferentes para aplicaciones diferentes: esto le permite revocar el acceso por aplicación
- Establezca fechas de expiración: configure las claves de API para que expiren automáticamente cuando sea posible
- Use los ámbitos mínimos necesarios: otorgue solo los permisos que su aplicación necesita