Objetivo, alcance y limitaciones:
Este artículo tiene como objetivo explicar cómo integrarse a Buk Capacitaciones mediante su API. Su alcance incluye la obtención de una API Key, el acceso a la documentación y una descripción general de los recursos disponibles. No abarca detalles de desarrollo avanzado ni configuraciones personalizadas fuera de la documentación oficial.
🧠 Antes de partir, ¿Qué es una API?
Una API (Application Programming Interface) es un conjunto de reglas que permite que diferentes sistemas de software se comuniquen entre sí de manera segura y estructurada. Puedes imaginarla como un puente que conecta distintas aplicaciones para compartir información automáticamente, sin necesidad de intervención manual.
🤝 ¿El módulo de Capacitaciones cuenta con API disponible?
Sí. En Buk Capacitaciones fomentamos la integración con otros sistemas, por lo que contamos con una API pública y documentada. Esto te permitirá:
- Exportar información desde Buk Capacitaciones.
- Inyectar datos desde otros sistemas externos (por ejemplo, ERP o CRMs).
- Automatizar procesos y mantener plataformas sincronizadas.
🔐 ¿Cómo acceder a la API del módulo de Capacitaciones?
Para comenzar, necesitarás generar una clave de acceso (API Key). Esta clave permite identificarte y proteger la comunicación entre sistemas.
Pasos para obtener tu API Key:
- Ingresa a las configuraciones generales (ícono de tuerca)
- Selecciona la opción “Accesos API”.
- Desde ahí puedes:
- Generar una nueva clave.
- Consultar claves existentes para usarlas en tus integraciones.
- Generar una nueva clave.
📚 ¿Dónde encuentro la documentación de 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 “buk.cl”, la URL sería https://superdemo.buk.cl/capacitaciones/docs. Por otra parte, si tu empresa es Buk y usas el dominio “buk.cl”, la URL sería https://buk.buk.cl/capacitaciones/docs. De igual forma se te comparte el enlace para acceder como se muestra en la imagen previa.
Una vez en la documentación, puedes probar la API en vivo autenticándose con la APIKEY a través del botón Authorize.
Después, más abajo, puedes ver todos los endpoints o métodos disponibles y que puedes utilizar en nuestro 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.
Ahí puedes configurar los diferentes parámetros que puede recibir la API (puedes dejarlos en blancos y usará valores por defecto), darle a “Execute” para probar el endpoint.
Con esto podrá obtener la respuesta que entregará el endpoint de la API.
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!
🧩 Anexo: Lista de Endpoints disponibles
|
CustomCategory
GET /capacitaciones/api/categories/{id}/entities Returns the entities associated with category options of a specific category. |
¿Qué dato es?
Considerando el id una categoría customizada, recupera todas las opciones asociadas a esa categoría. Por cada opción se muestra:
|
|
CustomCategory
GET /capacitaciones/api/custom_categories Retrieves the collection of CustomCategory resources. |
Recupera todas las categorías customizadas existentes para este tenant.Se muestra la siguiente información por categoría:
|
|
CustomCategory
GET /capacitaciones/api/custom_categories/{id} Retrieves a CustomCategory resource. |
Recupera la información de una categoría customizada en concreto. Se muestra la siguiente información:
|
|
CourseAttendee
GET /capacitaciones/api/course_attendees Retrieves the collection of CourseAttendee resources. |
Recupera todos los CourseAttendee de la plataforma. Representa a un usuario que hizo X Curso y cual fue nota, progreso, etc. La información de entrega por cada CourseAttendee es:
|
|
CourseAttendee
GET /capacitaciones/api/course_attendees/{id} Retrieves a CourseAttendee resource. |
Recupera un CourseAttendee por ID. Representa a un usuario que hizo X Curso y cual fue nota, progreso, etc. La información de entrega por cada CourseAttendee es:
|
|
Course
GET /capacitaciones/api/courses Retrieves the collection of Course resources. |
Trae la información de todos los cursos existentes en la plataforma. Entrega la siguiente información por curso:
|
|
Course
GET /capacitaciones/api/courses/{id} Retrieves a Course resource. |
Entrega la siguiente información de un curso en particular, filtrado por id:
|
|
Course
GET /capacitaciones/api/courses/{id}/training_courses Retrieves a Course resource. |
Trae todas las imparticiones de un curso en particular, filtrado por el id del curso. Entrega la información:
|
|
TrainingCourse
GET /capacitaciones/api/training_courses Retrieves the collection of TrainingCourse resources. |
Trae la información de todas las imparticiones existentes en la plataforma. Entrega la siguiente información para las impaticiones recuperadas:
|
|
TrainingCourse
GET /capacitaciones/api/training_courses/{id} Retrieves a TrainingCourse resource. |
Trae la información de una impartición, filtrada por id. Entrega la siguiente información:
|
|
Curriculum
GET /capacitaciones/api/curriculums Retrieves the collection of Curriculums resources. |
Trae la información de todas las Mallas/Rutas de Aprendizaje existentes en la plataforma. Entrega la siguiente información para las mallas recuperadas:
|
|
Curriculum
GET /capacitaciones/api/curriculums/{id} Retrieves a Curriculum resource. |
Trae la información de una Malla/Ruta de Aprendizaje en particular de la plataforma, según id. Entrega la siguiente información para la malla recuperada:
|
|
CurriculumAttendee
GET /capacitaciones/api/curriculum_attendees Retrieves the collection of CurriculumAttendee resources. |
Trae la información de todas las inscripciones en Mallas/Rutas de Aprendizaje existentes en la plataforma. Entrega la siguiente información para las mallas recuperadas:
|
|
CurriculumAttendee
GET /capacitaciones/api/curriculum_attendees/{id} Retrieve a CurriculumAttendee resource. |
Trae la información de una inscripción en una Malla/Ruta de Aprendizaje en particular de la plataforma, según id. Entrega la siguiente información para la malla recuperada:
|
|
LMSCourse
GET /capacitaciones/api/l_m_s_courses Retrieves the collection of LMSCourse resources. |
Trae la información de todos los cursos e-learning existentes en la plataforma. Entrega la siguiente información por curso:
|
|
LMSCourse
GET /capacitaciones/api/l_m_s_courses/{id} Retrieves a LMSCourse resource. |
Entrega la siguiente información de un curso en particular, filtrado por id:
|
|
LMSCourse
GET /capacitaciones/api/l_m_s_courses/{id}/training_courses Retrieves a LMSCourse resource. |
Trae todas las imparticiones de un curso en particular, filtrado por el id del curso. Entrega la información:
|
|
Speaker
GET /capacitaciones/api/speakers Retrieves the collection of Speaker resources. |
Recupera la información de todos los relatores de la plataforma. Entrega esta información:
|
|
Speaker
GET /capacitaciones/api/speakers/{id} Retrieves a Speaker resource. |
Recupera la información de un relator, por id. Entrega esta información:
|
|
TrainingCenter
GET /capacitaciones/api/training_centers Retrieves the collection of TrainingCenter resources. |
Recupera la información de todos los proveedores de capacitación de la plataforma. Por cada proveedor entrega esta información:
|
|
TrainingCenter
GET /capacitaciones/api/training_centers/{id} Retrieves a TrainingCenter resource. |
Recupera la información de un proveedor de capacitación, por id. Entrega esta información:
|
|
UserAuthenticatedSessionUrl
POST https://superdemo.boostworld.com/capacitaciones/api/user_authenticated_session_urls Creates a temporary URL to start a Boost session for the specified user. This Url is authenticated and no login page is showed to the user. |
Para un cierto usuario (entregado por id) se le genera una URL de acceso autenticada. Entrega la siguiente información:
|
|
UserAuthenticatedSessionUrl GET /capacitaciones/api/user_authenticated_session_urls/{id} Retrieves a UserAuthenticatedSessionUrl resource. |
Para un cierto usuario (entregado por id) se le genera una URL de acceso autenticada. Entrega la siguiente información:
|
|
User
GET /capacitaciones/api/users Retrieves the collection of User resources. |
Entrega una lista de los usuarios de la plataforma. Por cada usuario entrega la siguiente información:
|
|
User
GET /capacitaciones/api/users/{id} Retrieves a User resource. |
Para un usuario en particular, filtrado por id, se entrega la siguiente información:
|
|
User
GET /capacitaciones/api/users/{id}/actions Returns the pending actions required by the user. |
Para un usuario en concreto, filtrado por id, se entrega información de los cursos que tiene pendiente por realizar. Contiene la siguiente información por curso pendiente:
|
|
User
GET /capacitaciones/api/users/{id}/kpis Return of KPIs of the user. |
Entrega los indicadores para un usuario en concreto. Se detalla la siguiente información:
|
Recuerda, si necesitas ayuda puedes contactarnos a través de nuestros canales de atención.
Chat | Teléfono | Correo.
¡Felices te ayudamos!