Esta Guía de Inicio Rápido proporciona información básica sobre la autenticación con clave API necesaria para acceder a los recursos de la API de Cloudbeds. Esta guía te ayudará a obtener rápidamente una clave API para empezar a usarla con tu autenticación.
Si eres un socio tecnológico, puedes crear una clave API a nivel de propiedad para comenzar rápidamente con tu desarrollo. Sin embargo, deberás implementar el soporte de claves API a nivel de socio según nuestra Guía de Autenticación con Claves API para Socios Tecnológicos antes del proceso de certificación.
Para el método de autenticación OAuth 2.0, consulta el artículo Método de autenticación alternativo OAuth 2.0.
Cloudbeds believes every lodging business is unique. We offer tools for all sizes and budgets to help you establish and grow your business. Reach out to our dedicated team for more information on each available package. Not yet a Cloudbeds customer? Access our Pricing Guide and schedule a demo.
1. Crear credenciales API
Reproduce este video para entender el proceso de creación de claves API
Una vez que tengas acceso API, puedes generar tus credenciales API siguiendo los pasos a continuación:
- Inicia sesión en tu cuenta de Cloudbeds en https://signin.cloudbeds.com/ y navega a:
Cuenta→ Apps & Marketplace
- Usa el menú superior para navegar a la Página de Credenciales API.
-
Haz clic en el botón + New Credentials.
También puedes editar credenciales previamente creadas si deseas convertir esa entrada; salta al paso 6.
-
Completa los datos:
- Ingresa el Nombre de tu integración o aplicación.
- Selecciona la categoría del menú desplegable que mejor coincida con tu aplicación.
- Como el uso de la clave API no requiere una URL de redirección funcional, puedes ingresar “https://localhost” en el campo de Redirect URI.
- Marca Enable for entire organization si deseas una única clave API para varias propiedades.
- Haz clic en Save en la esquina inferior derecha.

-
Se mostrará un modal con las Credenciales del Cliente (Client ID y Shared Secret). Como estos valores no son necesarios para solicitudes habilitadas con clave API, puedes cerrar esta ventana e ignorarlos.

-
Selecciona la nueva entrada en la tabla de Credenciales API, desplázate a la derecha para ver la columna API Key y haz clic en el botón Create en la fila deseada.

-
Al hacer clic en Create, se mostrará una lista de API Scopes que puedes seleccionar.
Las selecciones deben alinearse con los endpoints API que planeas utilizar dentro de tu integración. Puedes consultarlos en la documentación Acerca de la API de Cloudbeds.
-
Selecciona los permisos necesarios y haz clic en Create en la esquina inferior derecha.

-
Selecciona para qué propiedades será válida esta clave. Activa "Connect all properties" para generar claves que funcionen para todas las propiedades dentro de la organización.

- Se te pedirá ingresar tus credenciales de Cloudbeds y aprobar los permisos seleccionados.
‼️Luego, se mostrará la clave API, la cual solo se revela durante este proceso. Debes copiar la clave API y almacenarla en un gestor seguro de credenciales o como propiedad segura dentro de tu código de integración. La clave API no podrá verse nuevamente después de cerrar este diálogo.
2. Usar tu clave API
Ahora puedes usar la clave API para acceder a la API de Cloudbeds incluyendo la clave API en el encabezado de la solicitud como x-api-key o como token bearer.
Aquí algunos ejemplos:
curl --location '<https://hotels.cloudbeds.com/api/v1.2/getHotels'> \--header 'Authorization: Bearer cbat_EE*** ' \
curl --location '<https://hotels.cloudbeds.com/api/v1.2/getHotels'> \--header 'x-api-key: cbat_EE*** ' \
3. Eliminar o reemplazar una clave API
Puedes eliminar o regenerar una clave en cualquier momento. En la tabla de Credenciales API, en la columna API Key, puedes hacer clic en los íconos de regenerar o eliminar.
Ten en cuenta que cuando una clave se elimina o regenera, la clave anterior dejará de estar disponible para acceder a la API.
4. Preguntas frecuentes
¿Las claves API expiran?
Estas no expirarán mientras se utilicen al menos una vez cada 30 días.
¿Cómo agregar permisos adicionales después de crear una clave API?
Debes ir a la pestaña de credenciales API, ubicar la columna API Key correspondiente y hacer clic en el ícono de eliminar para borrar la clave API.
Después de eliminarla, podrás crear una nueva clave API con los permisos correctos.
¿Cómo agregar claves API en Postman?
Puedes incluir tu clave API en la pestaña de autorización de Postman como ‘API key’ o ‘Bearer token’.
¿Se admiten claves API para cuentas de organización/grupo a nivel de propiedad?
Los usuarios de organizaciones que deseen habilitar acceso API para todas las propiedades dentro de la organización deberán marcar la opción "Enable for entire organization", como se describe en el punto 4.iv.
Cloudbeds realiza esfuerzos razonables para asegurar que las claves API no se expongan en repositorios públicos (Github, Gitlab, etc.). Si una clave API se ve comprometida por exposición pública, nos reservamos el derecho de deshabilitarla y requerir la creación de una nueva clave, así como la actualización del código para evitar futuras exposiciones no autorizadas.
- Para más información sobre políticas, precios y casos de uso, consulta este artículo: Acceso API para cuentas de propiedad y grupo.
Comentarios
Inicie sesión para dejar un comentario.