Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

« Previous Version 45 Next »

1. Product List

1) Purpose

  • Channel에서 판매 가능한 Product List를 확인하기 위한 API입니다.

2) Detail

  • Header에 입력한 정보와 일치하는 Channel이 판매 가능한 Product List를 보여줍니다.

  • 유효한 API Key를 Request Header에 토큰으로 입력해야만 호출 가능합니다.

  • 하나의 특정한 Product에 대한 상세 조회는 별도의 API에서 가능합니다. - https://axchange.atlassian.net/wiki/spaces/ACCD/pages/edit-v2/398327880

2. API spec

1) Request

Endpoint

product 환경: https://prod.ax-cloud.com/v1/channel/products/tour

test 환경: https://test.ax-cloud.com/v1/channel/products/tour

Method

GET

Description

Product List 를 조회합니다.

Content-Type

application/json

Headers > Authorization

Token {api_key}

Headers > Channel

Code {channel_code}

2) Query Parameter

Name

Required

Type

Description

page

X

Integer

Page number(default : 1)

page_size

X

Integer

Size per page(default : 25)

3) Response

Name

Type

Description

status_code

Integer

정상 처리 시 200

products

List[Object]

판매 가능한 상품 리스트

product_code

String

상품 식별자

category

String

상품 카테고리

product_listing_language

String

상품 언어

tour_guide_certification

Choose from {
Yes,
No
}

투어 가이드의 자격증 소지 여부

separate_driver_included

Choose from {
Yes,
No
}

투어 가이드가 운전사 역할도 하는지 여부

product_name

String

상품 이름

departure_city

요청 - 표준 데이터의 ‘국가 - 도시’

출발 도시

transportation

String

탈 것

cancellation_type

String

주문 취소 타입

4) Response Example

 Status Code : 200 정상 처리 시
{
  "status_code": 200,
  "products": [
    {
      "product_code": "1f373f00-ecb0-485a-beed-63529d61703e",
      "category": "Tour", 
      "product_listing_language": "Englisg",
      "tour_guide_certification": "Yes",
      "separate_driver_included": "No",
      "product_name": "New Bern City Tour"
      "departure_city": "United States - New Bern, NC", 
      "transportation": "On Foot", 
      "cancellation_type": "Anytime cancellation"
    }
  ]
}

5) Error Spec

 Status Code : 403 Cause: 유효하지 않은 API Key 혹은 Channel Code
{"detail": ErrorDetail(string="이 작업을 수행할 권한(permission)이 없습니다.", code="permission_denied")}

3. Request Example

1) CURL

curl -X 'GET' \
  'https://prod.ax-cloud.com/v1/channel/products/tour' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Token api_key_secret' \
  -d '{
  "status_code": 200,
  "products": [
    {
      "product_code": "1f373f00-ecb0-485a-beed-63529d61703e",
      "category": "Tour", 
      "product_listing_language": "Englisg",
      "tour_guide_certification": "Yes",
      "separate_driver_included": "No",
      "product_name": "New Bern City Tour"
      "departure_city": "United States - New Bern, NC", 
      "transportation": "On Foot", 
      "cancellation_type": "Anytime cancellation"
    }
  ]
}'

  • No labels