Skip to content
Iniciar sesión
Veridien Docs

Visión general de la API

La API de Veridien es una interfaz REST a los datos de tu establecimiento: disponibilidad y tarifas, huéspedes y fidelidad, reservas y cuentas. Es el mismo motor que mueve los flujos de reserva del propio Veridien, expuesto para que construyas encima un motor de reservas a medida, una app móvil para huéspedes, una integración de fidelidad o cualquier automatización de back office.

Es una API HTTP/JSON sin más. Te autenticas con una clave de API, envías y recibes JSON, y te apoyas en códigos de estado estándar. Todo está acotado a un único establecimiento, así que una clave solo puede leer o modificar los datos del establecimiento al que pertenece.

Pensada para aplicaciones reales

Esta API mueve de principio a fin el flujo de reserva y fidelidad en vivo de los establecimientos Veridien: buscar disponibilidad, bloquear inventario, registrar un huésped, confirmar una reserva con pago, anotar cargos en la cuenta y acumular o canjear puntos de fidelidad. Sigue el Inicio rápido para recorrer tú mismo todo ese flujo.

Todas las peticiones van a una única URL base con versión:

https://veridien.app/api/v1

Cada ruta de esta referencia es relativa a esa base. La comprobación de estado, por ejemplo, es https://veridien.app/api/v1/health.

Las peticiones se autentican con una clave de API bearer en la cabecera Authorization:

Authorization: Bearer vrdn_live_xxxxxxxxxxxxxxxxxxxx

Cada clave está vinculada a un establecimiento y lleva un conjunto de ámbitos que deciden a qué endpoints puede llamar. Crea y gestiona las claves en el panel, en Ajustes → Claves de API. Los endpoints meta públicos (/health, /openapi.json) no necesitan clave; todo lo demás sí.

Consulta Autenticación para ver el formato de la clave, la lista completa de ámbitos y un ejemplo funcional.

  • JSON de entrada, JSON de salida. Envía Content-Type: application/json en las peticiones con cuerpo. Los nombres de campo van en snake_case (room_type_id, check_in_date).
  • El dinero son cadenas. Los importes son cadenas decimales con dos decimales ("249.00") para evitar el redondeo de coma flotante. La moneda es un código ISO de 3 letras.
  • Las fechas son cadenas. Las fechas de calendario son YYYY-MM-DD. Las marcas de tiempo son ISO 8601 (2026-06-19T08:30:00.000Z).
  • Los errores son uniformes. Cada fallo devuelve el mismo sobre error con un code legible por máquina y un request_id.
  • Los reintentos son seguros. Las peticiones que modifican datos aceptan una Idempotency-Key, así que un reintento nunca cobra ni reserva dos veces.

Las reglas completas están en Convenciones.

ÁreaEndpoints
CatálogoDatos del establecimiento, tipos de habitación, disponibilidad y tarifas filtradas por visibilidad. Consulta Establecimiento y catálogo.
OfertasLista las tarifas y los paquetes públicos, y valida un código promocional antes de dar un precio. Consulta Ofertas y códigos promocionales.
HuéspedesRegistra o vincula un huésped, lee y actualiza perfiles, consulta la fidelidad, canjea puntos. Consulta Huéspedes y fidelidad.
ReservasBloquea inventario, convierte un bloqueo en una reserva pagada, lista y lee reservas, cancela. Consulta Reservas.
CuentasLee la cuenta de una reserva y anótale cargos. Consulta Cuentas.

La API se versiona en la ruta (/api/v1). Los cambios incompatibles hacia atrás salen bajo una versión nueva; los cambios aditivos (endpoints nuevos, campos opcionales nuevos) se hacen dentro de v1. Trata los campos de respuesta desconocidos como aditivos e ignóralos en lugar de fallar.

Una descripción OpenAPI 3.1 legible por máquina de cada endpoint se sirve, sin autenticación, en:

GET https://veridien.app/api/v1/openapi.json

Úsala para generar clientes tipados o para confirmar exactamente qué endpoints y qué formas están desplegados. Es la fuente de verdad y siempre coincide con la API en ejecución.