API Key: Acceso seguro para conectar Bitákora con otros sistemas

Con esta opción podrás crear un nuevo API Key para integrar otros sistemas con Bitákora de forma segura.

Solo necesitas asignarle un nombre, definir una fecha de expiración y configurar los permisos que va a tener.

En términos técnicos, sirve para autorizar integraciones entre Bitákora y otros sistemas o aplicaciones externas de forma segura.

Ingreso para configurar las API keys

Accede a esta opción por la ruedita ubicada en el encabezado del Home de Bitákora y en la sección de Configuraciones, ubica la opción Configuración API keys.

Al ingresar podrás observar el panel de administración para crear y gestionar API Keys dentro del sistema Bitákora.

🔐 ¿Para qué sirve esta página?

Permite crear una credencial de acceso (API Key) que otras aplicaciones usarán para conectarse al software sin necesidad de ingresar usuario y contraseña.

Es decir:

👉 Autoriza que otro sistema consuma datos o ejecute acciones en Bitákora mediante la API.

¿Cómo crear una API Key en Bitákora?

Al dar clic sobre el botón Crear api key podrás crear la llave de acceso para integrar otros sistemas.

Para crear una llave de autorización en Bitákora, sigue estos pasos:

1. Ingresa: accede a la opción de API keys en la sección de Configuraciones del sistema dentro de Bitákora.
   1. Si no tienes acceso, comunícate con el administrador del sistema o solicita el acceso a través de Capta con un ticket de soporte.
   2. Crea la API: oprime el botón Crear api key en la opción de configuración.
2. Registra el nombre: es solo un identificador interno para saber para qué se creó la clave.
   1. Utiliza nombres descriptivos, ejemplos: API Biométrico GeoVictoria, API Contabilidad Sinco ERP, API Portal empleados.
3. Asigna una fecha de expiración: define hasta cuándo la clave será válida. Buenas prácticas:
   1. No dejar claves indefinidas.
   2. Usar vencimientos periódicos por seguridad. Ejemplo: cada 30 o 60 días. Esto reduce riesgos si una clave llega a filtrarse o queda expuesta.
4. Agrega los recursos: en la sección de Agregar permisos casilla Opción, selecciona de la lista los endpoints, es decir los puntos de acceso con los que interactuará el servicio API. Ejemplos:
   1. Biométrico: para comunicarse con un sistema biométrico.
   2. Empleado: consultar o crear empleados, entre otros.
5. Asigna el tipo de permiso: define que puede hacer la integración en la casilla Tipo de permiso (esto evita que una integración tenga más acceso del necesario):
   1. Lectura → solo consultar información.
   2. Escritura → crea o actualiza datos.
6. Agregar antes de guardar: oprime el botón Agregar, el cual te permite crear una o varias opciones de acceso. Si se asignan varias opciones se recomienda que tengan relación entre si.
7. Guardar: es el último paso, al dar clic se guardará la configuración API key.

Asi podrás observar la opción antes de oprimir el botón Guardar, para que el registro API quede guardado y listo para utilizarse.

Al guardar la nueva llave de integración, aparecerá una ventana donde podrás copiar la API key.

Esta ventana no se mostrará nuevamente y debes copiar la llave.

🔒 Importancia de seguridad en la creación de la API key

Esta página controla accesos equivalentes a un usuario técnico.

Por eso:

• La API key NO debe enviarse por correo sin protección.
• No debe publicarse en código visible.
• Si se filtra → debe revocarse inmediatamente. Acción. deshabilitar la API key.
• Idealmente crear una clave por integración (no una sola para todo).

⚙️ ¿Qué permite hacer una API Key aquí?

Con una API Key usted puede, por ejemplo:

• Integrar Bitákora con:
  • ERP contables (como SINCO ERP)
  • Biométricos o relojes de marcación (como GeoVictoria)
  • Apps internas de la empresa
  • Portales de empleados
• Consultar información automáticamente:
  • Empleados
  • Nómina
  • Novedades
  • Pagos
• Enviar información hacia Bitákora desde otro sistema.

En resumen:
👉 habilita la comunicación sistema-a-sistema (machine to machine).

Modificación de la API key

La llave que creaste solo la vas a ver justo al guardar. Después no podrás consultarla de nuevo.

Qué hacer si la pierdes:

• Desactiva esa llave.
• Crea una nueva desde cero.

Podrás realizar las siguientes acciones:

1. Ver los permisos asignados
2. Deshabilitar la API key