Versions Compared

Version Old Version 3 New Version Current
Changes made by

오숙영Jenny Oh

김상효Mike

Saved on

Key

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

...

2. API spec

1) Request

Endpoint

구현 예정product environment: https://prod.ax-cloud.com/v1/channel/review/day-tour

Method

GET

Description

특정 Product의 문의 답변을 조회 합니다.

Content-Type

application/json

Headers > Authorization

Token {api_key}

Headers > Channel

Code {channel_code}

2) Query Parameter

...

Name

Required

Type

Description

question_code

O

string

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

3) Response

  • 구현 예정

4) Response Example

  • 구현 예정

5) Error Spec

...

Name

Type

Description

question_code

string

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

answer

string

문의 질문에 대한 답변

Expand
titleStatus Code : 200 Response: AX Cloud 에 생성된 문의
Code Block
{
  "question_code": "090a9be0397",
  "answer": "답변입니다."
}
Expand
titleStatus Code : 204 Response: AX Cloud 에 아직 답변이 없는 경우
Code Block
{
  "detail": "공급자로부터 아직 답변을 받지 못했습니다."
}

5) 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 'GET' \
  'https://prod.ax-cloud.com/v1/channel/question/day-tour/?question_code=090a9be0397' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H "Authorization: Token api_key_secret" \
  -H "Channel: Code code_secret"

...