리워드 단계

소비자가 리뷰를 작성한 이후 리워드를 지급하는 단계입니다.

웹훅 방식으로 리워드 지급하기

리뷰가 작성될 때마다 미리 등록한 고객사 웹훅(Webhook) URL로 실시간 적립금 지급 요청을 보낼 수 있습니다. 고객사에서는 미리 약속된 규격에 맞게 API를 구현하여 실시간으로 적립금을 지급할 수 있습니다. 실시간성이 중요한 경우 이 방식을 사용할 수 있습니다.

방화벽 IP 허용하기

만약 고객사의 서버가 방화벽으로 보호되어 있다면, 브이리뷰 서버의 IP를 허용해주셔야 합니다. 아래 IP를 Inbound 정책에서 허용해주시기 바랍니다.

35.78.1.235
52.199.130.191
54.178.86.15

요청 스펙

웹훅 API는 POST 메소드로 전송되며, 리워드 조회 API 스펙과 동일합니다. 조회 API에서 반환되는 응답을 그대로 웹훅 API로 전송해드립니다. 구현하신 웹훅 API URL을 전달 주시면 적용이 가능합니다.

{
  "id": "string",
  "amount": 0,
  "reviewCategory": "VIDEO|IMAGE|TEXT",
  "status": "QUEUED",
  "review": {
    "id": "string",
    "createdAt": "string",
    "updatedAt": "string"
  },
  "order": {
    "id": "string",
    "originId": "string",
    "memberOriginId": "string"
  },
  "orderItem": {
    "id": "string",
    "originId": "string"
  },
  "createdAt": "string"
}

응답 스펙

브이리뷰에서는 웹훅 상태 코드에 따라 적립금 지급 성공/실패를 구분합니다.

성공: 200대 응답 코드
실패: 400대 또는 500대 응답 코드

응답에 message 필드를 사용하여 결과에 대한 힌트를 반환할 수도 있습니다. 이 로그는 브이리뷰 서버에 14일간 저장되며, 향후 리워드와 관련한 문의 시 브이리뷰 개발팀이 쉽게 디버깅 할 수 있는 힌트가 됩니다.

{"message": "이미 지급된 적립금입니다."}

조회 방식으로 리워드 지급하기

리워드 목록 조회 API를 사용하여 지급 대상 목록을 수동으로 조회할 수 있습니다. 이곳에서 조회된 내용을 보고 고객사가 직접 리워드를 지급할 수 있습니다. 관리자가 검수 후 리워드를 지급해야 하는 경우 이 방식을 사용할 수 있습니다.

지급 대기중인 목록을 조회하려면 다음과 같이 status 필드를 QUEUED로 설정하여 조회합니다.

GET /admin/v2/rewards?status=QUEUED

리워드 지급 후에는 리워드 정보 수정 API를 사용하여 상태를 변경합니다.

{
  "status": "SUCCESS"
}

만약 리워드 지급에 실패한 경우 status 필드를 FAILED 또는 CANCELLED로 설정합니다.