본문으로 건너뛰기

ONDA → Vendor Request

온다에서 벤더(숙박업체) 시스템으로 데이터를 요청하는 Pull 방식의 연동 가이드입니다.

개요​

ONDA → Vendor Request 방식은 온다 시스템이 벤더의 API를 직접 호출하여 최신 정보를 획득하는 연동 방식입니다.

특징​

  • 실시간 데이터 획득: 온다가 필요한 시점에 벤더 시스템에서 최신 데이터 조회
  • Pull 방식: 온다가 능동적으로 데이터를 요청
  • 즉시성: 실시간으로 최신 정보 확인 가능
  • 신뢰성: 벤더 시스템을 직접 조회하여 정확한 정보 획득

연동 흐름​

주요 API 엔드포인트​

벤더 시스템에서 구현해야 하는 주요 API들:

1. 숙소 정보 조회​

  • 목적: 업데이트된 숙소 정보 확인
  • 호출 주기: 일 1회 또는 필요시
  • 응답 데이터: 숙소 기본 정보, 편의시설, 이미지 등

2. 객실 정보 조회​

  • 목적: 객실 타입 및 상세 정보 확인
  • 호출 주기: 일 1회 또는 필요시
  • 응답 데이터: 객실 타입, 최대 인원, 편의시설 등

3. 요금 정보 조회​

  • 목적: 실시간 요금 정보 확인
  • 호출 주기: 실시간 (검색/예약 요청시)
  • 응답 데이터: 객실별 요금, 할인 정보, 취소 정책 등

4. 예약 가능 여부 조회​

  • 목적: 재고 및 예약 가능 상태 확인
  • 호출 주기: 실시간 (검색/예약 요청시)
  • 응답 데이터: 객실별 재고, 예약 가능 여부

인증 및 보안​

API 인증​

  • 방식: API Key 기반 인증
  • 헤더: Authorization: Bearer {API_KEY}
  • 보안: HTTPS 필수, API Key 암호화 저장

IP 화이트리스트​

  • 온다 서버 IP 주소를 벤더 시스템에 등록
  • 허용된 IP에서만 API 호출 가능
  • 보안 강화를 위한 추가 인증 계층

응답 포맷​

모든 API 응답은 JSON 형식을 사용합니다:

{
  "status": "success",
  "message": "요청이 성공적으로 처리되었습니다",
  "data": {
    // 실제 데이터 내용
  },
  "timestamp": "2024-09-26T15:30:00Z"
}

에러 응답​

{
  "status": "error",
  "error_code": "INVALID_REQUEST",
  "message": "요청 파라미터가 올바르지 않습니다",
  "details": "check_in 날짜가 누락되었습니다",
  "timestamp": "2024-09-26T15:30:00Z"
}

개발 가이드​

1. API 엔드포인트 구현​

벤더 시스템에서 온다가 호출할 API 엔드포인트를 구현해야 합니다.

2. 데이터 포맷 준수​

온다 시스템과 호환되는 데이터 포맷으로 응답해야 합니다.

3. 에러 핸들링​

적절한 HTTP 상태 코드와 에러 메시지를 제공해야 합니다.

4. 성능 최적화​

  • 응답 시간 최소화 (권장: 3초 이내)
  • 캐싱 활용으로 성능 향상
  • 대용량 데이터의 경우 페이징 처리

테스트 가이드​

1. 개발 환경 테스트​

  • 온다 테스트 서버에서 벤더 개발 API 호출
  • 기본적인 API 응답 확인
  • 데이터 포맷 검증

2. 통합 테스트​

  • 실제 데이터를 사용한 통합 테스트
  • 성능 및 안정성 검증
  • 에러 시나리오 테스트

3. 운영 전 검증​

  • 운영 환경 설정 확인
  • 모니터링 도구 설정
  • 장애 대응 절차 확인

모니터링 및 운영​

로그 관리​

  • API 호출 로그 기록
  • 에러 로그 모니터링
  • 성능 지표 추적

알람 설정​

  • API 응답 시간 지연 알람
  • 에러율 증가 알람
  • 시스템 장애 알람

다음: Vendor → ONDA Request 방식 가이드