Articles in this section

FAQ

Avatar
Miho
  • Updated

 

General

What are your Rate Limits and API Methods Limit?

In terms of Rate Limits the Cloudbeds API has the following polling limits. While these are enforced, we do allow some margin of error. We encourage all to respect the following limits: 

Properties and Group Properties: 5 requests per second

Tech Partners: 10 requests per second

Regarding API Methods usage we don't have a specific limit however we recommend up to a maximum of 6/8 API calls depending on your use case, we also strongly recommend subscribing to Webhooks 

Is there a newsletter I can sign-up to get more information?
Please, visit our Change Log for Regular API announcements.
Can anyone connect to your API?

Our API is only open Technology Partners who wish to build to us and can offer a product to our clients. To become a technology partner tell us more here.

For Property Level API please refer to the following article. 

How many pilot properties can I connect?

We require a minimum of 5 pilot properties and up to 10 for the official go-live.

How can I test your API?

We suggest using Postman (https://www.getpostman.com/) for testing and understanding the overall usage of our calls. Although we do not give support, we do offer our public API Collection of calls that can be used in Postman. See video in our Set up environment & test OAuth 2 in Postman article to get help.

Do you have test servers?

We don't offer a test server, but we do offer a Technology Partner Test Accounts on our production server. It has dummy data and will allow you to try out your integration.
With the same account you will manage the details (app screenshots, app icon, copy) of your app in our App Directory.

 

 

Methods

What are the possible card types in postPayment?

Allowed values are property based. Possible strings are: visa, master, amex, aura, diners, hiper, elo, Discover, jcb, maestro, dan, PostCard, Eurocard, union_pay, visaelectron, Bankcard, cunion, BANRICOMPRAS

Languages supported with postEmailTemplate?

Here is the list with their names and codes:

  • English-en
  • Brazilian Portuguese-pt-br
  • Spanish-es
  • Russian-ru
  • Ukranian-ua
  • Italian-it
  • German-de
  • French-fr
  • Estonian-ee
  • Polish-pl
  • Dutch-nl
  • Finnish-fi
  • Greek-gr
  • Japanese-jp
  • Thai-th
  • Chinese-ch
  • Hebrew-il
  • Korean-kr
  • Swedish-se
  • Norwegian-no
  • Lithuanian-lt
  • Vietnamese-vn
  • Hungarian-hu
  • Slovak-sk
  • Czech-cz
  • Romanian-ro
  • Arabic-ae
What is possible to do with your API?

We maintain a list of app blueprints explaining how an app could connect and use our API calls. See our Sample Use Cases/Blueprints for different app types.

Can I get pending transactions with getTransactions?

No, getTransactions provides the list of transactions already posted into myfrontdesk folio.

Can I get a list of all of the in-house guests/reservations for a given day, regardless of their check-in/check-out dates?

For example, if you want to see all of the guests/reservations for February 26, 2021 use these filters: checkInTo=2021-02-26&checkOutFrom=2021-02-26

Comments

0 comments

Please sign in to leave a comment.