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 “boostworld.com”, la URL sería https://superdemo.boostworld.com/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.
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, puedes ver todos los endpoints o métodos 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
|
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:
|
Recuerda, si necesitas ayuda puedes contactarnos a través de nuestros canales de atención.
Chat | Teléfono | Correo.
¡Felices te ayudamos!