En este artículo vamos a aprender como integrar los distintos sistemas automáticamente a Buk para que puedas tener la información de tus trabajadores a través de estos sistemas.


Antes de Comenzar ¿Qué es una API?

 

Una API (Application Programming Interface) en español significa, una interfaz de programación de aplicaciones. Es un conjunto de métodos o procedimientos que ofrece un software para que  pueda ser utilizado por otro software como una capa de abstracción.


Dicho de otra manera, una API explica y permite que sistemas interactúen entre sí directamente y de manera sencilla.


¿Tiene Buk alguna API disponible?

En Buk nos gusta formar parte del ecosistema de software y alentamos la integración entre sistemas, por lo tanto, tenemos una API  completa, para que otros sistemas puedan tanto leer de nosotros, como alimentarnos directamente con información de ellos.


¿Qué hace una API en Buk?

Las API permiten exportar información desde buk hacia las API configuradas, facilitando el traspaso de información.


¿Cómo puedo acceder a la API de Buk?

Luego de haber confirmado la integración con los sistemas Partners, debes seguir los siguientes pasos:

Para acceder primero debes:
Generar un token de acceso. Esto lo puedes conseguir en: 


Configuración >> Accesos API >> Crear nueva API Key


 

Damos clic en crear nueva API Key para poder crear un token 



Al momento de crearlo, debes seleccionar si quieres que el sistema externo pueda leer datos sensibles del empleado (tales como sueldo). Se recomienda crear un token por cada sistema que quieras conectar a Buk.


Luego debes hacer clic en los cuadros si deseas limitar acceso por empresas, escoger una empresa o todas.

Con respecto a los accesos a la plataforma, existe distintos permisos como :

Lectura:  Con  esta opción solo vera los empleados y no su información sensible. 


Lectura y modificación: Con  esta opción la API podrá ver y modificar la información de Buk. 


Debes ir llenando los campos correspondientes según lo que necesitas. posteriormente debes hacer clic en >> Actualizar API Key:
 




No olvidemos que después de colocar los permisos debemos darle clic en Guardar 


Luego de haber creado la API Key debemos hacer clic en el ícono Ojo, para poder obtener el código (Token) el cual se debe registrar en el servidor que hayas conectado con la otra API, así de esta forma se podrá ingresar a su sistema para integrarse.


¿Dónde encuentro la documentación para empezar a usar la API?

Ahora que ya tienes tu token de acceso, debes ingresar a la documentación de la API. La documentación es pública y puedes acceder a través de la URL de la empresa seguido por /apidocs. Por ejemplo, si tu empresa se llama Proyecto Perú, la URL sería https:/proyectoperu.buk.pe/apidocs. Seleccionar país Perú.


Una vez en la documentación, puedes probar la API en vivo autenticándose a través del botón Authorize.




Posteriormente podrás ver todos los  Endpoints o métodos que puedes utilizar en nuestro sistema, debes hacer clic en el botón Mostrar/Ocultar>> Listar. 



Por último, para probar en vivo, puedes dar clic a uno de los  Endpoints y haciendo clic en Pruebalo!, el sistema te responderá con la información solicitada en en el formato. 


Aquí, Puedes acceder a la Documentación de la API 


A partir de ahora, podrás hacer uso de nuestras API y así tener todos tus sistemas conectados y sincronizados en forma automática. 


No dudes en contactarnos si necesitas información adicional.

¡Estamos disponibles para ayudarte!