Skip to main content

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 encabezado Authorization:

Alternativa: Encabezado X-Api-Key

También puede utilizar el encabezado X-Api-Key:
Importante: Su clave de API otorga acceso a su instancia de CaseBender. Manténgala segura y nunca la comparta públicamente.

Crear claves de API

Para crear claves de API:
  1. Inicie sesión en su instancia de CaseBender
  2. Vaya a CuentaClaves de API
  3. Haga clic en Crear clave de API
  4. Configure el nombre, la descripción, el nivel (tier) y los ámbitos (scopes) de la clave
  5. Guarde la clave inmediatamente: se muestra solo una vez y no se puede recuperar después
Cuando cree una clave de API, recibirá una única clave con este aspecto:

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 alertas
  • alerts:write - Crear y actualizar alertas
  • cases:read - Leer casos
  • cases:write - Crear y actualizar casos
  • observables:read - Leer observables
  • observables:write - Crear y actualizar observables
  • users:read - Leer información de usuarios
  • admin:* - 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
  • 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

Autenticación heredada (obsoleta)

Los encabezados heredados x-api-key y x-api-secret todavía se admiten por compatibilidad con versiones anteriores, pero están obsoletos. Migre a la autenticación con token Bearer.