Saltar a contenido

Cómo generar y gestionar claves de API de forma segura

🤖 Explicar con IA

Las claves de API son las credenciales digitales que permiten que su software personalizado o aplicaciones de terceros se comuniquen de forma segura con el ecosistema de 4Geeks. Ya sea que esté automatizando pagos a través de 4Geeks Payments, sincronizando datos de candidatos de 4Geeks Talent o integrando registros médicos con 4Geeks Health, una clave de API segura es su punto de partida.

Esta guía proporciona un recorrido completo sobre cómo generar, gestionar y asegurar sus claves de API utilizando la 4Geeks Console. Al seguir estos pasos, garantiza que sus integraciones sigan siendo robustas manteniendo la seguridad de los datos de su organización.

Requisitos previos

Antes de comenzar a generar claves, asegúrese de cumplir con los siguientes requisitos:

  • Acceso a la cuenta: Debe tener una cuenta activa en la 4Geeks Console.
  • Permisos de usuario: Necesita derechos de acceso de “Administrador” o “Desarrollador”. Los usuarios generales normalmente no tienen permiso para ver o crear claves de API.
  • Configuración de seguridad: Se recomienda encarecidamente que tenga habilitada la autenticación de dos factores (2FA) en su cuenta antes de realizar acciones de alta seguridad como la generación de claves.

Instrucciones paso a paso

Siga estos pasos para crear una nueva clave de API.

Paso 1: Acceder a la configuración de desarrollador

  1. Inicie sesión en su 4Geeks Console.
  2. En la barra lateral de navegación principal, busque y haga clic en Settings.
  3. En el menú desplegable o de configuración, seleccione API & Developers.

Paso 2: Generar una nueva clave

  1. En la sección de API Keys, verá una lista de claves existentes (si las hay). Haga clic en el botón + Generate New Key.
  2. Nombre su clave: Ingrese un nombre descriptivo en el campo “Label”.
    • Consejo: Use una convención de nomenclatura que identifique el propósito de la clave y el servicio que la utiliza (por ejemplo, Zapier-Integration-Payroll o Internal-App-Health).
  3. Establecer expiración (Opcional): Para mayor seguridad, puede establecer una fecha de expiración. Si esta clave es para un proyecto temporal, seleccione una fecha; de lo contrario, déjela como “Never Expire” (Nunca expira).

Paso 3: Definir permisos (Alcances)

Para adherirse al principio de mínimo privilegio, otorgue solo los permisos necesarios para la tarea específica.

  1. Revise la lista de productos disponibles (por ejemplo, 4Geeks Asset, 4Geeks Perks).
  2. Active los permisos específicos de Read (Lectura) o Write (Escritura) requeridos.
    • Ejemplo: Si la clave es para un visor de panel, otorgue acceso de Sólo lectura a 4Geeks Asset. No otorgue acceso de Escritura a 4Geeks Payroll a menos que la integración requiera explícitamente modificar datos salariales.
  3. Haga clic en Create Key.

Paso 4: Copiar y almacenar su clave

Paso crucial: Una vez generada la clave, un modal mostrará la API Secret Key completa.

  1. Haga clic en el icono de Copy para copiar la cadena a su portapapeles.
  2. Pegue esta clave inmediatamente en su bóveda segura, gestor de contraseñas o archivo de variables de entorno (.env).
  3. Nota: Por razones de seguridad, 4Geeks nunca volverá a mostrar esta clave completa. Si la pierde, tendrá que generar una nueva y actualizar sus integraciones.

Casos de uso comunes

Comprender cómo aplicar estas claves puede ayudar a agilizar sus operaciones en toda la suite de 4Geeks.

Escenario 1: Automatización de flujos de trabajo de incorporación

Situación: Su equipo de RR.HH. utiliza un portal interno personalizado y desea activar tareas de incorporación automáticamente cuando se aprueba una nueva contratación. Aplicación: Genera una clave de API con acceso de “Escritura” a 4Geeks Talent. Cuando un candidato se marca como “Contratado” en su sistema interno, la clave de API autentica una solicitud a 4Geeks Talent para iniciar la secuencia de incorporación.

Escenario 2: Sincronización de inventario para comercio electrónico

Situación: Utiliza 4Geeks Asset para el seguimiento de inventario pero usa una herramienta de terceros para las ventas front-end. Aplicación: Al crear una clave de API de “Sólo lectura” para su plataforma de ventas, esta puede consultar 4Geeks Asset cada 15 minutos para obtener niveles de stock en tiempo real, asegurando que nunca venda de más un producto.

Solución de problemas

Si sus integraciones están fallando, verifique estos problemas comunes asociados con las claves de API.

Problema 1: Error HTTP 401 Unauthorized

  • Causa: La clave de API falta, es incorrecta o ha sido eliminada.
  • Solución: Verifique el código de su aplicación para asegurarse de que la clave se está pasando correctamente en el encabezado (Header), usualmente como Authorization: Bearer TU_CLAVE_API. Si el código es correcto, verifique en la 4Geeks Console que el estado de la clave sea “Active”.

Problema 2: Error HTTP 403 Forbidden

  • Causa: La clave funciona, pero no tiene permiso para acceder al recurso específico.
  • Solución: Es probable que haya restringido el alcance (Scope) durante el Paso 3. Por ejemplo, si está intentando usar endpoints de los Agentes de IA de 4Geeks pero solo habilitó permisos para 4Geeks Perks, la solicitud fallará. Genere una nueva clave con los alcances correctos.

Problema 3: Compromiso de la clave

  • Causa: Un desarrollador cometió accidentalmente la clave de API en un repositorio público de GitHub.
  • Solución: Trate esto como una emergencia de seguridad. Inicie sesión inmediatamente en la consola, busque la clave comprometida y haga clic en Revoke/Delete. Genere una nueva clave y actualice sus variables de entorno.

Mejores prácticas de seguridad

  • Rotar claves: Cambie sus claves de API periódicamente (por ejemplo, cada 90 días) para reducir el riesgo de credenciales comprometidas.
  • Usar variables de entorno: Nunca codifique claves de API directamente en el código fuente de su aplicación.
  • Limitar alcances: Nunca genere una clave de “Super Administrador” con acceso a todo a menos que sea absolutamente necesario. Si una clave solo es necesaria para 4Geeks Payroll, no le dé acceso a los datos de 4Geeks Health.

Conclusión

Gestionar las claves de API de forma segura es la base de una infraestructura técnica estable y segura. Al configurar correctamente los permisos y manejar sus credenciales con cuidado, puede desbloquear todo el potencial de la automatización dentro del ecosistema de 4Geeks.

¿Listo para crear su primera integración? Visite la 4Geeks Console para comenzar.

Recursos adicionales