Versions Compared

Version Old Version 16 New Version Current
Changes made by

남기윤Joel (Unlicensed)

남기윤Joel (Unlicensed)

Saved on

Key

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

...

1. Create Review

1) Purpose

  • 채널에서 특정 상품에 대한 생성된 리뷰를 AX Cloud 에 등록 합니다.

  • 리뷰를 AX Cloud 에서 관리할 수 있습니다.

...

Endpoint

product environment: https://prod.ax-cloud.com/v1/channel/review/tour/<product_code>

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

Method

POST

Description

채널의 리뷰 정보를 생성 합니다.

Content-Type

application/json

Headers > Authorization

Token {api_key}

2) Path Parameter

Name

Required

Type

Description

product_code

X

UUID

  • 상품 식별자

3) Body Parameter

Name

Required

Type

Description

channel_order

option_code

X

UUID

  • 특정 옵션에 리뷰가 생성된 경우, 옵션 식별자

review_code

Xreview_

O

String

  • 주문생성시 채널이 생성한 주문의 식별자입니다.

  • 어떤 주문에 대한 리뷰인지 추적을 위한 값입니다. 공급사 편의를 위해 가능하다면 함께 전달하는것을 권장합니다.

  • 채널의 리뷰 고유 식별자

  • UUID4 형식의 코드 권장

score_type

O

Choice from

{

ONE

“ZERO_FIVE_

STAR

STAR”,

ZERO

“ONE_FIVE_

STAR

STAR”,

GOOD

“GOOD_OR_

BAD

BAD”,

NO

“NO_

SCORE

SCORE”

}

리뷰의 평가 지표 종류

  • ONE_FIVE

1~5개의 별점등의 평가지표

    • 0~5개의 별점 등의 평가 지표 사용시

  • ZERO_FIVE

0~5개의 별점등의 평가지표

    • 1~5개의 별점 등의 평가 지표 사용시

  • GOOD_OR_BAD

    • 좋음/싫음, 긍정/부정 등의 흑백

평가지표

    • 평가 지표 사용시

  • NO_SCORE

평가지표

    • 평가 지표 없을시

review_

title

X

score

X(score_type=NO_SCORE인 경우만 생략 가능)

Integer

  • 평가지표가 “NO_SCORE”가 아니라면 필수

  • 여행자의 점수를 0점이 최저점, 100점 만점 기준으로 환산한 점수

  • 최저점~최고점 사이의 점수로 환산

  • 소수점 첫째자리에서 반올림한 정수

  • ex) 별점 0점이 최저점, 5점이 만점인 채널에서 5점 → 100

  • ex) 별점 0점이 최저점, 5점 만점인 채널에서 4.2점 → 84

  • ex) 별점 1점이 최저점, 5점 만점인 채널에서 3점 → 50

  • ex) 별점 1점이 최저점, 5점 만점인 채널에서 4.5점 → 87.5 → 88

  • 좋음/싫음, 긍정/부정 등의 흑백 평가지표 사용시 0, 100

리뷰 평가 지표별 점수

  • ONE_FIVE

    • 1~5

  • ZERO_FIVE

    • 0~5

  • GOOD_OR_BAD

    • 싫음: 0, 좋음: 1

  • NO_SCORE

    • 입력하지 않음

title

O

String

  • 리뷰 제목

body

O

X

String

  • 리뷰 본문

. 제목은 없고 본문만 존재할 경우 본문만 전송

reviewed_at

O

DateTime

YYYY-MM-DD hh:mm

  • 리뷰 작성시간 (채널 기준)

reviewer_info

X

Object

  • 리뷰 작성자 정보 (주문 정보가 없는 경우 필요)

name

X

String

  • 리뷰 작성자 이름

phone

X

String

  • 리뷰 작성자 전화

email

X

String

  • 리뷰 작성자 이메일

3) Response

Name

Type

Description

channel_order_code

string

  • 주문생성시 채널이 생성한 주문의 식별자입니다.

Expand
titleStatus Code : 201 Response: AX Cloud 에 생성된 주문
Code Block
{
  "channel_orderproduct_code": "090a9be039755f2eaaf-154f-4552-adcd-d2542b4153eb"
}

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/review/tour/order-212312886c434e-57a8-450c-8b02-8fdea38de821' \
  -H 'accept: application/json' \
  -H 'Content-Type: application/json' \
  -H "Authorization: Token api_key_secret" \
  -d '{
      "channeloption_order_code": "090a9be039755f2eaaf-154f-4552-adcd-d2542b4153eb",
      "review_code": "95ac32c5-7f11-41a1-a638-3874b9c3ccbc",
      "score_type": "ONE_FIVE",
      "review_score": 1005,
      "title": "즐거운가이드 경험이었습니다칭찬합니다.",
      "body": "친절한 가이드분 덕분에 즐거웠습니다.",
      "reviewed_at": "2022-01-21T1021 10:00:00.000Z",
      "reviewer_info": {
        "name": "홍길동",
        "phone": "01012341234",
        "email": "ABC@abc.com"
      }000"
}'

...