Aplicaciones e integraciones - API de autoservicio

Esta guía de inicio rápido proporciona información básica sobre la autenticación mediante una clave de API, necesaria para acceder a los recursos de la API de Cloudbeds. Esta guía te ayudará a obtener rápidamente una clave de API para autenticar tus solicitudes.

Si eres un partner tecnológico, puedes crear una clave de API a nivel de la propiedad para comenzar tu desarrollo rápidamente. Sin embargo, antes del proceso de certificación, deberás implementar la compatibilidad con claves de API a nivel de partner, de acuerdo con nuestra Guía de autenticación mediante claves de API para partners tecnológicos.

Para obtener información sobre el método de autenticación OAuth 2.0, consulta Método alternativo de autenticación OAuth 2.0.

Cloudbeds cree que cada negocio de alojamiento es único. Ofrecemos herramientas para diferentes tamaños de propiedad y presupuestos para ayudarte a establecer y hacer crecer tu negocio. Contacta a nuestro equipo dedicado para más información sobre los paquetes disponibles.

¿Aún no eres cliente de Cloudbeds? 

Antes de crear las credenciales de la API

Antes de crear las credenciales de la API, abre la página Credenciales de la API en Cloudbeds. Lo que veas en esta página dependerá de si tu paquete de Cloudbeds ya incluye acceso a API.

El siguiente ejemplo muestra la página Credenciales de la API cuando aún es necesario solicitar acceso a API.

Una vez que se habilite el acceso a API para tu cuenta, vuelve a la página Credenciales de la API y continúa con los siguientes pasos.

1. Crear credenciales de la API

Mira este video para conocer cómo se crean las claves de API

Una vez que se habilite el acceso a API, crea primero la integración. Luego, genera la clave de API, selecciona los permisos y las propiedades necesarios y autoriza la conexión.

1. Inicia sesión en tu cuenta de Cloudbeds en https://signin.cloudbeds.com/ y ve a:

   Cuenta -> Aplicaciones y Marketplace

2. Abre la pestaña Credenciales de la API.

3. Haz clic en + Nuevas credenciales.

   La página Credenciales de la API muestra tus integraciones existentes y el botón + Nuevas credenciales, que te permite crear una nueva integración.

   

   También puedes editar las credenciales de cliente que hayas creado previamente si quieres convertir ese registro. En ese caso, pasa al paso 6.

4. Completa los datos de la nueva integración de API:

   1. Ingresa el Nombre de tu integración o aplicación.
   2. Selecciona el Tipo de integración que mejor se ajuste a tu aplicación.
   3. Como el uso de una clave de API no requiere una URL de redireccionamiento funcional, puedes ingresar https://localhost en el campo URI de redireccionamiento.
   4. Activa Habilitar para toda la organización si quieres que la integración esté disponible para varias propiedades de la organización.
   5. Haz clic en Guardar en la esquina inferior derecha.

   El formulario Nueva integración de API contiene el nombre de la integración, el tipo, el URI de redireccionamiento y la opción para habilitarla en toda la organización.

   

5. Cloudbeds crea credenciales de cliente que contienen un ID del cliente y un Secreto del cliente. Estos atributos no son necesarios en la carga útil de una solicitud autenticada mediante una clave de API, por lo que puedes cerrar el cuadro de diálogo y continuar con la creación de la clave de API.

   El cuadro de diálogo de confirmación también te recuerda que no podrás volver a ver el secreto del cliente después de cerrarlo.

   

6. Busca la integración en la tabla Credenciales de la API. En la columna Clave de API, haz clic en Crear.

   La integración que acabas de crear aparece como una fila en la tabla Credenciales de la API antes de que se genere una clave de API.

   

7. Una vez que hagas clic en el botón Crear de la fila correspondiente, verás una lista de alcances de la API que puedes seleccionar.

   Los alcances que selecciones deben corresponder a los endpoints de la API que planeas usar. Consulta Acerca de la API de Cloudbeds para obtener más información.

8. Selecciona los alcances necesarios marcando la casilla de cada permiso. Luego, haz clic en Crear.

   El cuadro de diálogo Nueva clave de API agrupa por alcance de la API los permisos Leer, Escribir y Eliminar disponibles.

   

9. Selecciona las propiedades a las que quieres que se conecte la aplicación. Elige Conectar todas las propiedades para generar claves que funcionen para todas las propiedades de la organización y haz clic en Continuar.

   

10. Revisa los permisos que solicita la aplicación y haz clic en Permitir acceso.

    La página de autorización muestra los alcances de permisos que se compartirán con la aplicación antes de conceder el acceso.

    

11. Cloudbeds genera la clave de API después de la autorización.

    Copia y guarda la clave de API de inmediato. La clave de API completa solo se muestra al crearla. Una vez que cierres el cuadro de diálogo, no podrás volver a verla. Guárdala en un gestor de credenciales o en otro lugar seguro.

    El cuadro de diálogo Clave de API creada muestra la clave junto con un recordatorio de que no podrás volver a verla después de cerrarlo.

    

2. Usar tu clave de API

Ahora puedes usar la clave de API para acceder a la API de Cloudbeds. Para ello, incluye la clave de API en el encabezado de la solicitud como x-api-key o como un token de portador (bearer token).

Estos son 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 de API

Puedes eliminar o volver a generar una clave en cualquier momento. En la tabla Credenciales de la API, busca la columna Clave de API y usa la acción disponible para esa clave.

La tabla Credenciales de la API mantiene oculta la clave de API guardada después de crearla.

Preguntas frecuentes

¿Las claves de API vencen?

No vencen, siempre que se usen al menos una vez cada 30 días.

¿Cómo agregar alcances de permisos adicionales después de crear una clave de API?

Accede a la pestaña Credenciales de la API, busca la columna Clave de API de las credenciales de la API correspondientes y haz clic en el botón de la papelera para eliminar la clave de API.

Una vez que la elimines, puedes crear una nueva clave de API con los alcances de permisos correctos.

¿Cómo agregar claves de API en Postman?

Puedes incluir tu clave de API en la pestaña Authorization de Postman como API Key o Bearer Token.

¿Las cuentas de organización o grupo admiten claves de API a nivel de la propiedad?

Los usuarios de la organización que quieran habilitar el acceso a API para varias propiedades pueden seleccionar Habilitar para toda la organización al completar el formulario Nueva integración de API en el paso 4 de Crear credenciales de la API. Durante la autorización, pueden seleccionar las propiedades a las que debe conectarse la aplicación.

• Para obtener más información sobre políticas, precios y casos de uso, consulta Acceso a API para cuentas de propiedades y grupos.