👍

NOTES:

• Room Mapping API is currently a Read-only type of service where the end-user cannot post or update anything onto our servers.
• Room Mapping API currently does not have nor require any staging API.

Authentication

Each endpoint within Room Mapping API requires an API key which is generated and issued to each client by our API team. The authentication gateway validates the API Key and processes the request as per the request if the user is successfully authenticated.

The most popular choice, perhaps due to its usage by AWS API Gateway is X-API-KEY which is a custom header convention for passing your API key. Here is a sample API key and how it fits within the request.

GET / HTTP/1.1
Host: https://rm-api-live.gimmonix.com/
X-API-KEY: 7671ae5e-9f4e-4a71-8242-c7691a9275a5

Securing API key

Your API Key carries many privileges, so be sure to keep them secure!

Do not share the key in publicly accessible areas such as GitHub, client-side code, and so forth.

Room Mapping API

Interactive Experiment: Click here to try the Room Mapping API interactively.

Postman API Examples: For examples and details on request/response parameters, follow along with this guide.

API Requests - examples and Request / Response parameters

📘

Note

Within the room mapping request, the hotel identification must be done using one of the supported suppliers along with the corresponding hotel key (SupplierHotelKeys field). This ensures accurate identification of the hotel.

In the "Rates" section, which refers to the rooms to be mapped, if you wish to map a room with a supplier that is not a 'supported supplier', it's possible - simply by passing the SupplierId as 0.

To clarify:

• Hotel identification must be done with a supported supplier.
• Room mapping within the hotel can be done with SupplierId = 0.

Here's an example request:

JSON

{
	"Language": "en",
	"SupplierHotelKeys": [
		{
			"SupplierId": 1165,
			"HotelKey": "4071725"
		}
	],
	"Rates": [
		{
			"OfferRateId": "201951775",
			"SupplierId": 0,
			"RatePrice": 0,
			"RoomKey": 123,
			"RoomName": "Executive Room with Double or Twin Bed",
			"roomView": "Pool",
			"isSmoking": "false"
		}
	]
}

The hotel is identified with supplier 1165 (Expedia), which is a supported supplier, while the room is being mapped with SupplierId = 0.

Request Type

Room Mapping API HTTPS request support is limited to a subset of RFC 2616 for the Production APIs and will follow the same approach once Staging API is available.

👍

NOTE :

Never access the response body without confirming over the HTTP Response Code within the Header first.