Xconnect API - Withinearth
Introduction
The purpose of this document is to provide technical details about the API's. This document outlines the business processes supported by the API and details about specifications of API’s. It assumes that reader has a technical background and is familiar with JSON, API's. Examples are given for each API please refere sample for ease. Note:If You have any query, Please contact API support team on apisupport@technoheaven.com ,also cc ankit@technoheaven.net in each mail for immediate response.
Connection properties
Request/Response
It is recommended that at least all booking and cancellation transactions sent through the Test / Live environment should be logged and maintained by the hotel agent for at least 6 months.
Authentication
Authentication is done by 2 measures:
1. Whitelisted IP - submitted before the development process begin.
2. API key - also provided during the development and after certification process.
Client Requirements
- Client requests must be issued from a public, static IP address registered with System.
- Client requests must be made via an HTTPS POST request.
- Use SSL.
- All data sent and received via the interface will be encoded in UTF-8.
- we use deflate compression for response.
Development Phase
Once you receive your Access token, you can start the development of your application/framework. The whole process of communication consists of simple JSON messages exchange (request /response) between your application/framework and system. Each request needs to be posted (through POST method) using https protocols. For details regarding requests and answers formats please consult the dedicated area of each request. For further assistance in development process do not hesitate to contact our support team on apisupport@technoheaven.com .
Important note
- Follow these guidelines when searching for properties for your test bookings, even for static tests. Being diligent in your property selection will help you avoid incurring any accidental charges during your booking tests.
- Please use city id : {{testcityid}} . for testing purpose.
- To use different nationality of different countries use same name in countries api response.
- Verify the booking will be outside of the hotel's cancellation policy.
- Never pick next-day or same-day availabilities, even to test promos.
- Shop a few months ahead whenever possible.
- Use Real Name for first name and last name.Do not use test name.
- Never automate static booking tests -we may flag or temporarily disable your account.
- Shopping at least a few months ahead and paying attention to Policy will help you avoid the most common problems with test bookings. Remember, client is not responsible for any unintentional live or nonrefundable bookings you place during testing.
- Make sure you cancel each test booking using api, if face any issue in cancellation contact us immediately.
- Always do refundable feature booking and cancel booking after done.
- No duplication allowed for internalreference, it must be unique for each time you hit that api.
Status & Error Code
Date Format
- Date format send to Payload MM-DD-YYYY