Cloudbeds API key, step by step

It lets Hotelmente read your property from Cloudbeds: reservations, guests, rooms, rates, payments and your hotel details. One key serves Hotelmente AI, Hotelmente PAY and Hotelmente FACTURA.

For Hotelmente AI it only reads. It never creates, changes or cancels anything in Cloudbeds.

• A Cloudbeds user that can open Account → Apps & Marketplace (usually the account owner or an administrator).
• Signed in to the property you want to connect.
• API access in your Cloudbeds package. If Cloudbeds shows a Submit API Access Form button instead of the create options, submit it first and wait for Cloudbeds to switch access on.

Official guide: myfrontdesk.cloudbeds.com/hc/en-us/articles/1260801405770-Apps-and-Integrations-Self-service-API

• Step 1: Sign in to Cloudbeds.
• Step 2: Open Account → Apps & Marketplace, then the API Credentials tab.
• Step 3: Click + New Credentials. Name it Hotelmente, choose an Integration Type, and if a Redirect URI is asked, enter localhost. Click Save.
• Step 4: A window shows a Client ID and Client Secret. You do not need them: close it.
• Step 5: In the new row, click Create in the API Key column.
• Step 6: Tick Read permissions only (see the next question), choose your property, click Continue, then Allow Access.
• Step 7: Copy the key right away. Cloudbeds shows it only once.

Menu names can change; see the official guide: myfrontdesk.cloudbeds.com/hc/en-us/articles/1260801405770-Apps-and-Integrations-Self-service-API

Cloudbeds groups permissions as Read, Write and Delete for each area. For Hotelmente, tick Read only, for these areas: hotel, reservations, guests, rooms, rates, items, payments, taxes and fees, house accounts, allotment blocks, adjustments, users and dashboard.

Do not tick Write or Delete. Hotelmente AI never needs them.

Cloudbeds does not let you add permissions to an existing key. If you forgot one, delete the key and create a new one.

Each hotel in Hotelmente has its own account and its own key. Create one key per property and connect each in its own Hotelmente account.

If the key is created by a group (organization) user, it can reach several properties. Hotelmente connects to the first property the key reaches, so for a group it is safer to create the key signed in to that one property. Hotelmente shows the property name after the test: check it is the right one.

Group access: developers.cloudbeds.com/docs/property-and-group-account-api-access

On the Hotelmente home, in step 3, Connect Cloudbeds:
- Step 1: Paste the key into the Cloudbeds API key field.
- Step 2: Click the button to connect. Hotelmente tests the key with Cloudbeds before saving anything.
- Step 3: If it works, you see You’re connected with your property name, and the first sync starts.

The key starts with cbat_. If the screen shows a Connect with Cloudbeds button, you can sign in to Cloudbeds instead; Use an API key instead keeps this method.

Hotelmente connects Cloudbeds after a product is active on your account. Finish the Plan step on the Hotelmente home, then paste the key.

Open Hotelmente AI → AI settings. Under Your property system, the Cloudbeds row shows the key as ••••last4, the date it was saved and the last test. An owner clicks Test: Hotelmente asks Cloudbeds which property the key reaches, changes nothing, and saves the result with the date.

• Cloudbeds did not accept this key. Check it was copied completely.: part of the key is missing. Copy it again.
• This key is inactive or expired. Create a new one in Cloudbeds.: the key was deleted or disabled. Create a new one.
• This key has no read access to your property. Give it read permissions in Cloudbeds.: Read was not ticked. Create a new key with Read.
• The key works, but no property is linked to it.: the key belongs to another account or has no property selected.
• Cloudbeds is busy / not responding / Could not reach Cloudbeds: wait a few minutes and test again.
• That does not look like a Cloudbeds API key.: what you pasted has spaces or is too short.

The guide Connection error messages and fixes has more detail.

Cloudbeds keeps a key active as long as it is used at least once every 30 days. Hotelmente syncs every night, so a connected key stays active.

Cloudbeds may disable a key that was exposed publicly. If yours was, create a new one and replace it.

Source: developers.cloudbeds.com/docs/quickstart-guide-api-authentication-for-property-level-users

• Step 1: Create a new key in Cloudbeds (same steps, Read permissions).
• Step 2: In Hotelmente, open Hotelmente AI → AI settings and click Replace key.
• Step 3: Paste the new key and click Test & save. The new key is tested first; your current key stays until the new one works.
• Step 4: When Hotelmente shows Connected, delete the old key in Cloudbeds (API Credentials, trash icon).

Your history and settings in Hotelmente are kept.

An owner clicks Disconnect in Hotelmente AI → AI settings and confirms. Hotelmente stops syncing and deletes the saved key. Your synced history stays until you click Delete synced data, in Your data on the same page.

Nothing changes in Cloudbeds. To be sure the key can never be used again, also delete it in Cloudbeds under API Credentials.

The key keeps working, but it is good practice to replace it: create a new key while signed in with your own Cloudbeds user, replace it in Hotelmente, then delete the old one in Cloudbeds. Also check their role in Settings → Users & team.

Hotelmente AI only needs Read. When Hotelmente PAY or Hotelmente FACTURA is switched on for your hotel, recording payments or invoice numbers on reservations needs write access; Hotelmente will tell you in the app how to grant it. Until then, keep the key read-only.