Objetivo, alcance y limitaciones:
Aprender a integrarse a Buk Capacitaciones a través de la API para extraer información desde el LMS. Solo los usuarios con rol súper administrador pueden acceder a las configuraciones generales y, por ende, realizar el proceso para integrarse a Buk Capacitaciones a través de la API y extraer información desde el LMS.
Definiciones:
¿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 Capacitaciones tiene alguna API disponible?
En Buk Capacitaciones 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 cierta información de ellos.
¿Qué hace una API en Buk Capacitaciones?
La API proporciona acceso a una amplia gama de datos relacionados con la gestión de capacitación, permitiendo a los usuarios recuperar información detallada sobre categorías customizadas, cursos, participantes en cursos, imparticiones, mallas de aprendizaje, inscripciones en mallas, cursos e-learning, relatores, proveedores de capacitación, y usuarios de la plataforma. Además, se pueden generar URLs autenticadas para sesiones de usuario. Los datos incluyen detalles como progreso en cursos, notas, costos, fechas, objetivos, y estado de las inscripciones, lo que facilita una gestión integral y personalizada del proceso de formación.
Proceso:
Para acceder a la API de Buk Capacitaciones, necesitas contar con una Key. Esto permitirá que solo aquellas personas que conocen la Key puedan obtener información desde este medio.
Para crear una Key, debes seguir los siguientes pasos:
1. Ingresa al menú de Administración en la esquina superior derecha y selecciona "Accesos API".
2. A continuación, podrás crear una Key o bien, utilizar una existente.
Documentación para utilizar la API
Ahora que ya tienes tu Key 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 seguida por /capacitaciones/docs.
Por ejemplo, si tu empresa se llama "superdemo" y usas el dominio “boostworld.com”, la URL sería https://superdemo.boostworld.com/capacitaciones/docs. Por otro lado, si tu emrpesa se llama "Buk" y usa el dominio “buk.cl”, la URL sería https://buk.buk.cl/capacitaciones/docs.
Una vez en la documentación, puedes probar la API en vivo autenticándose a través del botón Authorize.
A continuación, podrás ver todos los endpoints o métodos que puedes utilizar en nuestros sistema.
Por último para probar en vivo, puedes dar clic a uno de los endpoints y haciendo clic en “Try it out”, el sistema te habilitará la opción de probar el endpoint seleccionado.
En esta sección puedes configurar los diferentes parámetros que puede recibir la API (puedes dejarlos en blanco y usará valores por defecto). Para probar el endpoint, haz clic en “Execute”.
Con esta acción, obtendrás la respuesta que entregará el endpoint de la API.
¡Ya puedes disfrutar 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.
Recuerda, si necesitas ayuda puedes contactarnos a través de nuestros canales de atención.
Chat | Teléfono | Correo.
¡Felices te ayudamos!
