Versions Compared

Version Old Version 6 New Version Current
Changes made by

송훈일Neil

김상효Mike (Unlicensed)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

...

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/400359494

2. API spec

1) Request

Endpoint

product environment: https://prod.ax-cloud.com/v1/channel/products/day-ticket

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

dataproducts

List[Object]

판매 가능한 상품 리스트

product_idcode

StringUUID

상품 아이디식별자

title

String

상품 제목

category

String

상품 카테고리

ticketdetail_category_code

String

AX 카테고리 코드

[티켓 카테고리 데이터는 문의]

keyword상품 세부 카테고리

start_date_of_the_sale

Date

판매 기간 시작 날짜

end_date_of_the_sale

Date

판매 기간 종료 날짜

cancellation_type

String

주문 취소 타입

main_country_and_city

String

티켓 대표 주 국가 및 도시

[국가-도시 데이터는 문의]

4) Response Example

Expand
titleStatus Code : 200 정상 처리 시
Code Block
languagejson
{
  "status_code": 200,
  "dataproducts": [
    {
      "idproduct_code": 1"1f373f00-ecb0-485a-beed-63529d61703f",
      "title": "TestLouvre Highlight Ticket",
      "category": "TestTicket-Day",
      "detail_category": "Museum",
      "ticket_category_codestart_date_of_the_sale": "Test", 2023-03-01",
      "end_date_of_the_sale": "2024-03-31",
      "keywordmain_country_and_city": "Test52-18"
    }
  ]
}

5) Error Spec

...

titleStatus Code : 400 Cause: 유효하지 않은 요청 값

...

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

3. Request Example

1) CURL

Code Block
curl -X 'GET' \
  'https://prod.ax-cloud.com/v1/channel/products/tourday-ticket' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Token api_key_secret' \
  -H 'Channel: Code code_secret'
  -d '{
  "status_code": 200,
  "products": [
    {
      "product_code": "1f373f00-ecb0-485a-beed-63529d61703f",
      "title": "Louvre Highlight Ticket",
      "category": "Ticket-Day",
      "detail_category": "Museum",
      "start_date_of_the_sale": "2023-03-01",
      "end_date_of_the_sale": "2024-03-31",
      "main_country_and_city": "52-18"
    }
  ]
}'

...