DocumentacionAPI keys y scopes

API keys y scopes

Crear claves, asignar permisos y rotar credenciales.

Las API keys permiten acceso programatico limitado por scopes. Se gestionan desde el panel o via POST /tenants/:id/api-keys (JWT).

Crear una key

  1. Panel → Ajustes → API keys → Crear
  2. Elige nombre descriptivo (prod-nextjs, staging-crm)
  3. Marca solo los scopes necesarios (principio de minimo privilegio)
  4. Copia la key completa — solo se muestra una vez

Formato almacenado: hash SHA-256 en base de datos; la key en claro no se recupera.

Scopes disponibles

ScopeUso
email:sendPOST /emails/send, batch, programados
email:readGET /emails/logs, cancelar programados
templates:read / templates:writeReservado; plantillas usan JWT en la practica actual
contacts:read / contacts:writeAudiencia y GDPR erasure
campaigns:read / campaigns:writeCampanas newsletter
sequences:read / sequences:writeSecuencias automaticas (API)
suppressions:read / suppressions:writeLista de supresion
webhooks:manageEndpoints de webhooks salientes

Si falta un scope, la API responde 403 con mensaje Missing required API key scope.

Rotacion

  1. Crea una key nueva con los mismos scopes
  2. Actualiza secretos en tu despliegue
  3. Revoca la key antigua (DELETE /tenants/:id/api-keys/:keyId)