Saltar al contenido principal

Cómo obtener tu clave de API

Para acceder a las API y los servicios de ChainPatrol, necesitas una clave de API. Así puedes obtener una:
  1. Ve al Dashboard (panel principal) de tu organización
  2. En la barra lateral, abre Developer › API Keys (claves de API)
  3. Haz clic en Create Key (crear clave), elige tu configuración y haz clic en Create (crear)
  4. Copia la clave desde el cuadro de diálogo de confirmación. Se muestra una sola vez
Solo los propietarios y administradores de la organización pueden crear claves de API.
Las claves nuevas son Read only (solo lectura) de forma predeterminada. Para enviar reportes o hacer cualquier otro cambio a través de la API, selecciona Read & write (lectura y escritura) al crear la clave. Consulta Permisos de la clave.

Tipos de claves de API

Permisos de la clave

  • Read only (predeterminado): puede consultar y exportar datos, pero no puede enviar reportes ni hacer otros cambios
  • Read & write: acceso completo a la API, incluido el envío de reportes y la realización de cambios
Una clave de solo lectura recibe 403 Forbidden de cualquier endpoint que modifique datos, como Crear reporte. El permiso de una clave no se puede cambiar después de crearla, así que crea una nueva clave Read & write y revoca la anterior. Las organizaciones de integración solo pueden crear claves de solo lectura; escribe a support@chainpatrol.io si la tuya necesita acceso de escritura.

Claves de organización vs. claves de usuario

  • Claves de organización (Organization Keys): otorgan atribución a nivel de organización
    • Los reportes enviados con claves de organización se atribuyen a un usuario de máquina (machine user)
    • La mejor opción para sistemas automatizados, integraciones y flujos de trabajo a nivel de organización
    • Ideales para bots, sistemas de reporte automatizados y pipelines de CI/CD
  • Claves de usuario (User Keys): otorgan atribución a nivel de usuario
    • Los reportes enviados con claves de usuario se atribuyen directamente a tu cuenta de usuario
    • La mejor opción para uso personal y cuando se necesita responsabilidad individual
    • Ideales para el reporte manual y las herramientas personales

Claves de prueba (test) vs. claves de producción (live)

ChainPatrol ofrece entornos de prueba (test) y de producción (live) para ayudarte a desarrollar y probar tu integración de forma segura.
  • Claves de prueba (Test Keys): sirven para distinguir cuándo se están usando en desarrollo y pruebas
    • Úsalas en entornos de desarrollo
    • Estas claves igualmente afectan los datos de producción
  • Claves de producción (Live Keys): para uso en producción
    • Úsalas en entornos de producción
    • Afectan datos y reportes reales
    • Son necesarias para la detección y el reporte de amenazas reales

Formato de la clave de API

Las claves de API de ChainPatrol siguen este formato:
  • Siempre empiezan con el prefijo cp_
  • Son únicas para tu organización
  • Deben mantenerse seguras y no compartirse públicamente

Cómo usar tu clave de API

Al hacer solicitudes a la API de ChainPatrol, incluye tu clave de API en los encabezados de la solicitud:

Soporte

Si necesitas ayuda con tu clave de API o tienes alguna pregunta, puedes: