일정에 대한 API 제공
일정를 사용하면 고객의 예약 정보를 표시하고 투어나 체험과 같은 booking-related 상품이나 서비스를 찾을 수 있도록 도와줄 수 있습니다. 또한 데이터를 사용하여 예약 트렌드를 분석하고 이해관계자를 위한 보고서를 작성할 수도 있습니다.
배송 옵션
일정 데이터의 API 전송은 푸시 또는 풀 메커니즘을 사용할 수 있습니다.
푸시 메커니즘
푸시 서비스는 near-real 시간에 핵심적인 transaction-level 세부 정보에 초점을 맞춰 일정 업데이트가 제공되면 이를 전송하도록 설계되었습니다. 이 옵션을 사용하면 다음과 같이 할 수 있습니다:
- 웹사이트 또는 앱에 고객의 예약 정보를 표시합니다.
- 고객에게 여행에 필요한 추가 제품 및 서비스 구매를 제안하세요.
푸시 이벤트는 웹훅을 통해 HTTP POST
메시지 형식으로 사용자가 제공한 URL로 전달됩니다. 이러한 메시지는 순서 없이 도착할 수 있으므로 creation_date
및 update_date_time
요소를 참조하여 순서를 결정하세요.
이 배달 옵션을 채택하는 방법에 대한 자세한 내용은 API 설정을 참조하세요.
풀 메커니즘
풀 서비스는 자세한 일정 데이터를 지원합니다:
- 데이터 분석
- 푸시 전송이 실패한 기간에 대한 데이터 검색
- 헬프 데스크 조사
이 서비스는 두 개의 HTTP GET
엔드포인트로 구성되어 있습니다:
creation_date_start
,creation_date_end
,update_date_time_start
,update_date_time_end
변수를 사용하여 지정된 시간 범위에서 생성되거나 업데이트된 일정 목록을 만듭니다.- 특정 일정를 검색합니다.
itinerary_id
인증 프로세스에 대한 자세한 내용은 API 설정 을 참조하세요.
사용 가능한 필드
아래 표에는 중첩된 개체를 포함하여 푸시 및 풀 제공 방식을 통해 사용 가능한 필드가 나열되어 있습니다.
이름과 그 뒤의 마침표로 시작하는 필드 이름(예: <variable>.<nested variable>)은 중첩 관계를 나타냅니다.
화이트 레이블 템플릿
필드 이름 | 정의 | 예 |
---|---|---|
itinerary_id | 일정 번호 또는 POS 주문 참조 번호입니다. | 72622069245694 |
status | 일정 및 개별 항목의 상태입니다. | 가능한 값입니다: confirmed 취소됨 |
creation_date * | 예약이 처음 이루어진 날짜로, ISO 8601 날짜 형식으로 표시됩니다(YYYY-MM-DD). | 2023-02-05 |
update_date_time * | ISO 8601 날짜 형식으로 표시된 일정의 마지막 업데이트 날짜 및 시간(YYYY-MM-dd'T"HH:mm:ss.SSSZ)입니다. | 2023-10-21T00:00:00.000Z |
online | 일정가 온라인(참)으로 예약되었는지 또는 에이전트를 통해 예약되었는지(거짓)를 나타냅니다. 부울 값으로 표시됩니다. | true |
package | 일정가 패키지의 일부인지, 아니면 독립형 예약인지 표시합니다. 부울 값으로 표시됩니다. | false |
payment_type | 결제 페이지에서 사용한 결제 수단입니다. | 가능한 값: 신용카드 포인트 분할 결제 |
point_of_sale_country_code | 고객이 예약을 한 POS의 국가 코드입니다. ISO 3166-1 alpha-2 형식의 두 글자로 표시됩니다. | GB |
purchaser | 예약한 사람의 신원 정보입니다. 중첩된 항목의 목록은 purchaser 표를 참조해 주세요. | |
property_booking_items | 일정의 일부로 예약된 숙박 시설 구성 요소입니다. 중첩된 항목의 목록은 property_booking_items 표를 참조해 주세요. | |
flight_booking_items | 일정의 일부로 예약된 항공 구성 요소입니다. 중첩된 항목의 목록은 flight_booking_items 표를 참조해 주세요. | |
car_booking_items | 일정의 일부로 예약된 렌터카 구성 요소입니다. 중첩된 항목의 목록은 car_booking_items 표를 참조해 주세요. | |
activity_booking_items | 일정의 일부로 예약된 즐길거리 구성 요소입니다. 중첩된 항목의 목록은 activity_booking_items 표를 참조해 주세요. | |
insurance_booking_items | 일정의 일부로 예약된 보험 구성 요소입니다. 중첩된 항목의 목록은 insurance_booking_items 표를 참조해 주세요. | |
rate | 예약 항목 또는 전체 일정의 요금 및 가격 세부 정보입니다. 중첩된 항목의 목록은 rate 표를 참조해 주세요. | |
coupon | 해당되는 경우 일정에 적용된 쿠폰입니다. 중첩된 항목의 목록은 coupon 표를 참조해 주세요. |
모든 화이트 라벨 템플릿 필드에 대한 참고 사항
* 날짜 필드는 협정 세계시(UTC) 기준입니다.
** 개인 식별 정보(PII) 데이터를 나타냅니다. 이 정보는 회사의 지침에 따라 올바르게 처리해야 합니다. 꼭 필요한 경우에만 포함해 주세요.
*** 해당 필드에 대한 데이터는 예약이 생성되거나 업데이트된 다음 날 오후 6시부터 오후 8시(UTC) 사이에 제공됩니다. 현재 실시간에 가까운 데이터는 제공되지 않습니다.
여행사 제휴 프로그램(TAAP)
필드 이름 | 정의 | 예 |
---|---|---|
itinerary_id | 일정 번호 또는 POS 주문 참조 번호입니다. | 72622069245694 |
status | 일정 및 개별 항목의 상태입니다. | 가능한 값입니다: confirmed 취소됨 |
creation_date * | 예약이 처음 이루어진 날짜로, ISO 8601 날짜 형식으로 표시됩니다(YYYY-MM-DD). | 2023-02-05 |
update_date_time * | ISO 8601 날짜 형식으로 표시된 일정의 마지막 업데이트 날짜 및 시간(YYYY-MM-dd'T"HH:mm:ss.SSSZ). | 2023-10-21T00:00:00.000Z |
online | 일정가 온라인(참)으로 예약되었는지, 아니면 에이전트를 통해 예약되었는지(거짓)를 나타냅니다. 부울 값으로 표시됩니다. | true |
point_of_sale_country_code | 고객이 예약한 국가의 코드입니다. ISO 3166-1 alpha-2 형식의 두 글자로 표시됩니다. | GB |
purchaser | 예약한 사람의 신원 정보입니다. 중첩된 항목의 목록은 purchaser 표를 참조해 주세요. | |
agency | 예약을 진행한 TAAP 여행사 및 에이전트의 신원 확인. 중첩된 항목의 목록은 agency 표를 참조해 주세요. | |
payment | 일정에 대한 결제 정보입니다. 중첩된 항목의 목록은 payment 표를 참조해 주세요. | |
property_booking_items | 일정의 일부로 예약된 숙박 시설 구성 요소입니다. 중첩된 항목의 목록은 property_booking_items 표를 참조해 주세요. | |
flight_booking_items | 일정의 일부로 예약된 항공 구성 요소입니다. 중첩된 항목의 목록은 flight_booking_items 표를 참조해 주세요. | |
car_booking_items | 일정의 일부로 예약된 렌터카 구성 요소입니다. 중첩된 항목의 목록은 car_booking_items 표를 참조해 주세요. | |
activity_booking_items | 일정의 일부로 예약된 즐길거리 구성 요소입니다. 중첩된 항목의 목록은 activity_booking_items 표를 참조해 주세요. | |
rate | 예약 항목 또는 전체 일정의 요금 및 가격 세부 정보입니다. 중첩된 항목의 목록은 rate 표를 참조해 주세요. | |
earnings | 예약 항목 또는 전체 일정의 수수료 세부 정보입니다. 중첩된 항목의 목록은 earnings 표를 참조해 주세요. |
모든 TAAP 필드에 대한 참고 사항
* 날짜 필드는 협정 세계시(UTC) 기준입니다. ** 개인 식별 정보(PII) 데이터를 나타냅니다. 이 정보는 회사의 지침에 따라 올바르게 처리해야 합니다. 꼭 필요한 경우에만 입력해 주세요. *** 해당 필드의 데이터는 예약이 생성되거나 업데이트된 다음 날 오후 6시부터 오후 8시(UTC) 사이에 제공됩니다. 현재 실시간에 가까운 데이터는 제공되지 않습니다.
API 세부 정보
비즈니스에서 여정 API 데이터를 사용하는 방식에 따라 API 스키마 및 구성에 대한 스냅샷을 제공했습니다. OpenAPI 사양을 다운로드하고 API 테스트 소프트웨어를 사용하여 예제 및 스키마 정의가 실제 출력과 어떻게 비교되는지 이해할 수 있습니다.
화이트 레이블 템플릿
푸시 및 풀 전달 방법을 통해 화이트 라벨 템플릿 파트너가 사용할 수 있는 필드(중첩된 개체 포함)는 다음과 같습니다:
TAAP
푸시 및 풀 전달 방법을 통해 TAAP 파트너가 사용할 수 있는 필드(중첩된 개체 포함)는 다음과 같습니다: