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
APIs that must be implemented on the vendor system (a server the vendor builds and hosts itself). The spec lists the server address as https://vendor.dapi.tport.dev, but this is actually a placeholder representing the vendor's own designated server URL. See each linked API reference page for detailed parameters and schemas.
Property Creation API
| Method | Endpoint | Description |
|---|---|---|
| GET | /properties | Get the vendor's full property list |
| GET | /properties/{vendor_property_id} | Get property details |
| GET | /properties/{vendor_property_id}/roomtypes | Get room type list |
| GET | .../roomtypes/{vendor_roomtype_id} | Get room type details (+ rate plans) |
| GET | .../rateplans/{vendor_rateplan_id}/avails | Get daily availability |
| GET | .../rateplans/{vendor_rateplan_id}/rates | Get daily rates |
Property Information Management (Sync) API
Retrieves only the changed items on a recurring basis, filtered by the lastdate query parameter. Agree on the call interval with your ONDA technical account manager.
| Method | Endpoint | Description |
|---|---|---|
| GET | /sync/properties | Get list of changed properties |
| GET | /sync/roomtypes | Get list of changed room types |
| GET | /sync/avails | Get inventory changes |
| GET | /sync/rates | Get rate changes |
Reservation API
| Method | Endpoint | Description |
|---|---|---|
| GET | .../refund_policy | Check cancellation/refund policy before reservation |
| POST | /bookings | Create reservation (secures inventory, pending status) |
| PUT | /bookings/{vendor_booking_number}/confirm | Confirm reservation (auto-cancelled if not confirmed within ~15 minutes) |
| PUT | /bookings/{vendor_booking_number}/modify | Modify reservation |
| POST | /bookings/{vendor_booking_number}/cancel | Cancel reservation |
| GET | /bookings/{vendor_booking_number} | Check reservation |
Authentication and Security
Because this direction (ONDA → Vendor) runs on a server the vendor builds and hosts itself, the authentication method is not fixed by the spec. Decide the vendor system's authentication method (API key, IP whitelist, etc.) together with your ONDA technical account manager.
- HTTPS Required: HTTPS is recommended for all API calls.
Response/Error Format
All three APIs share a common ErrorResponse schema ({code, error}).
| HTTP Status | code | Description |
|---|---|---|
| 400 | 3000 | Validation Error — check request parameters |
| 403 | 2000 | Access Denied |
| 404 | 4004 | Not Found (check-reservation only) |
| 409 | 4000/4006/4007 | Business Error (reservation API only — no availability, cannot confirm/cancel, etc.) |
| 500 | 1000 | System Error |
Error Response Example
{
"code": "3000",
"error": "Please check your input information"
}
Development Guide
1. API Endpoint Implementation
Refer to the endpoint tables above to implement the API endpoints ONDA will call on the vendor system.
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