본문으로 건너뛰기

Vendor API 3.0 - 예약 조회 응답 필드 확대 및 예약 전송 문서 오류 정정

기존에는 예약 전송(POST /bookings)으로 보낸 값 중 일부를 예약 조회로 다시 확인할 수 없었습니다. 이번 변경으로 전송 페이로드의 모든 항목이 조회 응답에도 나옵니다. 더불어 예약 전송 문서에 잘못 적혀 있던 필드 타입 3건을 실제 기준으로 정정했습니다.

주요 변경사항​

1. 예약 조회 응답에 필드 12개 추가​

GET /gds/vendor/booking/{vendor_booking_number}

필드타입필수/선택설명
channel_idnumber필수판매 채널 ID (예: 132)
channel_namestring필수판매 채널명
channel_booking_numberstring선택판매 채널 예약 번호
gds_booking_numberstring필수ONDA Hub 예약 번호
gds_sub_booking_numberstring필수ONDA Hub 서브 예약 번호 (예약 내 객실 단위)
rateplan_idstring선택공급사 요금제 ID. 매핑이 없는 예약은 생략
total_amountnumber필수채널 축 판매가. payment_type이 postpayment면 현장 수납할 금액
net_pricenumber필수입금 금액 (정산 예정액)
payment_typeprepayment | postpayment필수결제 방식 (선결제 / 후결제)
special_commentstring선택고객 요청 사항
visit_typewalk | car선택방문수단. 채널이 값을 준 예약에만 실림
secondary_channelstring선택2차 판매 채널. 채널이 값을 준 예약에만 실림

선택 필드는 값이 없으면 null이 아니라 키 자체가 빠집니다. 응답 파싱 시 키 존재 여부로 판단해 주세요.

금액 필드가 세 개로 늘어난 만큼 기준도 함께 정리했습니다.

필드기준
amount공급사 축 금액 — 숙박일별 금액에 추가금을 더해 합산한 값
total_amount채널 축 판매가
net_price입금 금액 (정산 예정액)

2. 예약 조회 응답의 type 필드 표현 변경​

값이 없을 때
기존"type": null
변경키 자체를 생략

예약 전송 페이로드와 동일한 방식으로 통일한 것입니다. 실제로 값이 없는 예약은 운영 데이터에 없어 응답이 바뀌지는 않지만, 파싱 로직이 null 비교를 한다면 확인이 필요합니다.

3. 예약 전송 문서 오류 정정​

전송하는 값은 바뀌지 않았습니다. 문서가 실제와 달랐던 것을 실제 기준으로 고쳤습니다. 문서를 보고 구현했다면 확인이 필요합니다.

POST /bookings

필드문서(이전)실제 = 문서(현재)
channel_idstring, 예시 'NAVER'number, 예시 132
total_amountstring, 예시 '100000'number, 예시 100000
channel_booking_number필수선택
  • channel_id, total_amount는 처음부터 숫자로 전송해 왔습니다. 문서 예시만 잘못 적혀 있었습니다.
  • channel_booking_number는 판매 채널이 자기 예약 번호를 주지 않는 경우 키가 빠질 수 있어 선택으로 바꿨습니다.

PUT /bookings/{vendor_booking_number}/modify의 total_amount도 같은 문서 오류라 함께 number로 정정했습니다.

관련 문서​

문의​

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

Vendor API 3.0 문서 공개

신규 연동을 위한 Vendor API 3.0 문서가 공개되었습니다. 기존 Vendor API 1.5는 그대로 지원되며, 상단 메뉴 벤더 API에서 두 버전을 선택할 수 있습니다.

1.5에서 달라진 점​

콘텐츠 전송 방향 반전​

기존에는 ONDA가 공급사 API를 GET으로 호출해 콘텐츠를 가져갔습니다. 3.0에서는 공급사가 ONDA로 직접 전송합니다.

  • 생성 POST /gds/vendor/properties
  • 수정 PATCH /gds/vendor/properties/{vendor_property_id}

조회(GET)는 비상용 옵션으로 유지됩니다.

요금제 모델 신설​

요금제가 객실타입 × 요금제 모델의 결합으로 정의됩니다. 요금제 모델은 숙소 단위로 생성하며, standalone은 숙소당 1개 필수, package는 개수 제한이 없습니다.

