Autenticación vía API Key

Gestión de Claves API

Para acceder a los servicios de la API de Foccuz, necesitas generar una clave API válida. Solo los usuarios con rol de administrador o mediante solicitud directa a Foccuz pueden gestionar estas credenciales.

Generación de Nueva Clave API

Paso 1: Acceder a la Gestión de Claves

Inicia sesión en la plataforma Foccuz

En el menú lateral (sidebar), navega a:
Ajustes > Claves de API

Haz clic en el botón "Generar Clave API"

Paso 2: Completar el Formulario

Se abrirá un formulario modal con los siguientes campos:

Nombre (obligatorio): Proporciona un nombre descriptivo para identificar la clave

Descripción (opcional): Agrega detalles adicionales sobre el uso de esta clave

Período de validez: Selecciona la duración (por defecto: 1 año)

Una vez completados los campos, haz clic en "Crear Clave API".

Paso 3: Copiar y Guardar la Clave

⚠️ Importante: Una vez generada la clave, esta información se mostrará una sola vez.

Cuando la clave sea creada exitosamente:

Copia la clave: Utiliza el botón de copiar para guardar la clave en tu portapapeles

Descarga la clave: Opcionalmente, puedes descargar un archivo con la información

Guarda de forma segura: Almacena la clave en un lugar seguro, ya que no podrás visualizarla nuevamente

Gestión de Claves Existentes

En la sección "Lista de Claves API" puedes:

Monitorear el estado de tus claves (Activo/Revocado/Expirado, etc.)

Ver información básica: Nombre, descripción y fecha de creación

Revisar fecha de expiración y último uso

Revocar una clave activa, para los casos que ya no necesites utilizar una clave existente

Estados de las Claves

Las claves API pueden tener los siguientes estados:

🟢 Activo: La clave está funcionando correctamente

🟡 Revocado: La clave ha sido deshabilitada y no puede utilizarse

🔴 Expirado: El período de validez de la clave ha caducado

Información de Seguimiento

Para cada clave generada, la plataforma registra:

Fecha de creación: Cuándo fue generada la clave

Fecha de expiración: Cuándo expirará la clave

Último uso: La última vez que se utilizó la clave

Número de solicitudes: Cantidad de requests realizados con la clave

Uso de la Clave API

Una vez que tengas tu clave API, inclúyela en el header de tus peticiones HTTP:

Ejemplo de Petición

Seguridad y Mejores Prácticas

✅ Guarda las claves API en variables de entorno, nunca en el código fuente

✅ Regenera las claves periódicamente

✅ Utiliza claves diferentes para entornos de desarrollo y producción

✅ Revoca inmediatamente las claves comprometidas

❌ No compartas las claves API públicamente

❌ No incluyas claves en repositorios de código

Soporte

Si necesitas asistencia adicional con la gestión de claves API o tienes preguntas sobre el proceso de autenticación, contacta al equipo de Foccuz a través de los canales oficiales de soporte.

Gestión de Claves API#

Generación de Nueva Clave API#

Paso 1: Acceder a la Gestión de Claves#

Paso 2: Completar el Formulario#

Paso 3: Copiar y Guardar la Clave#

Gestión de Claves Existentes#

Estados de las Claves#

Información de Seguimiento#

Uso de la Clave API#

Ejemplo de Petición#

Seguridad y Mejores Prácticas#

Soporte#