En esta guía te explicamos cómo funciona la API REST de Buk y el procedimiento detallado para conectar tus sistemas externos con nuestra plataforma. Una API REST (Representational State Transfer) es un conjunto de reglas que permite a diferentes aplicaciones comunicarse e interactuar con los recursos de un servidor mediante solicitudes estándar como GET, POST, PUT y DELETE. Estos recursos se identifican mediante URIs y se representan habitualmente en formato JSON (el más utilizado) o XML.
A través de la API de Buk podrás exportar, inyectar, actualizar y buscar información de forma bidireccional entre Buk y tus sistemas configurados, facilitando el traspaso automatizado de datos. Una vez confirmada la integración con tus aplicaciones, la conexión se habilita mediante la generación de un token de acceso seguro dentro de tu plataforma.
API BUK.
¿Cómo puedo acceder a la API de Buk?
Documentación Relevante:
¿Cómo me conecto al API de BUK?
1. Checklist de Conexión
Obtener API Key (auth_token): Debe generarse desde la plataforma BUK (Configuración > Accesos API).
Identificar la URL del Tenant: Su dominio base será https://{NombreTenant}.buk.cl.
Definir el País: La estructura del endpoint depende obligatoriamente del país (ej. /api/v1/chile, /api/v1/mexico).
Configurar Permisos: El token debe tener permisos de lectura sobre los módulos que desea consultar (ej. Empleados).
Whitelist de IP (Opcional): Si el cliente lo requiere, configure las IPs autorizadas para consumir la API.
2. Estructura de la Petición
Header Key: auth_token.
Header Value: Su API Key.
Content-Type: application/json.
3. Ejemplo Ejecutable (curl)
Nota: Reemplace {{TENANT}} por su subdominio y {{AUTH_TOKEN}} por su clave real.
curl -X GET \ "https://{{TENANT}}.buk.cl/api/v1/chile/employees?page_size=25&page=1" \ -H "auth_token: {{AUTH_TOKEN}}" \ -H "Accept: application/json"
4. Reglas de Negocio y Seguridad
Multi-idioma: La documentación está disponible en inglés, español y portugués.
Flujo de datos: La API permite recibir y entregar datos, pero no envía información a sistemas externos de forma nativa (push), salvo mediante Webhooks.
Tokens Modulares: Es posible y recomendable generar tokens con alcance limitado a ciertas entidades para mayor seguridad.
Límites: Actualmente no existe un límite definido en la cantidad de tokens que puede crear el administrador.