CBAPI-OperationalReportsClientApp

This sample application will allow you to use the Cloudbeds APIs to:

1. Query reservations data
2. Produce a report showing check-ins/check-outs/stayovers for 60 (or more if desired) days

Installing this tool

While the source code for this tool is included and is open-source (feel free to modify), we have provided a setup/installer for people who "just want to use the tool"

1. Go the latest release: https://github.com/cloudbeds/CBAPI-OperationalReportsClientApp/releases
2. Download the *.zip file, and uncompress it on your local machine (it will contain only a few file)
3. Run the setup program

Notes:
- The setup should add an "CBOperationsReportTool" icon to your Windows desktop and start menu. You can use this to easily run the tool. You can also right click on it to see a menu that allows uninstall.
- The first attempt to run the application is LIKELY to prompt you to install the “Microsoft .NET Runtime”, go ahead and do that.
- When the application starts for the first time it will indicate that it cannot locate the application configuration files. This is as expected. It will take you to a setup screen, and you can point it the the *.xml file that has your Cloudbeds' property's access key (an example XML file is shown in the _ExampleSecrets folder in this Github project)

How to setup authentication

Option 1: Set up the application using API Access tokens (preferred)

1. Follow the instructions to create an API Access token: https://integrations.cloudbeds.com/hc/en-us/articles/18746883407387-Quickstart-Guide-API-Authentication-for-property-level-users . Permissions required are:
* Read access: Hotel
* Read access: Reservations
* Read access: Guest
* Read access: Dashboard

2. Copy/paste that token into an Cloudbeds_AppConfig.xml file (See example: "_ExampleSecrets\Example_CloudbedsApiKey_AppConfig.xml")
3. Start the application running
4. Go to the “Setup screen” and set the “App Config” path to point to the XML file above
5. Go to the “Operational Report” screen. This will query the Cloudbeds API and download current and future reservations data and produce the report you see

Option 2: Set up the application using OAUTH Token API access

1. Get Cloudbeds APIs OAuth Application ID and Access token. These should be placed into a “Cloudbeds_AppConfig.xml” file (See example: “_ExampleSecrets\Example_CloudbedsOAuth_AppConfig.xml”)
2. Have a placeholder “Cloudbeds_UserAccessTokens.xml” file. (This will get overwritten when you authenticate to the application. See example: “_ExampleSecrets\Example_CloudbedsOAuth_TransientTokensStorage.xml” )
3. Start the application running
4. Go to the “Setup screen” and….
4a. Set the “App Config” and “User Access Tokens” paths to point to the XML files above
4b. Click on the “Start Auth Bootstrap” button to get a URL for application authentication. Copy paste this into your internet browser and log in to your Cloudbeds property. Agree to the access request.

NOTE: The browser will now be navigated to a MISSING PAGE (this is OK). You just need the information IN the URL
4c. Copy paste the URL you were navigated into back into this application in the textbox next to the “Finish Auth Bootstrap” button.
4d. Click the “Finish Auth Bootstrap” button.

RESULT: You will now have Cloudbeds API access tokens stored on your local machine.
These are refreshed as needed and are stored in the “Cloudbeds_UserAccessTokens.xml” file.

5. Go to the “Operational Report” screen. This will query the Cloudbeds API and download current and future reservations data and produce the report you see. There are 2 export to CSV options:

• "Save Daily Summary CSV..." - This will save a CSV of what you see on the screen (a daily summary counts for check-ins/check-outs/turnovers)
• "Save Daily/Reservations CSV..." - This will save a more detailed CSV. For every calendar date it will show each reservations/sub-reservations that are active in the hotel