Gestionar API keys en Hotelgest
Las API keys son esenciales para integrar tu cuenta de Hotelgest con otras aplicaciones y servicios externos. Esta guía te ayudará a generar, copiar y administrar tus claves API de forma segura y eficiente, permitiendo la automatización y conexión de tus sistemas.
Descripción general
Las API keys son credenciales únicas que permiten a sistemas externos interactuar con tu cuenta de Hotelgest de manera programática. Se utilizan para autenticar las solicitudes y asegurar que solo las aplicaciones autorizadas puedan acceder a tus datos. Encontrarás la sección de API keys dentro del menú de configuración de tu cuenta, y es crucial para cualquier integración que requiera acceso a la API de Hotelgest.
Acceder a la sección de API keys
Cuándo usarlo
Cuando necesitas generar una nueva clave API o revisar las existentes para una integración o interacción entre Hotelgest y programas externos.
Antes de empezar
Tener contratado el add-on de acceso a la API en tu cuenta de Hotelgest.
Pasos
En la esquina superior derecha de la pantalla, haz clic en el icono de ajustes.
En el menú desplegable, selecciona Configuración de cuenta.
En el menú de Configuración de cuenta haz clic en API keys.
Consultar la documentación de la API
Cuándo usarlo
Cuando el usuario o programadores terceros necesitan entender cómo funciona la API de Hotelgest, qué endpoints están disponibles o cómo estructurar las solicitudes.
Antes de empezar
Es útil revisar la documentación técnica. Esto te proporcionará la información necesaria para integrar correctamente tu cuenta con otras plataformas o desarrollar soluciones personalizadas.
Pasos
En la sección de API keys, haz clic en el botón Documentación.
Se abrirá una nueva pestaña o ventana con la documentación completa de la API de Hotelgest.
Verás la página de documentación de la API con detalles técnicos y ejemplos.
Generar una nueva API key
Cuándo usarlo
Cuando necesitas una clave de acceso única para una nueva integración o para reemplazar una clave comprometida. Crear una API key es un proceso rápido. Es fundamental que copies la clave inmediatamente después de generarla, ya que por motivos de seguridad, no podrás visualizarla de nuevo una vez que cierres la ventana de confirmación.
Pasos
En la sección de API keys, haz clic en el botón Crear API key.
En el panel lateral que se abre de Añadir Apikey, introduce una Descripción de key clara que te ayude a identificar su propósito (ej. 'Integración con CRM', 'App móvil').
Haz clic en el botón Guardar en la parte inferior del panel.
Aparecerá una ventana emergente con tu nueva API key. Haz clic en el botón Copiar para guardarla en tu portapapeles.
Verás la nueva API key listada en la tabla de la sección 'API keys' con la descripción y fecha y hora de creación.
Gestionar API keys existentes
Cuándo usarlo
Cuando necesitas controlar el estado de tus claves API, ya sea para desactivar temporalmente una integración o eliminar una clave que ya no es necesaria.
Antes de empezar
Tener al menos una API key creada. Una vez que tienes API keys generadas, puedes administrarlas directamente desde la sección 'API keys'. Esto incluye la capacidad de activarlas o desactivarlas, así como eliminarlas por completo.
Pasos
Localiza la API key que deseas gestionar en la lista.
Para activar o desactivar la clave, haz clic en el interruptor de estado bajo la columna 'Activo'.
Para eliminar la clave, haz clic en el icono de tres puntos verticales (⋮) al final de la fila de la clave y selecciona Eliminar en el menú desplegable.
Si la desactivas, el interruptor cambiará a gris. Si la eliminas, la clave desaparecerá de la lista.
Preguntas frecuentes
¿Qué hago si eliminé una API key por error y ahora mi integración no funciona?
Las API keys eliminadas no se pueden recuperar. Deberás generar una nueva API key y actualizarla en la aplicación o servicio que utilizaba la clave anterior.
¿Si desactivo una API key, luego puedo recuperarla?
Por supuesto. Desactivar una clave es útil para pausar temporalmente una integración sin tener que crear una nueva clave más tarde y que al activarla, se reactive el funcionamiento de la integración también. El interruptor cambiará de color (verde para activa, gris para inactiva).
¿Por qué no veo la sección 'API keys' en mi cuenta?
Si no encuentras la sección API keys en tu cuenta es posible que tu usuario no tengo acceso a este apartado. Para obtener el acceso necesario deberas solicitarlo a un usuario administrador.
¿Puedo recuperar una API key si la pierdo o la olvido?
No, por seguridad, la clave no se puede recuperar. Deberás eliminarla y generar una nueva.
¿Qué debo hacer si creo que mi API key ha sido comprometida?
Eliminarla inmediatamente, si un tercero tiene acceso a tu clave API entonces tiene acceso a los datos de tu cuenta. Ante la duda es mejor eliminar y volver a crearla.
¿Cuál es la diferencia entre desactivar y eliminar una API key?
Desactivarla te permite volver a activarla en el futuro, eliminarla significa que tendrás que crear una nueva.
¿Puedo tener varias API keys activas a la vez?
Si, las que necesites, contar con la prestación de API keys te da acceso a una cantidad ilimitada de API keys.
Olvidé copiar la API key y la ventana emergente se cerró. ¿Qué hago?
Deberás eliminarla y crear una nueva.
Consejos
Asigna descripciones claras a tus API keys para identificar fácilmente su propósito y evitar confusiones, especialmente si gestionas varias.
Copia tu API key en un gestor de contraseñas o un lugar seguro inmediatamente después de generarla, ya que no podrás verla de nuevo.
Utiliza una API key diferente para cada integración importante. Esto facilita la gestión de la seguridad, permitiéndote revocar el acceso a una integración específica sin afectar a las demás.
Revisa periódicamente tus API keys activas y elimina aquellas que ya no utilices para mantener tu cuenta segura y organizada.