Esta página explica cómo navegar la referencia API de Unified PMS en Documentation.AI.
Dónde está
Qué | Dónde |
Referencia canónica de endpoints | Este manual → pestaña API Reference |
Public API (integraciones externas) | Menú lateral Public API dentro de API Reference |
Booking Engine API (motor de reservas) | Menú lateral Booking Engine API |
Crear y gestionar claves | PMS → Configuración > API keys — ver API keys |
Paginación y FAQ para integradores | Overview → Paginación y límites y FAQ integradores |
⚠️ Advertencia: Antes de integrar búsqueda de reservas: lee Paginación y límites. La API devuelve como máximo 20 reservas por llamada; sin paginar parece que solo hay datos recientes.
⚠️ Advertencia: La fuente canónica de endpoints publicados no es una tabla manual. Usa los grupos generados del menú lateral: Public API y Booking Engine API. Esos grupos se generan desde los OpenAPI reales publicados en public-api.openapi.json y booking-engine-api.openapi.json.
Qué menú usar
En la pestaña API Reference verás tres zonas:
Overview: páginas introductorias: primeros pasos, paginación, FAQ, autenticación y esta guía.
Public API: endpoints públicos para integraciones externas autenticadas con
x-api-key.Booking Engine API: endpoints del motor de reservas autenticados con
x-booking-engine-keyy, después de autenticar, token JWT del motor.
Si buscas un endpoint real para consumir desde fuera, entra en Public API o Booking Engine API, no en una lista manual.
Public API
La Public API es la API pública pensada para integraciones externas con hoteles o partners.
Usa esta sección cuando quieras consultar o modificar datos desde un sistema externo autorizado, por ejemplo:
Propiedades y políticas públicas.
Disponibilidad y habitaciones.
Búsqueda y detalle de reservas expuestas por API.
Pagos, facturas, depósitos o documentos de una reserva cuando el endpoint esté incluido en el OpenAPI.
Webhooks salientes.
Autenticación principal:
x-api-key: <tu-api-key>
Booking Engine API
La Booking Engine API es la API usada por el motor de reservas.
Usa esta sección para flujos como:
Autenticación del motor.
Datos públicos de la propiedad.
Políticas, tipologías, disponibilidad, precios, packs y productos.
Creación de reserva desde motor.
Inicio de pago del motor.
Cabeceras principales:
x-booking-engine-key: <booking-engine-key> Authorization: Bearer <booking-engine-token>
Sobre endpoints internos del PMS
Unified tiene muchos endpoints internos usados por la aplicación web del PMS: mover reservas en el Planning, bloquear/desbloquear, cambiar colores, agrupar, redimensionar, notas internas, operaciones de recepción, etc.
Algunos existen realmente en el backend, pero no deben confundirse con la Public API publicada para integradores. Pueden requerir sesión de usuario, permisos internos, contexto de frontend, guards específicos o versiones internas.
ℹ️ Información: Si un endpoint no aparece dentro de Public API o Booking Engine API, trátalo como interno/no publicado hasta que se añada explícitamente al OpenAPI público.
Cómo verificar si un endpoint está publicado
Paso 1: Abre API Reference
Entra en la pestaña API Reference de Documentation.AI.
Paso 2: Elige la API correcta
Usa Public API para integraciones externas del PMS o Booking Engine API para motor de reservas.
Paso 3: Busca por grupo o endpoint
Abre el grupo del menú lateral, por ejemplo Bookings, Rooms, Webhooks o BookingEngine.
Paso 4: Revisa método, parámetros y ejemplos
Cada operación generada muestra método HTTP, ruta, parámetros, request body cuando aplica, respuestas y ejemplos de uso.
Qué se publicó ahora
La referencia actual está generada desde los specs reales del backend:
public-api.openapi.json: Public API.booking-engine-api.openapi.json: Booking Engine API.
Ambos specs se compararon contra los Swagger originales del backend antes de publicarse. La navegación ya no usa el antiguo openapi.yaml de ejemplo.
Si algo no aparece
Si no aparece en Public API, probablemente es un endpoint interno del PMS o todavía no está publicado para integradores.
Si no aparece en Booking Engine API, probablemente no forma parte del flujo del motor.
Si necesitas exponer un endpoint interno como API pública, primero debe revisarse autenticación, permisos, contratos de datos, estabilidad y ejemplos.
Si ves una tabla antigua o una ruta que no encaja con los grupos generados, considera esa información no canónica y avísanos para retirarla.