Versions Compared

Key

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

...

2. API spec

1) Request

Endpoint

구현 예정https://prod.ax-cloud.com/v1/channel/question/tour/<product_id>

Method

POST

Description

특정 Product의 문의를 생성 합니다.

Content-Type

application/json

Headers > Authorization

Token {api_key}

Headers > Channel

Code {channel_code}

2)

...

  • 구현 예정

3) Response

  • 구현 예정

4) Response Example

  • 구현 예정

5) Error Spec

...

Body Parameter

Name

Required

Type

Description

title

X

String

문의 제목

body

O

String

문의 본문. 제목이 따로 없는 경우 본문으로 전달.

question_code

O

String

답변을 식별할 수 있도록 채널에서 생성한 질문의 식별자

  • UUID4 형식의 코드 권장

question_at

O

Datetime

YYYY-MM-DD hh:mm

  • 문의 작성시간 (채널 기준)

anonymous

O

Bool

공개질문/비공개질문(판매자, 문의자만 조회) 여부

3) Response

Name

Type

Description

question_code

string

  • 답변을 식별할 수 있도록 채널에서 생성한 질문의 식별자

Expand
titleStatus Code : 201 Response: AX Cloud 에 생성된 주문
Code Block
{
  "question_code": "090a9be0397"
}

4) Error Spec

Expand
titleStatus Code : 400 Cause: 유효하지 않은 요청 값
Code Block
{'body': '이 필드는 null일 수 없습니다.'}
Expand
titleStatus Code : 403 Cause: 유효하지 않은 API Key 혹은 Channel Code
Code Block
{'message': '이 작업을 수행할 권한(permission)이 없습니다.'}

3. Request Example

1) CURL

  • 구현 예정
    Code Block
    curl -X 'POST' \
      'https://prod.ax-cloud.com/v1/channel/question/tour' \
      -H 'accept: application/json' \
      -H 'Content-Type: application/json' \
      -H "Authorization: Token api_key_secret" \
      -H "Channel: Code code_secret" \
      -d '{
          "question_code": "090a9be0397",
          "title": "투어상품 관련문의.",
          "body": "준비물은 없나요?",
          "question_at": "2022-01-21T10:00:00.000Z",
          "anonymous": true
    }'

...