본문으로 건너뛰기

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 연동에 대해 궁금하신 사항이 있으시면 언제든지 문의해 주세요: