HotelByte API Customer Certification Guide

For customers integrating to the HotelByte API Platform

Overview

The Customer Certification Process ensures every new integration meets the functional, data quality, and booking-flow standards required by the HotelByte Platform. Once certification is passed, you will be cleared for production access.

Our certification process is designed to provide fast and easy onboarding ensuring that customers can:

Correctly perform the full HotelByte booking flow

Handle mandatory supplier requirements (validated automatically)

Provide a stable, accurate, and compliant experience to end users

The Certification process evaluates functional correctness, not UI design.

Test Environment Information

The certification is performed entirely in the HotelByte Test Environment.

Item	Value
Test Environment URL	`https://api-test.hotelbyte.com`
Authentication Method	Bearer Token (obtained via `/ticket` endpoint)
Documentation URL	`https://openapi.hotelbyte.com`
Technical Support	`support@hotelbyte.com`

Test Credentials

appKey: hotelbyte_api_demo
appSecret: hotelbyte_api_demo

Test Hotel IDs

The following stable test hotel IDs are available for certification testing:

Hotel ID	Hotel Name	Location	Star Rating
`1`	Marina Bay Sands Singapore	Singapore	⭐⭐⭐⭐⭐
`2`	Dubai Marina Luxury Resort & Spa	Dubai, UAE	⭐⭐⭐⭐⭐
`3`	Paris Eiffel Tower View Hotel	Paris, France	⭐⭐⭐⭐⭐
`4`	Downtown Dubai Business Hotel	Dubai, UAE	⭐⭐⭐⭐
`5`	Tokyo Shinjuku Boutique Hotel	Tokyo, Japan	⭐⭐⭐⭐

Test Environment Notes

Availability may differ from production

Pricing and inventory are simulated but realistic

Recommended test hotels are provided, but any hotel showing availability is valid

The simulator generates stable, reproducible rate data for consistent testing

Certification Scenarios

Certification is based on executing complete end-to-end booking scenarios, not isolated API calls. Each scenario verifies that your integration handles all required steps in the booking flow consistently.

Core Scenarios

The following scenarios ensure you can support all common booking patterns.

Scenario	Rooms & Occupancy	Cancellation	Meal
Scenario 1 Multiple Rooms, complex case	3 × Rooms • Room 1: 2 Adults + 2 Children (Age: 5 and 7 years) • Room 2: 2 Adults + 1 Child (Age: 4 years) • Room 3: 2 Adults	Refundable `"refundableMode": "full"`	With Breakfast `"boardId": "BB"`
Scenario 2 Single Room, standard case	1 × Room • 2 Adults	Non-Refundable `"refundableMode": "no"`	Half-board `"boardId": "HB"`

Test Core Booking Flow

Customers must submit a set of JSON request and response files for the API sequence for each scenario as defined below:

Booking Flow Method	Request Requirements	Response Requirements
HotelList	• Search rooms and occupancy as per the Scenario • List of hotels searched: ≤ 50	• At least one hotel rate that matches the scenario criteria is available - Scenario 1: `"refundableMode": "full"` + `"boardId": "BB"` - Scenario 2: `"refundableMode": "no"` + `"boardId": "HB"`
HotelRates	• Provide the same session-id from HotelList • Pass the specific hotelId matching the scenario	• Success response, with same or updated rate
CheckAvail (Mandatory rate validation)	• `ratePkgId`: The specific rate package ID selected from HotelRates response • Pass the same session-id to continue tracking the booking process	• Success response, with same or updated rate
Book	• `customerReferenceNo`: The reference number for the booking • `ratePkgId`: The rate package ID for the booking validated in CheckAvail • `guests`: The guests information for the booking per room • Pass the same session-id to continue tracking the booking process	• Booking success with status
Cancel	• `supplierReferenceNo`: The supplier order reference number	• Successfully cancelled
QueryOrders	• `customerReferenceNos`: Customer reference numbers from Book API	• Order details are found in the response matching the queried order

Additional Self-Testing Scenarios

Scenario	Purpose	Test Requirements
Response Time Test	Verify API response performance	• HotelList endpoint response time < 5 seconds • CheckAvail endpoint response time < 3 seconds • Book endpoint response time < 50 seconds
Concurrency Test	Verify system concurrency handling capability	• Simultaneously initiate 10 search requests • Verify all requests respond normally • Test rate limiting handling

Submit for Certification

Once all scenarios are executed, submit the full set of raw JSON requests and response files for review as per the below requirements.

File Requirements

File Type

All submissions must be in .json format

Raw logs, Postman exports, or server traces are acceptable

