Skip to main content

ONDA → Vendor Request

This is an integration guide for the Pull method where ONDA requests data from the vendor (accommodation provider) system.

Overview​

The ONDA → Vendor Request method is an integration approach where the ONDA system directly calls the vendor's API to obtain the latest information.

Features​

  • Real-time Data Acquisition: ONDA retrieves the latest data from the vendor system when needed
  • Pull Method: ONDA actively requests data
  • Immediacy: Real-time access to the latest information
  • Reliability: Obtain accurate information by directly querying the vendor system

Integration Flow​

Main API Endpoints​

Main APIs that need to be implemented in the vendor system:

1. Property Information Inquiry​

  • Purpose: Check updated property information
  • Call Frequency: Once daily or as needed
  • Response Data: Basic property information, amenities, images, etc.

2. Room Type Information Inquiry​

  • Purpose: Check room types and detailed information
  • Call Frequency: Once daily or as needed
  • Response Data: Room types, maximum occupancy, amenities, etc.

3. Rate Information Inquiry​

  • Purpose: Check real-time rate information
  • Call Frequency: Real-time (upon search/reservation request)
  • Response Data: Rates by room, discount information, cancellation policy, etc.

4. Availability Check​

  • Purpose: Check inventory and availability status
  • Call Frequency: Real-time (upon search/reservation request)
  • Response Data: Inventory by room, availability

Authentication and Security​

API Authentication​

  • Method: API Key-based authentication
  • Header: Authorization: Bearer {API_KEY}
  • Security: HTTPS required, encrypted API key storage

IP Whitelist​

  • Register ONDA server IP addresses in the vendor system
  • API calls only allowed from permitted IPs
  • Additional authentication layer for enhanced security

Response Format​

All API responses use JSON format:

{
  "status": "success",
  "message": "Request processed successfully",
  "data": {
    // Actual data content
  },
  "timestamp": "2024-09-26T15:30:00Z"
}

Error Response​

{
  "status": "error",
  "error_code": "INVALID_REQUEST",
  "message": "Request parameters are invalid",
  "details": "check_in date is missing",
  "timestamp": "2024-09-26T15:30:00Z"
}

Development Guide​

1. API Endpoint Implementation​

The vendor system must implement API endpoints that ONDA will call.

2. Data Format Compliance​

Must respond with data format compatible with the ONDA system.

3. Error Handling​

Must provide appropriate HTTP status codes and error messages.

4. Performance Optimization​

  • Minimize response time (recommended: within 3 seconds)
  • Improve performance with caching
  • Pagination for large data volumes

Testing Guide​

1. Development Environment Testing​

  • Call vendor development API from ONDA test server
  • Verify basic API responses
  • Validate data format

2. Integration Testing​

  • Integration testing with actual data
  • Verify performance and stability
  • Test error scenarios

3. Pre-production Validation​

  • Verify production environment settings
  • Configure monitoring tools
  • Confirm incident response procedures

Monitoring and Operations​

Log Management​

  • Record API call logs
  • Monitor error logs
  • Track performance metrics

Alert Settings​

  • API response time delay alerts
  • Error rate increase alerts
  • System failure alerts

Next: Vendor → ONDA Request method guide