Documentation🖇 Quick LinksAPIStatus Page
Documentation

Getting started

Suggest Edits

Implementation Process Overview

Step 1: Evaluation

During the evaluation phase, you'll be able to:

  • Test the API with real data
  • Access performance metrics
  • Build a clear business case
  • Analyze potential ROI

Evaluation Options

  1. Use your own supplier credentials for realistic testing
  2. Leverage Gimmonix's Aggregated Network for statistical evaluation

Step 2: Implementation

The implementation process includes:

  1. Technical Integration
    • API implementation
    • Testing in certification environment
    • Performance optimization
  2. Training Session
    • Best practices review
    • Implementation guidance
    • Flow comparison and selection
    • Monitoring system overview
  3. Support Setup
    • Access to documentation
    • Support ticket system setup
    • Monitoring dashboard access

Step 3: Certification

Certification requires:

  1. Supplier Setup
    • Provide supplier credentials
    • Configure supplier connections
    • Verify supplier mappings
  2. Integration Validation
    • Complete booking simulation
    • Verify monitoring data
    • Confirm system synchronization

Step 4: Go Live

Catch opportunities real-time.


Ratefox API

The Ratefox API expects the following data:

  • Credentials - username and password as granted from Gimmonix.
  • Hotel and Room information-
    • Supplier HotelID + SupplierID.
    • Check-in and Check-out dates.
    • Booking price (Net price) and Currency.
    • Customers residency.
    • Refundability.
    • Room information (Room name, Meal Plan, number of Adults + Kids, room category etc).
  • Passengers - Passenger information and room allocations.

🚧

Special Parameters :

  • Room Id:
    Under the "Rooms" field, each "Id" - should be a unique (per reach room), self-generated GUID.
  • Passenger Id:
    Under the "LeadPassenger" and "AdditionalPassengers" fields - each passenger "Id" should be unique (per reach passenger), self-generated GUID.
  • Allocation:
    Under the "LeadPassenger" and "AdditionalPassengers" fields - each passenger's "Allocation" should be the respective room "Id" which was generated in the "Rooms" field.

Testing - "Evaluation" Work Mode

Ratefox API requests in evaluation mode provide the access to Ratefox functionality without real bookings. It can be said that in evaluation mode, Ratefox works with suppliers in "read-only mode". This allows for real data gathering, testing and analysis in without initiating actual "Live" bookings.

To enable this evaluation mode, simply set the WorkMode parameter in Ratefox API request to "Evaluation":


"Live" & "Evaluation" Modes - Explained

Work-ModeUsageGood for
LiveLive mode usage is for increasing profit margins.
In this mode, when initiating a Ratefox request, it will Search and Book alternative rooms once a better price point is identified.		Aimed at improving search efficiency and maximizing profitability, providing users with a straightforward and expedient solution for optimizing revenue.
Evaluation (EV)Evaluation mode usage is for assessing and testing the Ratefox API without actual bookings.

When a Ratefox request is initiated it conducts searches and saves data on alternative rooms without executing booking.
This mode allows assessment of Ratefox operation and provides insight into potential profits.		Aimed to assess and test the Ratefox API, the searches and the rooms which are returned in this mode - are Live and real, but - without booking.

In this mode, there’s no actual bookings. The data then can be used to generate insights and assess potential profits that could take place in case it was "Live" mode.

❗️

NOTE:

When operating in "Evaluation" WorkMode, a successful operation response does not result actual bookings. Therefore, please proceed with your original room choice regardless of the Ratefox API's response.

The above can be identified simply by Segment Status in the Ratefox API response which is "EV":

Updated 11 days ago