본문으로 건너뛰기

준비 단계

준비 단계는 서비스 개발 전 필요한 API 키 발급과, 기존 쇼핑몰에서 운영하던 데이터를 브이리뷰로 이관하는 과정입니다.

브이리뷰 API 연동 준비 단계

API 키 발급 및 인증하기

브이리뷰 백엔드 연동을 위해서는 API 키를 발급받고 API 요청에 인증 헤더를 포함해야 합니다. 현재 API 키는 검수를 통해서만 생성할 수 있습니다. cs@indentcorp.com 이메일로 아래 정보를 기입하여 요청해주세요.

  • 쇼핑몰 이름:
  • 쇼핑몰 URL:

인증 헤더 사용하기

HTTP Authorization 헤더를 이용해서 인증 토큰을 전송합니다. 인증 토큰은 발급받은 ACCESS_KEY_ID 와 SECRET_ACCESS_KEY를 : 구분자로 합친 뒤, Base64 인코딩한 값입니다. 의사코드로 나타내면 다음과 같습니다.

base64Encode("${ACCESS_KEY_ID}:${SECRET_ACCESS_KEY})

모든 API에는 위 인증 헤더가 필수로 포함되어야 합니다.

Authorization: Basic <TOKEN>

예시:

Authorization: Basic bN3J7OCeEF41...JOyD6Q

API 키 검증하기

발급받은 API 키를 사용해서 쇼핑몰 정보 API를 호출해 봅니다.

curl \
  --request GET 'https://api.vreview.tv/admin/v2/mall' \
  --header 'Authorization: Basic <TOKEN>'

ID 체계

브이리뷰에는 두 가지 종류의 ID가 존재합니다.

1. id

브이리뷰 시스템 내에서 사용하는 식별자입니다. P2b6Om2D와 같이 난수 형태로 이루어져 있습니다. 이 값을 이용해서 데이터를 조회하고 수정할 수 있습니다.

주로 다음과 같이 표기됩니다.

  • id
  • reviewId
  • productId

originId

고객사 시스템에서 사용하는 식별자입니다. 원본이 브이리뷰가 아니라 고객사에 있는 데이터는 이 식별자를 가집니다. 대표적으로 주문이나 상품, 카테고리 정보 등이 있습니다.

주로 다음과 같이 'origin' 키워드가 함께 표기됩니다.

  • originId
  • orderOriginId
  • memberOriginId
  • productOriginId

상품 데이터 등록하기

쇼핑물에서 판매중인 상품 데이터를 브이리뷰에 등록할 수 있습니다. 등록한 데이터는 위젯이나 챗봇 등에서 리뷰의 상품 정보를 표시할 때 사용됩니다.

만약 구매 단계에서 등록되지 않은 상품에 대한 주문이 생성될 경우, 챗봇 등에서 '알 수 없는 상품'으로 표시됩니다.

API로 등록하기

상품 데이터가 1만 건 미만인 경우에는 API로 등록하는 방법을 권장합니다. 상품 일괄 생성 API를 사용해서 상품 데이터를 등록할 수 있습니다. 카테고리 정보 등 상세한 정보는 API 레퍼런스 문서를 참고해 주세요.

[
  {
    "originId": "7309",
    "name": "에어리핏 오버핏 티셔츠",
    "imageUrl": "https://example.com/myimage.jpg"
  }
]

한 번의 요청에 최대 100개까지 요청할 수 있습니다. 요청한 즉시 비동기 작업이 생성되며, 비동기 작업 상태를 조회할 수 있는 jobId가 요청한 데이터 순서대로 반환됩니다. 이 값을 일괄 생성 작업 조회 API에 사용해서 작업 상태를 조회할 수 있습니다.

파일로 등록하기

상품 데이터가 1만 건 이상인 경우 엑셀 또는 CSV 파일을 통해 등록할 수 있습니다. 데이터 이관 양식 다운로드 후 해당 양식에 맞게 엑셀 또는 CSV 파일을 생성해주세요. 이후 cs@indentcorp.com 이메일로 아래 정보를 기입하여 요청해주시면 검수 후 이관이 시작됩니다.

  • 쇼핑몰 이름:
  • 쇼핑몰 URL:
  • 데이터 파일:

주문 및 리뷰 데이터 등록하기

쇼핑몰에서 운영하던 주문 및 리뷰 데이터가 있다면 상품과 마찬가지로 API 또는 파일로 등록할 수 있습니다. 주문과 리뷰는 마이페이지 등의 위젯에서 작성 가능한 리뷰 또는 작성한 리뷰를 표시할 때 사용됩니다. 이 과정에서 등록한 주문 중 배송완료일이 2일 이내인 경우 배송완료 알림톡이, 브이리뷰 관리자에서 설정한 구매감사톡 발송 기한 이내인 경우 구매감사톡이 발송됩니다. 만약 알림톡 발송을 희망하지 않는 경우 배송 완료일을 더 과거의 날짜로 지정해 주시면 됩니다.

API로 등록하기

주문 또는 리뷰 데이터가 1만 건 미만인 경우 API 방식을 권장합니다. 주문 일괄 생성 API와 리뷰 일괄 생성 API를 참고해 주세요.

리뷰 생성 API의 경우 어뷰징 방지를 위해 운영팀의 검수 후 사용이 가능합니다. 리뷰 생성 API를 사용하시려는 경우 cs@indentcorp.com 이메일로 아래 정보를 기입하여 요청해주세요.

  • 쇼핑몰 이름:
  • 쇼핑몰 URL:
  • 리뷰 API 사용 목적:

파일로 등록하기

데이터가 1만 건 이상인 경우 엑셀 또는 CSV 파일을 통해 등록할 수 있습니다. 데이터 이관 양식 다운로드 후 해당 양식에 맞게 엑셀 또는 CSV 파일을 생성해주세요. 이후 cs@indentcorp.com 이메일로 아래 정보를 기입하여 요청해주시면 검수 후 이관이 시작됩니다.

  • 쇼핑몰 이름:
  • 쇼핑몰 URL:
  • 데이터 파일: