Referencia de API

Todos los endpoints usan el prefijo global /api. La documentacion interactiva Swagger esta disponible en {BOOST_API_URL}/api cuando el servidor esta corriendo.

Autenticacion y sesion

Metodo	Ruta	Auth	Descripcion
POST	/auth/login	–	Login con email + password + entity_id
POST	/auth/change-entity	JWT	Cambiar entidad activa
GET	/auth/my-entities	JWT	Listar entidades accesibles
POST	/auth/zauru-session/sync	JWT	Forzar sync de sesion Zauru
GET	/auth/zauru-session	JWT	Snapshot de sesion Zauru
DELETE	/auth/zauru-session	JWT	Limpiar sesion Zauru

Usuarios, empleados y roles

Usuarios (/users)

Metodo	Ruta	Auth	Descripcion
POST	/users	JWT	Crear usuario
GET	/users/:id	JWT	Obtener usuario
PATCH	/users/:id	JWT	Actualizar usuario

Entidades (/entities)

Metodo	Ruta	Auth	Descripcion
POST	/entities	JWT	Crear entidad (empresa)
GET	/entities/:id	JWT	Obtener entidad
PATCH	/entities/:id	JWT	Actualizar entidad

Empleados (/employees)

Metodo	Ruta	Auth	Descripcion
POST	/employees	JWT	Crear empleado
GET	/employees	JWT	Listar empleados
GET	/employees/:id	JWT	Obtener empleado
PATCH	/employees/:id	JWT	Actualizar empleado
POST	/employees/search	JWT	Buscar empleado

Roles (/roles)

Metodo	Ruta	Auth	Descripcion
POST	/roles	roles.create	Crear rol
GET	/roles	roles.view	Listar roles
GET	/roles/:id	roles.view	Obtener rol
PATCH	/roles/:id	roles.edit	Actualizar rol

Suscripciones (/subscriptions)

Metodo	Ruta	Auth	Descripcion
POST	/subscriptions	subscriptions.create	Crear suscripcion
GET	/subscriptions	subscriptions.view	Listar suscripciones
GET	/subscriptions/:id	subscriptions.view	Obtener suscripcion
PATCH	/subscriptions/:id	subscriptions.edit	Actualizar suscripcion
POST	/subscriptions/search	subscriptions.view	Buscar suscripcion

Permisos (/permissions)

Metodo	Ruta	Auth	Descripcion
GET	/permissions/schema	JWT	Schema de permisos (ETag cache)
GET	/permissions/me	JWT	Permisos efectivos del usuario
GET	/permissions	permissions.catalog.view	Catalogo de permisos en BD

Cartera – Grupos, Leads y Contactos

Grupos (/groups)

Metodo	Ruta	Auth	Descripcion
POST	/groups	groups.create	Crear grupo
GET	/groups	groups.view	Listar grupos (paginado)
GET	/groups/cartera-page	groups.view	Pagina unificada de cartera
GET	/groups/cartera-seller-options	groups.view	Opciones de vendedor para filtros
GET	/groups/cartera-filter-metadata	groups.view	Metadata de filtros (categorias)
GET	/groups/cartera-dates	groups.view	Fechas por IDs de grupo
GET	/groups/purchase-summaries	groups.view	Resumenes de compra por IDs
GET	/groups/:id	groups.view	Obtener grupo
PATCH	/groups/:id	groups.edit	Actualizar grupo
POST	/groups/search	groups.view	Buscar grupo
GET	/groups/global-search	groups.view	Busqueda global (grupos+leads+contactos)

Grupos – Sub-recursos

Metodo	Ruta	Auth	Descripcion
GET	/groups/:id/historico	groups.view	Historial de compras
GET	/groups/:id/recurring-purchases	groups.view	Compras recurrentes por supercategoria
GET	/groups/:id/supercategory-sales	groups.view	Ventas por supercategoria (4 meses)
GET	/groups/:id/fiscal-info	groups.view	Info fiscal desde Zauru
GET	/groups/:id/invoices	groups.view	Facturas desde Zauru
GET	/groups/:id/invoices/:invoiceId	groups.view	Detalle de factura
GET	/groups/:id/payments	groups.view	Documentos/catalogos de pago
POST	/groups/:id/payments	groups.edit	Crear pago en Zauru (multipart)

Leads (/leads)

Metodo	Ruta	Auth	Descripcion
POST	/leads	leads.create	Crear lead
GET	/leads	leads.view	Listar leads
GET	/leads/:id	leads.view	Obtener lead
PATCH	/leads/:id	leads.edit	Actualizar lead
POST	/leads/search	leads.view	Buscar lead
GET	/leads/:id/quotes	JWT	Cotizaciones del lead
GET	/leads/:id/orders	JWT	Pedidos del lead

Contactos (/contacts)

Metodo	Ruta	Auth	Descripcion
POST	/contacts	contacts.create	Crear contacto
GET	/contacts	contacts.view	Listar contactos
GET	/contacts/:id	contacts.view	Obtener contacto
PATCH	/contacts/:id	contacts.edit	Actualizar contacto
DELETE	/contacts/:id	contacts.edit	Eliminar contacto
POST	/contacts/search	contacts.view	Buscar contacto

Asignaciones de vendedor

Metodo	Ruta	Auth	Descripcion
POST	/group-assignments	group_assignments.manage	Asignar vendedor a grupos
GET	/group-assignments	group_assignments.manage	Listar asignaciones
POST	/lead-assignments	lead_assignments.manage	Asignar vendedor a leads
POST	/contact-assignments	contact_assignments.manage	Asignar vendedor a contactos

Cuentas de canal por entidad (/entity-channel-accounts)

Metodo	Ruta	Auth	Descripcion
POST	/entity-channel-accounts	entity_channel_accounts.create	Crear cuenta de canal
GET	/entity-channel-accounts	entity_channel_accounts.view	Listar cuentas
GET	/entity-channel-accounts/:id	entity_channel_accounts.view	Obtener cuenta
PATCH	/entity-channel-accounts/:id	entity_channel_accounts.edit	Actualizar cuenta

Campos personalizados

Tipos (/custom-field-types)

Metodo	Ruta	Auth	Descripcion
GET	/custom-field-types	custom_field_types.view	Listar tipos de campo

Grupos de campos (/custom-field-groups)

Metodo	Ruta	Auth	Descripcion
POST	/custom-field-groups	custom_field_groups.create	Crear grupo
GET	/custom-field-groups	custom_field_groups.view	Listar grupos
PATCH	/custom-field-groups/:id	custom_field_groups.edit	Actualizar grupo

Campos (/custom-fields)

Metodo	Ruta	Auth	Descripcion
POST	/custom-fields	custom_fields.create	Crear campo
GET	/custom-fields	custom_fields.view	Listar campos
PATCH	/custom-fields/:id	custom_fields.edit	Actualizar campo

Valores

Metodo	Ruta	Auth	Descripcion
GET	/custom-field-values/groups/:id	groups.view	Valores de un grupo
PUT	/custom-field-values/groups/:id	groups.edit	Guardar valores de grupo
GET	/custom-field-values/leads/:id	leads.view	Valores de un lead
PUT	/custom-field-values/leads/:id	leads.edit	Guardar valores de lead
GET	/custom-field-values/contacts/:id	contacts.view	Valores de un contacto
PUT	/custom-field-values/contacts/:id	contacts.edit	Guardar valores de contacto

Catalogo de productos

Catalogos de referencia (/catalogs)

Metodo	Ruta	Auth	Descripcion
GET	/catalogs/currencies	groups.view	Monedas (Zauru)
GET	/catalogs/departments	groups.view	Departamentos (Zauru)
GET	/catalogs/municipalities	groups.view	Municipios (Zauru)
GET	/catalogs/payment-methods	groups.view	Metodos de pago (Zauru)
GET	/catalogs/agencies	groups.view	Agencias (Zauru)

Catalogo (/catalogo)

Metodo	Ruta	Auth	Descripcion
GET	/catalogo/media	–	Proxy publico de media (Zauru/Cloudinary)
GET	/catalogo/context	catalog.view	Contexto: categorias, agencias, stock
GET	/catalogo/products	catalog.view	Listado de productos/bundles
GET	/catalogo/products/:catalogId	catalog.view	Detalle de producto/bundle
POST	/catalogo/stock-preview	catalog.view	Preview de disponibilidad de stock

Pedidos y cotizaciones

Pedidos (/orders)

Metodo	Ruta	Auth	Descripcion
GET	/orders/context	orders.create	Contexto para checkout
POST	/orders/compose	orders.create	Composicion server-side
POST	/orders	orders.create	Crear pedido en Zauru (multipart)
GET	/orders/:id	orders.view	Detalle de pedido
GET	/orders/:id/edit-context	orders.create	Contexto de edicion
POST	/orders/:id/compose-edit	orders.create	Composicion de edicion
PATCH	/orders/:id	orders.create	Actualizar pedido en Zauru (multipart)

Cotizaciones (/quotes)

Metodo	Ruta	Auth	Descripcion
GET	/quotes/context	quotes.create	Contexto de cotizacion
POST	/quotes/compose	quotes.create	Composicion server-side
POST	/quotes	quotes.create	Crear cotizacion (multipart: pdf, imagen, logo, video, brochure)
GET	/quotes/:id	quotes.view	Obtener cotizacion
GET	/quotes/:id/edit-context	quotes.create	Contexto de edicion
POST	/quotes/:id/compose-edit	quotes.create	Composicion de edicion
PATCH	/quotes/:id	quotes.create	Actualizar cotizacion (multipart)
POST	/quotes/:id/approve	quotes.create	Aprobar cotizacion
POST	/quotes/:id/reject	quotes.create	Rechazar cotizacion
POST	/quotes/:id/duplicate	quotes.create	Duplicar cotizacion

Checkout publico (sin autenticacion)

Metodo	Ruta	Auth	Descripcion
GET	/quotes/checkout/:checkoutId	–	Pagina publica de checkout
POST	/quotes/checkout/:checkoutId/public-decision	–	Aceptar/rechazar cotizacion

Plantillas de cotizacion (/quotes/templates)

CRUD completo para plantillas de cotizacion. Requiere JWT.

Kanban / Oportunidades (/kanban)

CRUD completo para oportunidades, estados de funnel, eventos de oportunidad, vinculacion de cotizaciones/pedidos, merge de oportunidades. Permiso requerido: quotes.create.

Agenda (/agenda)

Metodo	Ruta	Auth	Descripcion
GET	/agenda/context	JWT	Contexto de agenda
GET	/agenda/events	JWT	Listar eventos
GET	/agenda/events/:id	JWT	Obtener evento
POST	/agenda/events	quotes.create	Crear evento
PATCH	/agenda/events/:id	quotes.create	Actualizar evento

Notificaciones (/notifications)

Metodo	Ruta	Auth	Descripcion
GET	/notifications	JWT	Listar notificaciones (paginado)
POST	/notifications/read	JWT	Marcar como leidas

Media / Almacenamiento (/media)

Metodo	Ruta	Auth	Descripcion
POST	/media/presign-upload	groups.edit	Obtener URL presignada de upload (S3)
POST	/media/finalize-upload	groups.edit	Marcar upload para procesamiento
GET	/media/uploads/:id	groups.edit	Estado del upload
GET	/media/presign-download	groups.view	URL presignada de descarga
GET	/media/public	–	Servir media publica optimizada

Configuracion global (/global-settings)

GET de todos los settings + PUT individual para cada uno:

• invoice_history_months – Meses de historial de facturas
• cartera_pay_orders – Habilitar pago de pedidos
• cartera_pay_invoices – Habilitar pago de facturas
• catalog_stock_agency_ids – IDs de agencia para stock
• catalog_quote_extra_agency_ids – IDs extra para cotizaciones
• default_order_payment_term_id – Termino de pago por defecto
• cartera_recurring_purchases – Habilitar compras recurrentes
• kanban_automations_enabled – Habilitar automatizaciones kanban

Interacciones y webhooks

Ver las paginas dedicadas:

• Interacciones y Mensajeria
• Webhooks

Referencia privada: La documentacion interactiva Swagger con schemas completos esta en {BOOST_API_URL}/api. Ver tambien BoostAPI/.http y BoostAPI/essss.http para requests de ejemplo.