How to use Guest Communication API?

In this article, we explain how to display more information about the methods, endpoints, payloads as well as how to test your integration directly in the Swagger tool.

 

How to use Swagger

Rentals United Guest Communication API is documented using the Swagger tool. You can access it here.

Guest Communication is divided into sections, for example Messages or Threads. Click the section to unfold methods related to it and then click the method to read more about required parameters and formats.

By default, you are always presented first with the Example value, but you can switch to the Model tab and read definition of each field as well as what format it should be provided in.

See the schema on the right to learn more about different Swagger parts.

 

How to test the methods

You can test the majority of methods directly in Swagger. You can do that by providing parameters and/or payloads, as per the described requirements. See the videos below.

Note: While testing, Swagger will ask you to log in and will remember your credentials after you provide them. The only way to log out is to clear the browser cache. This is very important in case you want to test the methods on multiple users. If you want to avoid clearing cache, it is best to always use the incognito tab.

 

Example: Display all threads within a specific reservation ID

 

Example: Display messages within a specific thread ID