Room Mapping API

๐Ÿ‘

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


RequestDescriptionPostman API Example
MappingEnriches room content to provide end clients with a detailed understanding of each room's offerings. (Supports up to 1500 rooms per request.)
The Response will returns mapped room information along with the rooms content.
Click here.
Updated HotelsUpdated Hotels API allows to get all ids of hotels with changed data since the requested date.
Each response returns the provided count of rows.
To utilize this API call, we require a complete list of your connected or mapped suppliers through the API.
Click here.

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.