Skip to main content

Updates to Booking and Reservation APIs

Conversion is Key

Each guest journey starts with a booking. Which often means filling out web forms, being annoyed by the massive amount of required data and validation rules, making mistakes and not being able to correct them, searching for the credit card which is always way too far away from the sofa... and giving up. Another customer lost.

We put a lot of thoughts and work into optimizing the apaleo booking API to allow you to optimize for conversion.

  • The number of fields required to create a reservation for a guest dropped dramatically from nine to one: the name. For the booker, we also need the email address, otherwise how to contact them?
  • All other data can be entered in later stages of the guest journey: when the guest checks in, you ask for nationality, before printing the invoice, you enter the address, etc.
  • apaleo is typo-friendly, and we allow to correct all data later on.
These are the three brand new update endpoints:

  • PATCH api.apaleo.com/booking/v1/bookings/{id}
  • PATCH api.apaleo.com/booking/v1/reservations/{id}
  • PATCH api.apaleo.com//finance/v1/folios/{id}/debitor

Updating Payment Information

We didn't forget about a hotel's need for security - will the guest really show up, or is it a troll, DOS-ing the hotel by reserving all rooms? That's why you can still define rate plans which require a credit card for guarantee or prepayment (which adds additional fields to the required data). The new thing here is that now it is possible to change the data later on. Imagine the guest gives you a credit card that's not working for one reason or another - now you can inform them, and as soon as the new data comes in, we try capturing the money again.

Updating payment information can be done directly on a booking, by entering the payment account:

  • PUT api.apaleo.com/booking/v1/bookings/{id}/payment-account
  • DELETE api.apaleo.com/booking/v1/bookings/{id}/payment-account

And more...


  • list all bookings, allowing to filter by channel or external booking id
    GET api.apaleo.com/booking/v1/bookings/
  • we listened to your feedback and the reservations are back in the booking model.
  • the date-time formats now support all variations of the ISO format.


Your apaleo team

P.S. While we're pretty good in building products, we're rather bad in reading thoughts. Does the API confuse you? Have an idea how to improve it? Found an error or typo? Just want to say Hi? Whatever it is, we'd love to hear from you at api@apaleo.com

Comments

Popular posts from this blog

Getting Started with apaleo APIs

Have a look You can find all of apaleo's API on api.apaleo.io. We use Swagger to describe it, and to generate our documentation.

Sign up The first step is to sign up for an account. After you finish signup you will be able to login to our apaleo app and start configuring your properties. Also you can use the same credentials to access our API using Swagger. Get access for app We're still new and want to get in touch with you before we grant you access. Contact us at api@apaleo.com, to get your very own client credentials that lets you play with the API in our sandbox.
Use it apaleo APIs are protected using OAuth2 - the de-facto standard for API security. Here's a short guide to get you started:

Step 1: To get access to our APIs, you need to use your client id and secret to obtain an access token. Don't have one? Contact us at api@apaleo.com.

Combine your client id and secret into a string, separated by colon yourClientId:YourClientSecret and encode with Base64. This wi…

Connect your app with OAuth 2.0

What is this all about? When you connect your app to apaleo, it can read or modify data, or even trigger entire business flows of a hotel. But before gaining access to any of the resources in the REST API, it must get permission from the hotel. This guide will walk you through the authorization process (described in greater detail by the OAuth 2.0 specification). Note: apaleo's OAuth 2.0 implementation supports the standard authorization code grant type. You should implement the application flow described below to obtain an authorization code and then exchange it for a token. (The implicit grant type is not supported.) Terminology Before learning more about the details of the authorization process, make sure that you are familiar with some of the key terms that are used in this guide: Client: Any application that would like access to a hotel's data. A user (usually the hotel's owner or admin) must grant permission before the client can access any data.API: apaleo REST API. T…

Channel Integration Guide

With the channel integration you can subscribe for availability, rates and inventory (ARI), create new bookings and modify existing bookings. 
The BasicsGet your sandbox account and check out this guide to learn how you can connect to the apaleo APIs.
API Client All apaleo APIs are described as swagger documents. That lets you generate API clients directly from the swagger.json files. There is a large community, providing client generators for almost every language. For example, swagger code generator is a good project, which allows generation of API clients for Java, PHP, C#, NodeJS and more. This gets you up to speed very fast and as a bonus you can access API documentation within the auto-generated methods and models.
Sandboxapaleo.io is our – and your – playground to do first steps with the API, up to your final integration. Use it to interactively explore the API or to learn the apaleo concepts by navigating the user interface.

These are the links you need to know