File Naming Convention (Mandatory)

All certification files must follow the naming convention:

<scenarioPrefix>_<rq|rs>_<apiName>.json

Where:

scenarioPrefix = s1 or s2

rq = request

rs = response

apiName = hotelList, hotelRates, checkAvail, book, queryOrders, cancel

Example Files (Scenario 1)

Flow	Request File	Response File
HotelList	`s1_rq_hotelList.json`	`s1_rs_hotelList.json`
HotelRates	`s1_rq_hotelRates.json`	`s1_rs_hotelRates.json`
CheckAvail	`s1_rq_checkAvail.json`	`s1_rs_checkAvail.json`
Book	`s1_rq_book.json`	`s1_rs_book.json`
Cancel	`s1_rq_cancel.json`	`s1_rs_cancel.json`
QueryOrders	`s1_rq_queryOrders.json`	`s1_rs_queryOrders.json`

Submission Method

Send the completed files via:

Email: support@hotelbyte.com

Email Subject: Integration Review – [Your Company Name]

Attachments: All JSON files following the naming convention

Final Certification Outcome

After reviewing the submitted JSON files, HotelByte will provide one of the following results within 5 working days:

Certification Outcome	Detail
✅ Pass	Your system meets all required behaviors. You are approved to go live.
☑️ Pass with conditions	Minor items must be corrected, but integration can proceed after the fixes are confirmed.
❌ Retry Required	Critical functional errors were identified. Customers must correct and resubmit all affected scenarios.

Appendix: Sample Request/Response Templates

Scenario 1: HotelList Request

{
  "hotelIds": [1, 2, 3],
  "checkIn": "2026-02-15",
  "checkOut": "2026-02-17",
  "roomOccupancies": [
    {
      "adultCount": 2,
      "childrenAges": [5, 7]
    },
    {
      "adultCount": 2,
      "childrenAges": [4]
    },
    {
      "adultCount": 2,
      "childrenAges": []
    }
  ],
  "nationalityCode": "US"
}

Scenario 1: Expected Rate Matching

For Scenario 1, look for rates with:

{
  "refundableMode": "full",
  "board": {
    "boardId": "BB"
  }
}

Scenario 2: HotelList Request

{
  "hotelIds": [4, 5],
  "checkIn": "2026-02-15",
  "checkOut": "2026-02-17",
  "roomOccupancies": [
    {
      "adultCount": 2,
      "childrenAges": []
    }
  ],
  "nationalityCode": "US"
}

Scenario 2: Expected Rate Matching

For Scenario 2, look for rates with:

{
  "refundableMode": "no",
  "board": {
    "boardId": "HB"
  }
}

Frequently Asked Questions

Q: Can I use any hotel for testing?

A: Yes, while we provide recommended test hotel IDs for stable testing, any hotel showing availability in the test environment is valid for certification.

Q: What if the test hotel shows no availability?

A: The test hotels are configured to always have availability. If you encounter issues, please contact support@hotelbyte.com.

Q: How do I maintain the same session-id across API calls?

A: The session-id is returned in the response of HotelList. Include it in subsequent HotelRates, CheckAvail, and Book requests using the same header or request field.

Q: What currencies are supported in the test environment?

A: USD is the default currency. You can also test with EUR, GBP, CNY, and other major currencies by setting the Currency header.

Q: How long is the test data valid?

A: Test data is generated dynamically based on your request parameters. Use check-in dates at least 7 days in the future for best results.

This Certification Protocol ensures quality, consistency, and reliability across all HotelByte integrations. After successfully passing the certification step, you will receive production access.

Last Updated: December 2025
Version: 1.0

Certification cases

HotelByte API Customer Certification Guide#

Overview#

Test Environment Information#

Test Credentials#

Test Hotel IDs#

Test Environment Notes#

Certification Scenarios#

Core Scenarios#

Test Core Booking Flow#

Additional Self-Testing Scenarios#

Submit for Certification#

File Requirements#

File Type#

File Naming Convention (Mandatory)#

Example Files (Scenario 1)#

Submission Method#

Final Certification Outcome#

Appendix: Sample Request/Response Templates#

Scenario 1: HotelList Request#

Scenario 1: Expected Rate Matching#

Scenario 2: HotelList Request#

Scenario 2: Expected Rate Matching#

Frequently Asked Questions#

Q: Can I use any hotel for testing?#

Q: What if the test hotel shows no availability?#

Q: How do I maintain the same session-id across API calls?#

Q: What currencies are supported in the test environment?#

Q: How long is the test data valid?#