요금·재고 전송 분리​

  • 요금·영업일 → POST .../ari (요금제 단위)
  • 재고 → POST .../ari/avails (객실타입 단위 통합 재고)

두 호출 모두 전 채널 공통 값과 채널별 값(channels[])을 한 번에 담아 전송합니다.

채널 API 추가​

채널 탐색, 오픈 신청, 채널별 설정, 숙소·객실·요금제 매핑을 API로 처리합니다.

문서 구성​

구분내용
연동 가이드준비부터 채널 오픈, 예약 운영, 취소환불 정책까지 12장
API 레퍼런스HUB API 38개 + 공급사 API 5개 = 43개 엔드포인트

HUB API(공급사 → ONDA)에서 공급사는 클라이언트이고, 공급사 API(ONDA → 공급사)에서는 공급사가 서버입니다. 예약 생성·확정·변경·취소와 취소환불 정책 조회는 공급사가 직접 구현해야 하는 엔드포인트입니다.

AI 개발 지원​

AI 개발 지원 페이지에서 Vendor API 3.0 전용 컨텍스트 파일(Claude Code · Cursor · Windsurf)을 내려받을 수 있습니다.

참고​

  • 개발(alpha) 환경 베이스 URL: https://vendor.dapi.tport.dev
  • 운영 환경 URL과 access token은 연동 계약 후 ONDA 담당자가 안내합니다

Vendor 서버 URL 변경 및 API 문서 UI/UX 개선

이번 업데이트에서는 Vendor API 개발(alpha) 환경 서버 URL이 변경되고, Channel Create Reservation API에 중요한 에러 처리 가이드가 추가되었습니다. 또한 API 레퍼런스 페이지 전반의 가독성과 시각적 일관성이 개선되었습니다.

주요 변경사항​

1. Vendor API 개발(alpha) 환경 서버 URL 변경​

Vendor API의 개발(alpha) 환경 전용 서버 URL이 아래와 같이 변경되었습니다.

  • 변경 전: https://dapi.tport.dev
  • 변경 후: https://vendor.dapi.tport.dev

영향 범위: Vendor API 전체 5개 스펙 (숙소 생성 / 숙소 정보 관리 (Sync) / 숙소 정보 관리 (Push) / 예약 / 기타 API)

2. Channel Create Reservation: 400 에러 처리 안내 추가​

Channel Create Reservation API 문서 상단에 400 channel booking number is exist already 에러 수신 시 처리 방법이 명시되었습니다.

동일 channel_booking_number로 예약 생성 요청이 중복 수신되면 반환되는 이 에러는 즉시 실패 처리(예: 결제 취소)하지 마시고, 아래 절차로 실제 예약 상태를 재확인해야 합니다.

  1. 수신한 channel_booking_number로 Check Reservation API 호출 (type=channel_booking_number 쿼리 파라미터 사용)
  2. 응답에 예약 정보가 존재하면 예약 성공으로 간주하고 내부 상태 동기화
  3. 예약 정보가 없으면 실제 실패이므로 결제 취소 등 통상적인 실패 처리 진행

3. API 레퍼런스 페이지 UI/UX 개선​

API 문서 전반이 ONDA 디자인 시스템에 맞춰 정비되었습니다.

  • Content-type 뱃지: Request / Responses 헤딩 우측에 application/json 뱃지가 표시되어 한눈에 파악 가능
  • Response 코드 탭 위치: description 설명과 같은 행에 정렬되어 세로 공간 효율 향상
  • 중첩 스키마 collapsible: 객체·배열 필드의 접힘 블록에 간격 및 애니메이션이 개선되어 가독성 상승
  • 스키마 표시 정리: REQUIRED 뱃지 위치, 빈 example 자동 숨김, description에 등장하는 enum 값 보존 등 소소한 가독성 개선

문의​

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

Vendor API 에러 코드 가이드 추가

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

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

주요 내용​

에러 응답 포맷​

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

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

에러 코드 목록​

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

카테고리코드 범위
SYSTEM_ERROR1000
AUTH_ERROR2000
VALIDATION_ERROR3000
BUSINESS_ERROR4000 – 4007
UNKNOWN_ERROR9999

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

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

