Ir al contenido principal

Cómo leer la referencia API

Escrito por Jordi

Esta página explica cómo navegar la referencia de la Public API de Hotelgest.

Dónde está

Qué

Dónde

Referencia canónica de endpoints

Pestaña Referencia API → grupo API pública

Crear y gestionar claves

PMS → Configuración > API keys — ver API keys

Paginación y FAQ para 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 el grupo generado API pública del menú lateral: se genera desde la especificación OpenAPI publicada.

Qué menú usar

En la pestaña Referencia API verás dos zonas:

  • Resumen: páginas introductorias: primeros pasos, paginación, FAQ, autenticación y esta guía.

  • API pública: los endpoints para integraciones externas, autenticados con x-api-key.

Public API

La Public API es la API 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.

  • Disponibilidad y habitaciones.

  • Búsqueda, detalle y creación de reservas.

  • Pagos, facturas, proformas y depósitos de una reserva.

  • Webhooks salientes.

Autenticación:

x-api-key: <tu-api-key>

ℹ️ Información: Si un endpoint no aparece dentro de API pública, no está disponible para integraciones.

Cómo verificar si un endpoint está publicado

Paso 1: Abre la Referencia API

Entra en la pestaña Referencia API.

Paso 2: Busca por grupo o endpoint

Abre el grupo del menú lateral, por ejemplo Bookings, Rooms o Webhooks.

Paso 3: Revisa método, parámetros y ejemplos

Cada operación generada muestra método HTTP, ruta, parámetros, cuerpo de la petición cuando aplica, respuestas y ejemplos de uso.

Si algo no aparece

  • Si no aparece en API pública, no forma parte de la API para integradores.

  • Si necesitas un dato o una operación que no está, escríbenos a [email protected] contando tu caso de uso.

  • 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.

¿Ha quedado contestada tu pregunta?