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

2. API spec

1) Request

Endpoint

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

data

List[Object]

판매 가능한 상품 리스트

product_id

String

상품 아이디

title

String

상품 제목

category

String

상품 카테고리

ticket_category_code

String

AX 카테고리 코드

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

keyword_city

String

티켓 대표 도시

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

4) Response Example

 Status Code : 200 정상 처리 시
{
  "status_code": 200,
  "data": [
    {
      "id": 1,
      "title": "Test",
      "category": "Test", 
      "ticket_category_code": "Test", 
      "keyword_city": "Test"
    }
  ]
}

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/day-ticket' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Token api_key_secret' \
  -H 'Channel: Code code_secret'

  • No labels