En este artículo te guiaremos paso a paso para que aprendas a conectar e integrar automáticamente tus distintos sistemas informáticos con Buk. De esta manera, podrás mantener la información de tus trabajadores siempre actualizada, accesible y sincronizada entre todas tus plataformas de forma sencilla.
Antes de comenzar el procedimiento práctico, es importante entender ¿qué es una API? Las siglas API provienen del inglés Application Programming Interface (Interfaz de Programación de Aplicaciones). En palabras sencillas, una API es un conjunto de métodos y procedimientos que ofrece un software para actuar como una capa de abstracción, permitiendo que diferentes sistemas interactúen entre sí de manera directa, clara y fluida.
En Buk formamos parte activa del ecosistema de software y alentamos la integración entre plataformas. Por ello, contamos con una API completa que permite exportar datos desde Buk hacia las aplicaciones que configures, así como recibir e importar información que alimente directamente a nuestro sistema.
Paso a paso
Paso 1: Confirma la integración e ingresa al menú de configuración
Para comenzar, asegúrate de haber confirmado previamente la integración con tus sistemas Partners. Una vez listo, ingresa a la plataforma de Buk. Para iniciar con la creación de las credenciales de acceso, debes seguir la siguiente navegación dentro del sistema:
RUTA:
Configuración → Accesos API → Crear nueva API Key
En esta sección podrás gestionar las claves de conexión. Ten en cuenta que si visualizas la opción de "Accesos API" deshabilitada o en color gris, significa que tu empresa aún no tiene contratado este módulo. Si la opción está activa, dirígete al botón "Crear nueva API Key" y haz clic en él para dar inicio a la generación de tu nuevo token.
Paso 2: Configura los permisos y la privacidad del token
Una vez que presiones el botón para crear la API Key, el sistema desplegará un formulario con diferentes campos que debes ir completando según lo que necesites para tu integración:
Datos sensibles: Selecciona si deseas permitir que el sistema externo pueda leer información confidencial del empleado (por ejemplo, el sueldo). Se recomienda como buena práctica crear un token de acceso independiente por cada sistema que quieras conectar a Buk.
Alcance por empresas: Haz clic en los casilleros correspondientes si prefieres limitar el acceso a una empresa en particular o si prefieres escoger todas las empresas.
-
Nivel de permisos: En cuanto a los accesos a la plataforma, podrás escoger entre las siguientes opciones:
Lectura: Con esta opción, la API solo verá la lista de empleados, resguardando y ocultando su información sensible.
Lectura y modificación: Con esta opción, la API tendrá la facultad tanto de consultar como de editar o modificar la información en Buk.
Paso 3: Actualiza y guarda la configuración de la clave
Una vez que hayas completado los campos requeridos según tus necesidades, dirígete a la parte inferior y haz clic en la opción "Actualizar API Key". Inmediatamente después de realizar este paso, no olvides hacer clic en el botón "Guardar". Al presionar este botón, el sistema registrará los parámetros configurados y la clave quedará creada correctamente.
Paso 4: Obtén y registra el código del Token
Luego de haber guardado la clave, volverás a la pantalla donde se lista tu API Key creada. Para obtener el código, ubica la clave que acabas de configurar y haz clic en el ícono del "Ojo".
Al realizar esta acción, el sistema desplegará en pantalla el código alfanumérico (Token). Debes copiar este código y registrarlo en el servidor o sistema externo que vas a conectar con Buk, permitiendo así que ambas plataformas se reconozcan e integren.
Paso 5: Ingresa a la documentación pública de la API
Ahora que ya cuentas con tu token de acceso, el siguiente paso es ingresar a la documentación técnica para conocer los métodos disponibles. La documentación es pública y puedes acceder a ella ingresando a la URL de tu empresa seguida de la extensión /apidocs.
Por ejemplo, si la plataforma de tu empresa se llama Proyecto Perú, la dirección web de acceso será: [https://proyectoperu.buk.pe/apidocs] (asegurándote de seleccionar el país correspondiente, como Perú).
Paso 6: Autentícate para habilitar las pruebas en vivo
Una vez que te encuentres dentro del portal de documentación, verás las opciones para interactuar con los servicios de Buk. Para autenticarte y habilitar las pruebas en vivo, busca en la parte superior el botón que dice Authorize. Pincha en él e ingresa el Token de acceso que obtuviste en el Paso 4. Verás que el sistema validará tu clave y te dejará listo para interactuar con la API en tiempo real.
Paso 7: Explora los Endpoints y realiza pruebas en tiempo real
A continuación, podrás visualizar todos los métodos o "Endpoints" disponibles que puedes utilizar en nuestro sistema. Para desplegar y revisar las opciones de cada menú, haz clic en el botón "Mostrar/Ocultar" y luego selecciona "Listar".
Para realizar una prueba en vivo, selecciona el Endpoint de tu interés y haz clic en el botón "¡Pruébalo!". Al presionar este botón, el sistema procesará la solicitud e inmediatamente te responderá en pantalla con la información solicitada en su formato correspondiente.
Resultado esperado
Si realizaste el procedimiento correctamente, habrás generado tu token de acceso con los permisos correspondientes y verificado su funcionamiento a través de la documentación. A partir de este momento, tus sistemas conectados podrán interactuar con Buk para leer y alimentar datos de forma automática, manteniendo toda la información de tus colaboradores sincronizada entre plataformas.
Consideraciones adicionales
Módulo no contratado: Si la opción Accesos API dentro de Configuración se encuentra deshabilitada (en gris), ponte en contacto con tu ejecutivo comercial o administrador para contratar el módulo de integraciones.
Seguridad e independización: Es altamente recomendable generar una API Key única por cada software externo que integres a Buk, asignando solo los permisos estrictamente necesarios (Lectura o Lectura y modificación) para resguardar la privacidad de los datos de tu empresa.