Skip to main content

It doesn't work! Troubleshooting the apaleo API

Sometimes things don't work as you expect them to - here are some tips & tricks on how to figure out what's wrong, and what to do then:

Status Codes

First thing to check is the status code you get in the response:
401 - Unauthorized. When you are using the client credentials flow, this means there is something wrong with your token, or the way you pass it. Check the Getting Started Guide for how to do it. When you are using the apaleo or Swagger UI, all should be good if you log in. On Swagger, use the "Authorize" button in the top-right corner.
403 - Forbidden. Your client or user does not have the rights to access a specific resource. Contact api@apaleo.com to request more access.
404 - Not Found. You can get this, when you try getting, updating or deleting a resource. That can either be a typo in the URL, or a wrong id you are passing as a query parameter.
405 - Method not allowed. You will get this, if you use the wrong HTTP verb, for example POST instead of PUT. Check the API definition to see which verbs to use for which action.
424 - Something's wrong. The apaleo API uses this as a catch-all for client side errors, and we try our best to provide more information in the error response message. In simple cases, the request you passed in is not valid: mandatory fields are not set, or in a wrong format we don't understand. But it can also be that some setup is missing, for example when you are trying to add a unit to a group that does not exist. If you do not have access to the resources to fix the root cause, please reach out to the customer for which this problem appears, because we can't fix it, either. We would rather not want to mess with our clients data.
500 - Oh no! This should never happen, as it means there is something broken on our side. We monitor those errors, and will see it as soon as you do - and then start investigating and fixing. If you want to be notified when it's fixed, or want to help us by providing additional information on what you did, api@apaleo.com is the best way to get in touch.

Nothing Works?

Check https://status.apaleo.com/ to see if apaleo is up and running - and if it's not, check back in a few minutes. There's no need to tell us, as our army of friendly robots already did that. We'll publish updates here on dev.apaleo.com, just subsribe to this blog is the to get notified when there are any news.

❤ Your apaleo team

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