Versions Compared

Version Old Version 22 New Version Current
Changes made by

남기윤Joel

남기윤Joel

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

1. Purpose

  • 채널은 여행자들이 매력적으로 느낄 수 있는 대량의 여행 상품을 안정적으로 공급을 받고 싶어합니다. 이것은 우리가 제공하는 API 를 통해서 가능합니다.

  • 채널에서 상품을 판매하고 발생한 주문과 환불/취소를 처리하는 일련의 과정을 처리하는 시스템을 채널에 구축하는것을 목적으로 API 를 제공합니다.

2. Authentication

1) Purpose

  • 모든 API 사용을 사용자는 인증을 통하여 정상적인 접근인지 확인이 필요 합니다.

  • 인증을 위해서는 API KEY 를 반드시 발급 받아야 합니다.

2) How to Create API Key

  • API Key 를 발급 받는 방법은 링크와 같습니다. API - 인증

3

...

. Test Server

  • AX에서는 여행상품 판매채널의 구조 파악 및 연동 테스트를 위해 채널에 Test 서버를 제공합니다.

  • Test 서버에서는 AX에서 제공한 샘플 상품 데이터를 채널에 등록하고, 주문을 생성하는 일련의 과정에 대한 테스트를 수행할 수 있습니다.

4) 기타 기술 지원 및 문의

  • AX에서는 원활한 구조 파악 및 기술지원을 위해 이메일 문의를 받고있습니다.

2. Request

  • 실 사용 서버와 연동하기 전에 채널의 시스템을 구축하기 위해 테스트가 필요 합니다.

  • 테스트 목적으로 사용 가능한 API Key 와 서버를 제공합니다.

  • 테스트 서버에서는 실 사용 서버와 동일한 요청과 응답을 제공합니다.

  • 테스트 서버에서는 샘플 데이터를 제공하고 상품 등록부터 주문 생성까지 일련의 과정을 확인할 수 있습니다.

4. Technical Support

  • 액스는 채널이 API 를 이용하여 시스템을 구축하는데 기술적인 지원을 적극적으로 드리고 있습니다.

  • 기술 지원을 위한 Contact Point 는 다음과 같습니다.

5. Request

1) Page

  • 상세한 API 내용은 아래 페이지에서 확인할 수 있습니다.

Page Tree
rootAPI - 요청
startDepth1

2) Diagram

  • 전체 구조에서 요청의 도식화된 흐름을 확인할 수 있습니다.

Inc drawio
zoom1
simple0
custContentId407634107
pageId399704173
lbox1
diagramDisplayName제목 없는 다이어그램-1680594626345.drawio
hiResPreview0
baseUrlhttps://axchange.atlassian.net/wiki
imgPageId399704173
diagramName제목 없는 다이어그램-1680594626345.drawio
pCenter0
aspectF2UH14Gbb7Gd-frNtqDc 1
width931
includedDiagram1
aspectHash5d112e11e5b23ce232dba10daecfe64b7d86f647
linksauto
tbstyletop
height771

3

...

) Table

  • 제공되는 API 의 간략한 정보를 제공합니다.

  • 채널에서 구현이 필수적으로 필요한지 확인할 수 있습니다.

Classification

Request

Detail

EssencialEssential

Product

List

  • 채널에서 판매 가능한 상품 목록을 조회 합니다.

  • AX Cloud 에서 상품이 준비되어 있어야 조회가 가능 합니다.

구현 필수

Product

Detail

  • 채널에 특정 상품을 등록하기 위한 상품 상세 정보를 요청 합니다.

  • 응답에 받아온 정보를 바탕으로 채널에 상품을 등록할 수 있습니다.

구현 필수

Product

Registration

  • 채널에 상품을 등록한 후 등록한 결과 정보를 AX Cloud 에 전송 합니다.

  • 전달 받은 정보로 AX Cloud 에서 관리 합니다.

구현 필수

Product

Get Price

  • 채널에서 판매할 상품의 최신 가격 정보를 조회 합니다.

  • 가능한 최신으로 업데이트가 권장 됩니다.

구현 필수선택

Product

Latest List

  • 변경된 상품들의 최신 정보를 요청 합니다.

  • 채널에 최신 버전의 상품을 등록하기 위해 사용 합니다.

구현 필수

Order

Create

  • 채널에 등록한 상품이 판매 되었을 때 AX Cloud 에 주문을 생성합니다.

  • 주문이 생성되면 Supplier 는 해당 주문을 처리 합니다.

구현 필수

Order

Cancel Order

  • 주문이 생성된 후 특정 주문의 취소를 요청 합니다.

  • 여행자의 의한 Cancel 의 상태를 변경할 수 있습니다.

  • Supplier 에 의한 상태 변경은 채널에서 발생하지 않습니다.

구현 필수

Order

Cancel Ticket

  • 주문의 부분인 티켓 별로 취소합니다.

  • 주문의 부분 취소를 할 수 있습니다.

  • 여행자에 의한 Cancel 상태로 변경할 수 있습니다.

  • Supplier 에 의한 상태 변경은 채널에서 발생하지 않습니다.

구현 필수

Order

Get Confirm

  • 채널에서 Supplier 가 확정한 주문 정보를 조회 합니다.

  • Supplier 가 확정한 주문 정보를 채널에 업데이트 합니다.

구현 필수

Refund

Request Refund

  • 채널에서 발생한 여행자 환불을 AX Cloud 에 요청합니다.

  • 미리 정의된 정책으로 환불 비율 정보를 포함하여 요청 합니다.

구현 필수

Inventory

Quantity

  • 재고는 주문 생성 시 AX Cloud 에서 자동 차감 됩니다.

  • 채널에서 최신 재고 정보를 업데이트 하기 위해 최신 재고를 요청합니다.

구현 필수

Review

Create Review

  • 채널에서 발생한 특정 리뷰를 AX Cloud 에 등록 합니다.

  • AX Cloud 에서 리뷰를 관리할 수 있습니다.

구현 권장

Question

Create Question

  • 채널에서 발생한 여행자 문의 사항을 AX Cloud 에 생성 합니다.

  • AX Cloud 에서 해당 문의 사항 답변을 받을 수 있습니다.

구현 권장

Question

Get Answer

  • 채널이 등록한 질문에 생성된 답변을 조회 합니다.

  • 채널은 여행자의 질문에 답변을 줄 수 있습니다.

구현 권장

...