문의​

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

AI 개발 지원 페이지 추가

GNB(상단 네비게이션 바)에 "AI 개발 지원" 메뉴가 추가되었습니다. Claude Code, Cursor, Windsurf 등 AI 개발 도구에 ONDA API 전체 문서를 컨텍스트로 주입하면 더 정확한 코드 제안과 API 이해를 받을 수 있습니다.

주요 변경사항​

AI 개발 지원 전용 페이지 (/ai-tools)​

벤더 API와 채널 API 개발자가 각자의 연동 범위에 맞는 컨텍스트 파일만 선택해 다운로드할 수 있는 전용 페이지가 추가되었습니다.

제공 파일​

파일용도대상
ONDA-VENDOR-CLAUDE.mdClaude Code 컨텍스트벤더 API 개발자
ONDA-VENDOR.mdcCursor 컨텍스트벤더 API 개발자
ONDA-VENDOR.windsurfrulesWindsurf 컨텍스트벤더 API 개발자
ONDA-CHANNEL-CLAUDE.mdClaude Code 컨텍스트채널 API 개발자
ONDA-CHANNEL.mdcCursor 컨텍스트채널 API 개발자
ONDA-CHANNEL.windsurfrulesWindsurf 컨텍스트채널 API 개발자

각 파일은 공통 가이드(Introduction, Getting Started, FAQ)와 해당 API 전용 문서 전체를 포함합니다.

활용 방법​

Claude Code

# 다운로드한 파일을 프로젝트 루트에 저장
mv ~/Downloads/ONDA-VENDOR-CLAUDE.md ./CLAUDE.md
# Claude Code가 자동으로 ONDA Vendor API 컨텍스트를 읽어들입니다

Cursor

# .cursor/rules/ 디렉터리 생성 후 파일 이동
mkdir -p .cursor/rules
mv ~/Downloads/onda-vendor.mdc .cursor/rules/
# Cursor AI가 ONDA Vendor API 컨텍스트를 자동으로 로드합니다

Windsurf

# 다운로드한 파일을 프로젝트 루트에 저장
mv ~/Downloads/ONDA-VENDOR.windsurfrules ./.windsurfrules
# Windsurf AI가 ONDA Vendor API 컨텍스트를 자동으로 인식합니다

문의​

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

Markdown 복사 버튼 추가

채널 API 및 벤더 API 문서 페이지 상단에 "Markdown 복사" 버튼이 추가되었습니다. 개발자가 API 문서 내용을 AI 어시스턴트나 마크다운 에디터에 빠르게 붙여넣을 수 있도록 개선되었습니다.

주요 변경사항​

Markdown 복사 버튼​

  • 위치: 채널 API / 벤더 API 문서 페이지 상단 우측
  • 동작: 버튼 클릭 시 현재 페이지의 내용이 Markdown 형식으로 클립보드에 복사됩니다
  • 피드백: 복사 성공 시 버튼이 2초간 "복사됨" 상태로 전환된 후 원복됩니다

활용 예시​

복사된 Markdown을 다음과 같이 활용할 수 있습니다:

  • ChatGPT, Claude 등 AI 어시스턴트에 붙여넣어 API 연동 관련 질문
  • Notion, Obsidian 등 마크다운 에디터에 문서 내용 저장
  • 개발팀 내 기술 문서 작성 시 참고 자료로 활용

적용 범위​

  • /docs/api/channel/ 하위 모든 API 문서 페이지
  • /docs/api/vendor/ 하위 모든 API 문서 페이지

일반 가이드 문서(/docs/)에는 버튼이 표시되지 않습니다.

문의​

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

Channel API - 숙박상품 설명 필드 글자수 제한 명시

숙박상품 상세 조회(Get Property Detail) API의 설명(descriptions) 필드에 최대 글자수 제한이 명확히 표시되어 채널 파트너사가 데이터를 UI에 표기할 때 참고할 수 있도록 명시되었습니다.

주요 변경사항​

글자수 제한 추가​

다음 4개의 설명 필드에 최대 글자수 제한이 명시되었습니다:

필드명설명최대 글자수
property숙소 소개4,000자
reservation숙소 예약 정보4,000자
notice숙소 별도 공지사항4,000자
refunds숙소 취환불 정책 정보1,000자

