Versions Compared

Version Old Version 12 New Version Current
Changes made by

김상효Mike (Unlicensed)

김전도Flip (Unlicensed)

Saved on

Key

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

...

Endpoint

product environment: https://prod.ax-cloud.com/v1/channel/question/tour/<product_id>code>

test environment: https://test.ax-cloud.com/v1/channel/question/tour/<product_code>

Method

POST

Description

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

Content-Type

application/json

Headers > Authorization

Token {api_key}

Headers > Channel

Code {channel_code}

2) Body Parameter

Name

Required

Type

Description

question_code

O

String

title

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

  • UUID4 형식의 코드 권장

option_code

X

UUID

질문이 옵션 관련 질문인 경우 상품 옵션 코드가 필요함

title

O

String

문의 제목

body

OX

String

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

is_public

O

String

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

  • UUID4 형식의 코드 권장

questionBool

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

quested_at

O

Datetime

YYYY-MM-DD hh:mm:ss

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

anonymous

O

Bool

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

  • )

여부

3) Response

Name

Type

Description

question_code

string

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

Expand
titleStatus Code : 201 Response: AX Cloud 에 생성된 문의
Code Block
{
  "question_code": "090a9be03976ecf4685-ca60-4a7d-843c-479329ca8789"
}

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)이 없습니다.'}

...

  • 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 '{d '{
      "question_code": "6ecf4685-ca60-4a7d-843c-479329ca8789",
       "questionoption_code": "090a9be03975a8b34ec-1a32-4b70-a5ba-8f2c81ec4c09",
      "title": "투어상품 관련문의.",
      "body": "준비물은 없나요?",
      "questionis_public": true,
      "quested_at": "2022-01-21T1021 10:00:00.000Z",
      "anonymous": true
}'

...