Gestión de Claves de API para Integraciones

Aprenda a instalar el módulo de Integraciones Generales y a generar claves de API seguras (API Keys) que permiten a sistemas externos interactuar con la plataforma del hotel, controlando el acceso mediante permisos específicos y usuarios asociados.

La funcionalidad de Gestión de Claves de API le permite instalar el módulo de integraciones generales y generar claves de API (API Keys). Estas claves son tokens de acceso seguros que permiten a sistemas externos conectarse e interactuar con la plataforma del hotel de forma autorizada, heredando los permisos del usuario asociado a la clave.

Usted puede crear múltiples claves, cada una con un conjunto de permisos específicos para segmentar el acceso según la necesidad de la integración.

Instalación del Módulo de Integraciones

Para habilitar la generación y gestión de claves de API, primero debe instalar el módulo correspondiente.

1. Diríjase al Marketplace de Integraciones

   Vaya a la sección de “Integraciones” o “Marketplace” de su sistema.

   

   Vista del marketplace de integraciones con múltiples tarjetas de aplicaciones.

2. Localice e instale el módulo de API Keys

   Busque la opción “Integraciones Generales (API Keys)” dentro de las integraciones disponibles y seleccione “Instalar”.

   

   Cursor del mouse sobre el botón 'Instalar' de la tarjeta 'Integraciones Generales (API Keys)'.

3. Acepte los términos y condiciones

   Acepte los términos y condiciones del servicio que se presentan en la ventana emergente. Esta ventana le informa sobre el costo asociado al servicio y los detalles del contrato.

   Marque la casilla de aceptación y presione “Instalar” para continuar.

   Lea atentamente los términos y condiciones, ya que la instalación de este módulo podría implicar costos asociados al servicio.

   

   Ventana emergente con los términos y condiciones y un botón 'Instalar'.

4. Verifique la instalación

   Una vez instalado, el sistema le redirigirá automáticamente a la pantalla de gestión “Mis API Keys”, donde podrá crear y administrar sus claves.

   Confirme que ha sido redirigido a la pantalla “Mis API Keys” y que ve el botón “Crear API Key”.

   

   Pantalla vacía con el título 'Mis API Keys' y un botón 'Crear API Key'.

Creación de una Nueva Clave de API

Desde la pantalla de gestión “Mis API Keys”, usted puede generar nuevas claves para diferentes integraciones.

1. Inicie la creación de una nueva clave

   Haga clic en el botón “Crear API Key” para iniciar el proceso de creación de una nueva clave.

   

   Cursor del mouse haciendo clic en el botón rojo 'Crear API Key'.

2. Configure los detalles de la clave

   Complete el formulario “Crear nueva API Key” con los detalles de su nueva clave.

   

   Formulario 'Crear nueva API Key' con campos como Nombre y Usuario asociado.

   Debe definir los siguientes campos:

   • Nombre: Asigne un nombre descriptivo que le permita identificar el propósito de la clave, por ejemplo, “API key de prueba para CRM”.
   • Usuario asociado: Seleccione un usuario existente del sistema. La clave de API operará con los permisos de este usuario. Todas las acciones realizadas a través de la API se registrarán como si las hubiera hecho el usuario seleccionado.
   • Expiración: Establezca un período de validez para la clave.
     Se recomienda seleccionar un período de expiración definido (por ejemplo, “12 meses”) para mejorar la seguridad y requerir una rotación periódica de claves.

   • Alcance: Defina a qué recursos tendrá acceso la clave.
     • Implícito: Otorga acceso a todos los recursos de la propiedad actual.
     • Explícito: Le permite restringir el acceso a empresas y establecimientos específicos, lo cual es útil en entornos con múltiples propiedades.
   • Entorno: Seleccione “Producción” para que la clave sea funcional en el ambiente operativo real.

   Defina los permisos específicos: Despliegue cada sección (por ejemplo, “Hotel”, “Reservas”) y active los interruptores para conceder las autorizaciones necesarias. Esto le permite un control granular sobre las acciones que la integración externa podrá realizar, como “Consultar disponibilidad”, “Ver datos del hotel”, “Crear reservas” o “Listar reservas”.

   
3. Genere la clave de API

   Una vez que haya configurado todos los detalles y permisos, haga clic en el botón “Crear API Key” en la parte inferior del formulario para generar la clave.

   
4. Copie y guarde el token de acceso

   Copie el token de acceso generado que se muestra en la ventana emergente. Este token es su clave de API y solo se mostrará una vez por motivos de seguridad.

   

   Es fundamental copiar este token y guardarlo en un lugar seguro inmediatamente. No será posible recuperarlo después de cerrar esta ventana.

5. Cierre la ventana de confirmación

   Cierre la ventana de confirmación. El sistema le advertirá que la clave no se podrá volver a ver. Confirme la acción seleccionando “Sí, ya copié”.

   

   Asegúrese de haber copiado y guardado su token de acceso antes de confirmar.

6. Verifique la clave en la lista

   La nueva clave de API aparecerá listada en la pantalla “Mis API Keys”, mostrando su nombre, estado (Activo) y fecha de expiración. Desde aquí, usted puede gestionarla, ver sus detalles o revocarla si es necesario.

   Confirme que la nueva API Key ha sido creada y aparece correctamente en la lista.

   
7. Utilizar el apikey

   Para utilizar el apikey puede seguir los requerimientos de esta documentación oficial de la api