API 응답 예시​

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

기대 효과​

  • 채널 파트너사가 UI 표기 시 적절한 글자수 제한을 참고 가능
  • API 연동 시 발생할 수 있는 데이터 오류 사전 방지
  • 더 명확한 API 문서로 개발 편의성 향상

관련 문서​

문의​

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

추가인원 요금 가이드 - 객실 검색 기준 개선

추가인원 요금 가이드의 객실 검색 기준이 개선되었습니다. 이제 최대인원 기준으로 검색하여 총 이용 인원이 투숙할 수 있는 모든 객실을 찾을 수 있습니다.

주요 변경사항​

검색 기준 변경​

항목변경 전변경 후
검색 기준기준인원최대인원
검색 결과기준인원이 일치하는 객실최대인원이 충분한 모든 객실

검색 결과 예시 추가​

4명으로 검색 시 최대인원이 4명 이상인 객실이 모두 검색됩니다:

객실 타입기준인원최대인원검색 결과
스탠다드 더블2명4명✅ 포함
디럭스 트리플3명6명✅ 포함
패밀리 룸4명4명✅ 포함
이코노미 더블2명3명❌ 미포함

기대 효과​

  • 더 많은 객실 옵션을 고객에게 제공 가능
  • 기준인원이 적지만 최대인원이 충분한 객실도 검색 가능
  • 파트너사의 판매 기회 확대

관련 문서​

문의​

가이드 내용에 대해 궁금하신 사항이 있으시면 언제든지 문의해 주세요:

Channel API 개발 가이드 개선

Channel API 개발 가이드 문서가 개선되었습니다. 파트너사가 API 연동 시 자주 문의하는 내용을 바탕으로 가이드를 보강했습니다.

주요 변경사항​

추가인원 요금 가이드 신규 추가​

추가인원 요금(Extra Charge) 처리에 대한 가이드가 새롭게 추가되었습니다.

  • 문서 위치: 추가인원 요금 가이드
  • 주요 내용:
    • 추가인원 요금 필드를 사용하지 않는 이유
    • 올바른 객실 검색 방법 (기준인원 기반)
    • 예약 요청 시 주의사항
    • 고객 안내 필수사항

취소환불 정책 가이드 개선​

기존 취소환불 정책 가이드가 더욱 명확하게 개선되었습니다.

  • 문서 위치: 취소환불 정책 가이드
  • 개선 내용:
    • 핵심 요약 섹션 추가
    • Static Policy vs Dynamic Policy 비교 표 추가
    • 3단계 구현 가이드 추가 (검색 → 예약직전 → 취소처리)
    • API 필드 정보 보강

관련 문서​

문의​

가이드 내용에 대해 궁금하신 사항이 있으시면 언제든지 문의해 주세요:


더 나은 개발 가이드를 제공하기 위해 지속적으로 개선하겠습니다.

ONDA Developer Center 통합 이전

ONDA API 문서가 ONDA Partner Developer Center로 통합 이전되었습니다.

주요 변경사항​

기존에 분리되어 운영되던 Vendor API와 Channel API 문서가 하나의 통합 플랫폼으로 통합되었습니다.

기존 문서 사이트 (운영 종료)​

다음 문서 사이트는 2025년 12월 31일 이후로 더 이상 운영되지 않습니다:

새로운 통합 문서 사이트​

앞으로 모든 ONDA API 문서는 ONDA Partner Developer Center에서 제공됩니다:

새로운 Developer Center의 장점​

통합된 경험​

  • Vendor와 Channel API를 한 곳에서 확인
  • 일관된 UI/UX
  • 통합 검색 기능

개선된 콘텐츠​

  • 더욱 상세한 가이드
  • 실용적인 예제 코드
  • 인터랙티브한 플로우차트

추가 리소스​

북마크 업데이트 안내​

기존 문서 URL을 북마크하신 경우, 새로운 Developer Center URL로 업데이트해 주시기 바랍니다.

문의​

문서 이전과 관련하여 궁금하신 사항이 있으시면 언제든지 문의해 주세요:


ONDA Partner Developer Center에서 더 나은 개발 경험을 제공하겠습니다.