Quick start

🚀 Environment Setup

🔧 Essential configuration for HotelByte API integration - Get up and running in minutes

Environment	URL	Purpose
Production	`https://api.hotelbyte.com`	Official business operations
Testing	`https://api-test.hotelbyte.com`	Development and testing

Step 1: Get Authentication

We provid test credential hotelbyte_api_demo for seamless development integration.

Response Example:

{
    "code": 0,
    "msg": "success",
    "data": {
        "ticket": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
    }
}

Essential Headers

Standard Response Format

body

{
    "code": 0,
    "msg": "success",
    "data": {
        // Business data
    }
}

header

{
    "Request-Id": "request-id",
    "Trace-Id": "trace-id",
    "Server-Cost-Milliseconds": 500,
    "Session-Id": "verified-session-id"
}

🚀 Recommended todos in development

1. Set up your environment-based configuration variables

2. Ticket Caching (Critical for Performance)

Here is an example:

📊 API Overview

Core Interface Mapping

Feature Module	Endpoint	Method	Description
Authentication	`/api/auth/ticket`	POST	Get access token
Hotel rates	`/api/search/hotelList`	POST	Hotel list search
Hotel rates	`/api/search/hotelRates`	POST	Rate query
Make bookings	`/api/search/checkAvail`	POST	check ARI
Make bookings	`/api/trade/book`	POST	Smart booking
Manage bookings	`/api/trade/queryOrders`	POST	Order query
Manage bookings	`/api/trade/cancel`	POST	Cancel order
Content	`/api/search/hotelsMetadata`	POST	Hotels metadata with pagination
Content	`/api/search/hotelStaticDetail`	POST	Hotel static details
Content	`/api/search/destinations`	POST	Destinations where your customers book hotels

📊 Performance Metrics

Metric	Value	Description
API Process Time	< 1000ms	P95 process time (+1s network)
Concurrent Processing	10,000+ QPS	Supports high traffic access
Supplier Coverage	20+	Global major hotel suppliers
Hotel Inventory	1,000,000+	Covers major cities worldwide
Booking Success Rate	99.5%	Enhanced by async processing

Overall Architecture Diagram

🌐 Infrastructure & Network Configuration

Common Issues:

IP whitelist configuration delays

SSL certificate setup

Network connectivity problems

Security policy conflicts

Solutions:

Early Infrastructure Planning: Begin network configuration during development

IP Address Documentation: Provide static IP addresses early in the process

Security Review: Conduct thorough security assessments

Staging Environment: Test all configurations in pre-production

Required Information:

Static IP addresses for API access

SSL certificate requirements

Network security policies

Firewall configuration needs

🔧 SDK Support (comming soon)

Language	SDK	Status
Java	hotelbyte-java	🔄 In Development
Go	hotelbyte-go	✅ V0.0.1 Released!
PHP	hotelbyte-php	🔄 In Development
JavaScript	hotelbyte-js	🔄 In Development
TypeScript	hotelbyte-js	🔄 In Development
Python	hotelbyte-python	🔄 In Development

🚀 Environment Setup#

Step 1: Get Authentication#

Step 2: Search Hotels#

Step 3: Search Rates#

Step 4: CheckAvail#

Step 5: Book#

Essential Headers#

Standard Response Format#

🚀 Recommended todos in development#

1. Set up your environment-based configuration variables#

2. Ticket Caching (Critical for Performance)#

📊 API Overview#

Core Interface Mapping#

📊 Performance Metrics#

Overall Architecture Diagram#

🌐 Infrastructure & Network Configuration#

🔧 SDK Support (comming soon)#