Antes de partir, ¿qué es una API?
Una API (Application programming interface, o en español, 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.
¿Que hace una API en Buk?
Las API permiten exportar información desde buk hacia las API configuradas, facilitando así 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.
Una vez dentro del módulo de accesos API puedes crear un nuevo token a través del botón "Crear Nueva API Key".
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.
Haz 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:
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:
Luego de esto debes revisar la API creada para hacer clic en el icono "ojo" y obtener el código (Token) que se debe registrar en el servidor que hayas contactado con la otra API, así este ingresara a su sistema para integrar
¿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 Demo, la URL sería https://demo.buk.co/apidocs.
Una vez en la documentación, puedes probar la API en vivo autenticándose a través del botón Authorize
Después más abajo en "endpoints" puedes ver todos los endpoints o métodos que puedes utilizar en nuestro sistema. Si no los visualizas, debes hacer clic en el botón "Mostrar/Ocultar"
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 formato JSON.
Disfruta datos automáticos!!
De ahora en adelante, ya puedes hacer uso de nuestra API y así tener todos tus sistemas conectados y sincronizados de manera automática!