¿Qué es la API abierta?
La Open API de Stays es una interfaz que permite la integración de funcionalidades con otras plataformas. Con ella, los desarrolladores pueden crear soluciones personalizadas para su propio sistema.
¿Cómo activar la API de Stays?
Ve a [App Center > Stays API > API Externo], selecciona [Activo] y haz clic en el botón de guardar. Verás tus credenciales de acceso después de activarla.
¿Cómo funciona el cobro de la API?
El cobro es de $19 por mes. Este valor se incluirá automáticamente en tu factura y se cobrará mensualmente mientras la API esté activada en tu sistema. Es posible desactivarla en cualquier momento.
¿Stays tiene alguna asociación con un desarrollador para la API?
No tenemos ninguna asociación. Puedes contratar a un desarrollador por tu cuenta y enviarle nuestra documentación completa para que revise toda la información.
¿Qué puedo hacer con la API?
Consulta algunos ejemplos de uso de los endpoints disponibles en nuestra API.
Verifica la posibilidad de reserva y devuelve el enlace para que el huésped complete la reserva. El huésped será creado dentro del sistema Stays si no existe.
- Suele usarse para que aplicaciones externas creen reservas a través del sitio. En este caso, los datos de la reserva llegan a Stays con el nombre del socio (aplicación externa) que generó la reserva.
Códigos promocionales (cupones)
Permite crear, gestionar y leer los códigos promocionales del sistema.
- Normalmente se usa para campañas de marketing. Al combinarlo con endpoints de huésped, por ejemplo, puedes automatizar procesos de creación de cupones para cumpleaños.
Permite buscar los anuncios disponibles, calcular el precio de determinado anuncio, gestionar reservas y clientes.
- Suele usarse para gestionar reservas externamente, como en aplicaciones o páginas web externas. Con la API, es posible crear una aplicación que permita la gestión de reservas por parte de terceros (huéspedes o colaboradores), sean estas ya existentes o nuevas reservas (endpoint de creación de reserva).
Permite gestionar cuentas bancarias para pagos en el sitio web y leer los registros presentes en el balance de propietarios.
- Normalmente se usa para integrar la información bancaria en aplicaciones externas. Importante: no hay vínculo interbancario, es decir, las transacciones bancarias no ocurren a través de Stays. La integración funciona de la misma manera que nuestro sistema, solo para registro y validación de pagos.
- También es posible usarla para integrar los datos de los balances de cada propietario y, con ello, crear soluciones personalizadas.
Obtiene información sobre disponibilidad, precios y restricciones para un período determinado. Permite actualizar precios y restricciones.
- Puede ser usado para reflejar la pantalla de calendario general en un sistema de gestión externo, como PriceLabs.
Permite gestionar las reglas de precios por temporada.
- Funciona de manera similar al módulo de calendario de alojamientos. El de calendario se usa para el modelo de precios por noche, mientras que el de precios es para el modelo de precios por período.
- Normalmente se usa para la gestión externa de temporadas y eventos.
Devuelve, gestiona y crea información relacionada con los contenidos de las propiedades y alojamientos creados en el sistema. Puede ser usado para gestionar contenido descriptivo, habitaciones y grupos.
- Suele ser usado para gestionar el contenido externamente y también para crear páginas o aplicaciones externas que necesitan ser alimentadas con el contenido del sistema, como una aplicación para huéspedes.
Contempla solo la funcionalidad de campos personalizados del sistema. Son cuatro endpoints para leer, crear, editar y eliminar los campos personalizados del sistema.
- Puede ser usado para diversas operaciones. La más común es aprovechar el campo personalizado para comunicar al huésped sobre alguna información del alojamiento, como la contraseña del Wi-Fi o el voltaje del enchufe, por ejemplo.
Campos personalizados externos
Usado para personalizar la experiencia del sistema. Con él, es posible gestionar campos personalizados que serán incluidos externamente en sitios y aplicaciones, por ejemplo.
- Si necesita un campo personalizado no incluido en el sistema, puede usar este endpoint para incluir campos en un formulario de registro para una aplicación o sitio externo, por ejemplo.
Configuraciones del alojamiento
Usado para lectura de configuraciones de precio, disponibilidad y reglas de la casa. También es posible usarlo para alterar los parámetros de reglas de la casa.
- Generalmente se usa para generar filtros de búsqueda externos y también para generar información sobre los alojamientos en una página externa.
Usado para que el sistema dispare notificaciones cuando algo es alterado.
- Los clientes suelen usarlo para lógicas de creación de reservas. Cuando se crea una reserva en el sistema, podemos enviar un webhook para que esa reserva también sea creada en un calendario externo.
- Es posible crear diversas automatizaciones de alteración con los webhooks que tenemos en la documentación.