Una API REST (Representational State Transfer) es un conjunto de reglas que permite a diferentes sistemas comunicarse entre sí usando solicitudes como GET, POST, PUT, DELETE, para interactuar con los recursos de un servidor. Estos recursos son identificados por URIs (Uniform Resource Identifiers) y están representados en formatos como JSON o XML, aunque el formato JSON es el más común.
API BUK.
La API Rest de buk permite exportar, inyectar, actualizar y buscar 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, a través de la generación de un token en la plataforma del cliente en BUK, se puede crear el acceso a nuestra API.
Documentación Relevante:
Helpcenter:
Integrarse con buk desde la API.
Acceso a los endpoints y métodos de la API.
¿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
La autenticación se realiza enviando el token en el encabezado (header) de cada solicitud HTTP.
- Header Key: auth_token.
- Header Value: Su API Key.
- Content-Type: application/json.
3. Ejemplo Ejecutable (curl)
Este ejemplo consulta el maestro de empleados para una instancia en Chile (basado en la documentación provista).
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.