---
title: Connection and Authentication
slug: connection-and-authentication
docTags: 
createdAt: 2024-06-25T18:50:27.775Z
---

# Connection Protocol

Communication with the Bonotel API is performed through secured hypertext transfer protocol (https) connections. The API is written to receive requests and generate responses in XML. 

# Headers

| **Request Method** | **POST**        |
| ------------------ | --------------- |
| Content-Type       | application/xml |

All customers are ***required to use GZip compression*** to effectively manage the size and speed of responses. Utilize the following header to accomplish this. 

| **Request Header Name** | **Request Header Value**    |
| ----------------------- | --------------------------- |
| Accept-Encoding         | gzip,deflate,compress;q=0.9 |

# URLs

| **URL Category** | **URL / Path**                       |
| ---------------- | ------------------------------------ |
| UAT Base         | https\://rps-uat.svc-ops.bonotel.com |
| Production Base  | https\://rps.svc.bonotel.com         |
| API Path         | /bonotelapps/bonotel/reservation     |

# Methods

| **Action Name**         | **Endpoint**             | **Notes**                                                                                 |
| ----------------------- | ------------------------ | ----------------------------------------------------------------------------------------- |
| Availability (Shopping) | /GetAvailability.do      | Initial shopping action. Return results and select a reservation candidate.               |
| Pre-book                | /PreBookCheck.do         | Request with a specific reservation candidate to confirm non-cached availability.         |
| Reservation             | /GetReservation.do       | Request with a specific reservation candidate to confirm a reservation.                   |
| Cancel                  | /GetCancellation.do      | Cancel a specific confirmed reservation.                                                  |
| Report                  | /XMLReservationReport.do | Request with parameters a report of recorded reservations (confirmed, canceled, or both). |
| Lookup                  | /LookupReservation.do    | Lookup details of a specific reservation (confirmed, canceled, or either).                |

# Authentication

Authentication is handled by passing in a username and password combination in the XML  body of each request method. 

:::BlockQuote
\<control>
&#x9;\<userName>\{\{Username}}\</userName>
&#x9;\<passWord>\{\{Password}}\</passWord>
\</control>
:::