Saltar al contenido principal

Claves de API

Las claves de API autentican las solicitudes a la API de gestión de ConsentForge. Son diferentes de los tokens de incrustación — manténgalas en secreto y úselas solo desde su backend.

Crear una clave de API

Cuenta → Claves de API → Crear clave

  1. Ingrese un nombre descriptivo (p. ej., "Sincronización backend — producción")
  2. Seleccione los alcances que necesita su integración (mínimo necesario)
  3. Establezca una fecha de expiración (opcional pero recomendado)
  4. Haga clic en Crear

Copie la clave inmediatamente — se muestra solo una vez.

Alcances disponibles

AlcanceAcceso
properties:readListar y ver propiedades
properties:writeCrear y actualizar propiedades
policies:readVer políticas y versiones
policies:writeCrear, publicar, revertir políticas
receipts:readVer recibos de consentimiento
receipts:exportExportar recibos (conjuntos de resultados grandes)
webhooks:readVer configuración de webhooks
webhooks:writeCrear y actualizar webhooks
users:readListar usuarios de la cuenta
users:writeInvitar y eliminar usuarios
scan:triggerActivar escaneos a través de la API
adminAcceso completo — úselo con prudencia

Expiración de claves

Establezca una fecha de expiración para limitar el impacto si una clave se ve comprometida. Las claves expiradas dejan de funcionar automáticamente.

Rote las claves regularmente. Para rotar: cree una nueva clave → actualice su integración → elimine la clave antigua.

Revocar una clave

Cuenta → Claves de API → [Nombre de la clave] → Revocar

La revocación es inmediata. Cualquier integración que use la clave comenzará a recibir respuestas 401 Unauthorized.

Mejores prácticas de seguridad de claves

  • Almacene las claves en variables de entorno o un gestor de secretos, nunca en el código fuente
  • Use una clave por integración (más fácil de revocar una sola clave comprometida)
  • Use el alcance más estrecho que funcione para su caso de uso
  • Establezca una fecha de expiración para las claves usadas en canales de CI/CD