To use the OAuth flow provided by apaleo, you need to prepare a few things. This only needs to be done once, and we will work with you to ensure everything is okay. Here’s what you need to do:
The landing page is the page users get to after clicking “connect” in the apaleo store. The technical minimum you need there is letting users log in or register to your application. But. Not all of the users wanting to connect are already customers of yours. Get your marketing people involved, and optimize the page for conversion!
One point that would make us happy is if you would not only explain why your product is great, but also that this is an integration they won’t get anywhere else. Data going both ways? Hotel and room data is magically set up, using apaleo as a source? Loyalty points displayed directly in the apaleo UI? If you also think this is awesomer than other integrations, this is the place to show off.
Once you’re done with the landing page, head over to the apaleo store, and enter its URL as the connect link.
The consent screen will be rendered by apaleo, as part of the flow described below. Request your API credentials (the ones which work for all hotels) and tell us in the comments:
|API Credentials||What’s this?|
|Client name||Your application’s name, used on the consent screen|
|Scopes||Permissions that define the type of protected resources a connected app can access. They are included with the OAuth tokens during the authorization flow. Check our Swagger documentation where each API endpoint describes which scope is required.|
|Redirect url||It is where users are redirected after successful authorization. It is the connected app’s callback URL. If further setup is required to establish the connection to apaleo, such as mapping of fields or other configuration, it is a good idea to redirect the user there. Ensure the redirect URL can be called, and is using https.|
We will review the data to ensure that all will work okay and get back to you within a few days.
This is how an example consent screen looks like:
After the user authorizes your client, you’re all set. Well, almost. The last important step is storing the refresh-token you get back during the flow and map it to the customer or hotel on your side.
You can also use this as a trigger to initialize the integration. You can do this automatically, fetching all the data you need from apaleo, or manually. You can also combine both: Get all rate plans and let the user do the mapping to your rate codes. Get all rooms, and generate a housekeeping schedule from it, which needs further adjustment. The more you can do automatically, the better the Wow effect.
Do not forget to display a success message, preferably one that directly shows that the integration works. Think about including the hotel name you just fetched from apaleo or the number of rooms you found.