Skip to main content

Vendor API 에러 코드 가이드 추가

Vendor API 개발 가이드에러 코드 페이지가 추가되었습니다.

공급사(Vendor)는 온다(ONDA Hub)로부터 API 요청을 받아 처리에 실패하는 경우, 이 페이지에 정의된 표준 에러 응답 포맷을 사용해야 합니다.

주요 내용

에러 응답 포맷

{
"code": "4000",
"error": "No rooms available for booking"
}

codeerror 두 필드 모두 필수이며, error 값은 정의된 영문 메시지를 그대로 사용해야 합니다.

에러 코드 목록

총 12개의 에러 코드가 카테고리별로 정의되어 있습니다.

카테고리코드 범위
SYSTEM_ERROR1000
AUTH_ERROR2000
VALIDATION_ERROR3000
BUSINESS_ERROR40004007
UNKNOWN_ERROR9999

특히 BUSINESS_ERROR 코드는 관련 엔드포인트(Create Reservation, Check Reservation, Cancel Reservation, Confirm Reservation)와 함께 안내되어 상황별로 어떤 코드를 반환해야 하는지 명확하게 파악할 수 있습니다.

자세한 내용은 에러 코드 가이드를 참고해 주세요.

문의

API 연동에 대해 궁금하신 사항이 있으시면 언제든지 문의해 주세요:

AI Development Support Page Added

An "AI Tools" menu has been added to the top navigation bar. By injecting the full ONDA API documentation as context into AI development tools like Claude Code, Cursor, and Windsurf, you can receive more accurate code suggestions and API understanding.

Key Changes

Dedicated AI Tools Page (/ai-tools)

A dedicated page has been added where Vendor API and Channel API developers can select and download only the context files relevant to their integration scope.

Available Files

FilePurposeFor
ONDA-VENDOR-CLAUDE.mdClaude Code contextVendor API developers
ONDA-VENDOR.mdcCursor contextVendor API developers
ONDA-VENDOR.windsurfrulesWindsurf contextVendor API developers
ONDA-CHANNEL-CLAUDE.mdClaude Code contextChannel API developers
ONDA-CHANNEL.mdcCursor contextChannel API developers
ONDA-CHANNEL.windsurfrulesWindsurf contextChannel API developers

Each file includes the common guides (Introduction, Getting Started, FAQ) along with the full set of API-specific documentation.

How to Use

Claude Code

# Save the downloaded file to your project root
mv ~/Downloads/ONDA-VENDOR-CLAUDE.md ./CLAUDE.md
# Claude Code will automatically load the ONDA Vendor API context

Cursor

# Create the .cursor/rules/ directory and move the file
mkdir -p .cursor/rules
mv ~/Downloads/onda-vendor.mdc .cursor/rules/
# Cursor AI will automatically load the ONDA Vendor API context

Windsurf

# Save the downloaded file to your project root
mv ~/Downloads/ONDA-VENDOR.windsurfrules ./.windsurfrules
# Windsurf AI will automatically recognize the ONDA Vendor API context

Contact

If you have any questions about API integration, please feel free to contact us:

Copy as Markdown Button Added

A "Copy as Markdown" button has been added to the top of Channel API and Vendor API documentation pages. This improvement allows developers to quickly paste API documentation content into AI assistants or Markdown editors.

Key Changes

Copy as Markdown Button

  • Location: Top right of Channel API / Vendor API documentation pages
  • Behavior: Clicking the button copies the current page content to the clipboard in Markdown format
  • Feedback: On successful copy, the button switches to a "Copied" state for 2 seconds before reverting

Use Cases

You can use the copied Markdown in the following ways:

  • Paste into AI assistants like ChatGPT or Claude to ask questions about API integration
  • Save documentation content to Markdown editors like Notion or Obsidian
  • Use as reference material when writing technical documents for your development team

Scope

  • All API documentation pages under /docs/api/channel/
  • All API documentation pages under /docs/api/vendor/

The button is not displayed on general guide pages (/docs/).

Contact

If you have any questions about API integration, please feel free to contact us:

Channel API - Property Description Field Character Limits Specified

Maximum character limits are now clearly displayed in the descriptions fields of the Get Property Detail API, providing reference information for channel partners when displaying data in their UI.

Key Changes

Character Limits Added

Maximum character limits have been specified for the following 4 description fields:

FieldDescriptionMax Characters
propertyProperty introduction4,000 chars
reservationProperty reservation info4,000 chars
noticeProperty special notices4,000 chars
refundsProperty refund policy info1,000 chars

API Response Example

descriptions:
property:
type: string
description: 숙소 소개 (최대 4000자)
reservation:
type: string
description: 숙소 예약 정보 (최대 4000자)
notice:
type: string
description: 숙소 별도 공지사항 (최대 4000자)
refunds:
type: string
description: 숙소 취환불 정책 정보 (최대 1000자)

Expected Benefits

  • Channel partners can reference appropriate character limits when displaying data in UI
  • Prevents potential data errors during API integration
  • Improves developer experience with clearer API documentation

Contact

If you have any questions about API integration, please feel free to contact us:

Extra Charge Guide - Room Search Criteria Improvement

The room search criteria in the Extra Charge Guide has been improved. You can now search based on maximum occupancy to find all rooms that can accommodate the total number of guests.

Key Changes

Search Criteria Update

ItemBeforeAfter
Search CriteriaBase OccupancyMaximum Occupancy
Search ResultsRooms matching base occupancyAll rooms with sufficient max occupancy

Search Result Examples Added

When searching for 4 guests, rooms with maximum occupancy of 4 or more are returned:

Room TypeBase OccupancyMax OccupancySearch Result
Standard Double24✅ Included
Deluxe Triple36✅ Included
Family Room44✅ Included
Economy Double23❌ Not included

Expected Benefits

  • More room options available to customers
  • Rooms with lower base occupancy but sufficient max occupancy are now searchable
  • Expanded sales opportunities for partners

Contact

If you have any questions about the guide contents, please feel free to contact us:

Channel API Development Guide Improvements

The Channel API Development Guide documentation has been improved. We have enhanced the guides based on frequently asked questions from partners during API integration.

Key Changes

New Extra Charge Guide

A new guide for handling extra guest charges has been added.

  • Document Location: Extra Charge Guide
  • Key Contents:
    • Why extra charge fields are not used
    • Correct room search method (based on base occupancy)
    • Reservation request guidelines
    • Mandatory customer notice requirements

Cancellation Policy Guide Improvements

The existing Cancellation Policy Guide has been improved for better clarity.

  • Document Location: Cancellation Policy Guide
  • Improvements:
    • Added key summary section
    • Added Static Policy vs Dynamic Policy comparison table
    • Added 3-step implementation guide (Search → Pre-booking → Cancellation)
    • Enhanced API field information

Contact

If you have any questions about the guide contents, please feel free to contact us:


We will continue to improve our development guides to provide a better experience.

ONDA Developer Center Migration

ONDA API documentation has been migrated to the ONDA Partner Developer Center.

Key Changes

The previously separate Vendor API and Channel API documentation have been consolidated into a single unified platform.

Legacy Documentation Sites (Discontinued)

The following documentation sites will no longer be available after December 31, 2025:

New Unified Documentation Site

All ONDA API documentation will now be available at the ONDA Partner Developer Center:

Benefits of the New Developer Center

Unified Experience

  • Access both Vendor and Channel APIs in one place
  • Consistent UI/UX
  • Integrated search functionality

Improved Content

  • More detailed guides
  • Practical code examples
  • Interactive flowcharts

Additional Resources

Update Your Bookmarks

If you have bookmarked the old documentation URLs, please update them to the new Developer Center URLs.

Contact

If you have any questions regarding the documentation migration, please feel free to contact us:


We are committed to providing a better development experience at ONDA Partner Developer Center.