Introducción

La API Pública de Bui es una interfaz HTTP RESTful diseñada para ser consumida por las tiendas de cada tenant. Permite consultar el catálogo de productos y categorías, crear órdenes de compra y procesar pagos mediante distintas pasarelas.

URL base

Todas las rutas de la API utilizan el prefijo /api/v1:

http://api.public.bui.cl/api/v1

En producción, reemplaza el host por el dominio asignado a tu servicio.

Formato

  • Las peticiones y respuestas utilizan JSON (Content-Type: application/json).
  • Las fechas se retornan en formato ISO 8601 (UTC).
  • Los valores monetarios se retornan como strings decimales para evitar pérdida de precisión (ej. "9990.00").

Versionado

La versión actual es v1. El número de versión forma parte de la URL base. Las versiones anteriores pueden mantenerse activas durante un período de deprecación anunciado.

Módulos disponibles

MóduloDescripción
AutenticaciónCómo autenticar cada petición con un token de tienda
ProductosCatálogo de productos y variantes
CategoríasÁrbol de categorías del catálogo
ÓrdenesCreación de órdenes de compra
PagosPasarelas de pago (Transbank, MercadoPago)
ArchivosSubida de archivos para opciones de tipo FILE

Códigos de respuesta HTTP

CódigoSignificado
200OK — la petición fue exitosa
201Created — recurso creado correctamente
301Redirect — redirección permanente
400Bad Request — la petición tiene errores de formato
401Unauthorized — token ausente o inválido
404Not Found — recurso no encontrado
422Unprocessable Entity — error de lógica de negocio
500Internal Server Error — error interno del servidor