이벤트

X2BEE BO에 등록된 이벤트 정보를 호출하여 이벤트 페이지에 사용되는 API를 설명합니다.

이벤트 유형

  • 추첨 이벤트 : 단순클릭, 설문, 댓글, 구매자 추첨

  • 비추첨 이벤트 : 구매사은, 출석체크, 쿠폰 다운로드, 룰렛

2023년 11월 06일 룰렛과 구매자 추첨 이벤트 기능이 추가되어 각 이벤트에 대한 설명이 추가되었습니다.

PC

 

image-20240416-044219.png

 

Mobile

 

image-20240416-044225.png

 


이벤트 페이지(공통)

 

이벤트는 공통으로 사용하는 API 활용합니다.

해당 API 외 이벤트에 필요한 API는 추가로 설명하였습니다.

1. 목록 조회

전시기간, 전시여부, 진행상태등에 다양한 조건으로 이벤트 목록을 조회할 수 있습니다.

조회 결과에는 등록 된 이벤트의 이미지, 제목, 진행일정에 대한 정보가 포함됩니다.

  • 적용가능 이벤트 유형 : 일반응모/댓글/출석체크/구매사은/쿠폰 다운로드

이벤트 목록 조회

GET /v1/marketing/getEventList 🔗API 확인하기 >

전시기간, 전시여부, 진행상태 등 조건에 맞는 이벤트 조회할 수 있습니다.

2. 이벤트 상세 조회

이벤트의 상세 정보를 조회할 수 있습니다.

이 API를 사용하여 일반응모, 댓글, 출석체크, 구매사은, 쿠폰 다운로드 이벤트의 상세 정보를 조회할 수 있습니다.

이벤트 상세 조회

GET /v1/marketing/getEventDetail 🔗API 확인하기 >

이벤트에 대한 상세 정보를 조회 할 수 있습니다.

3. 이벤트 응모하기

X2BEE에서 제공하는 모든 이벤트 유형에 따른 응모 할 수 있는 API입니다.

이 API를 사용하여 일반응모, 댓글, 출석체크, 구매사은, 쿠폰 다운로드 및 설문과 같은 다양한 이벤트에 응모할 수 있습니다.

‘이벤트 상세 조회하기’와 ‘이벤트 응모하기’ API가 이벤트 유형에 따라 동작하는 내용을 설명합니다.

다음 이벤트 유형에 대한 API는 이벤트 페이지(공통)를 참고해주세요

4. 출석체크 이벤트

4.1 출석체크 이벤트 상세 조회하기

이벤트 기본 정보와 고객의 출석체크 정보와 기 출석 회수에 대한 정보를 조회할 수 있습니다.

4.2 응모하기
[출석하기] 버튼을 클릭하면 출석 처리가 진행되고, 베네핏을 지급합니다.

5. 구매 사은 이벤트

5.1 구매 사은 이벤트 상세 조회하기

이벤트 기본 정보와 회원 주문 정보 목록을 조회하여 지정된 목표 금액 달성여부를 조회할 수 있습니다.

5.2 응모하기

나의 구매 금액이 이벤트 조건이 충족되면, [응모하기] 버튼을 클릭해 이벤트에 응모를 할 수 있습니다.

6. 댓글 이벤트

6.1 댓글 이벤트 상세 조회하기

댓글 이벤트의 기본 정보와 등록된 댓글 목록을 조회 할 수 있습니다

6.2 등록(응모)하기

해당 이벤트의 댓글 입력란에 댓글이 등롣되면 [등록하기] 버튼이 활성화 되며, 클릭하면 댓글 등록과 함께 이벤트에 응모 할 수 있습니다.

7. 쿠폰 이벤트

7.1 쿠폰 이벤트 상세 조회하기

쿠폰 이벤트의 기본 정보를 조회할 수 있습니다.

7.2 쿠폰 다운받기

해당 이벤트에 등록된 쿠폰의 [다운받기] 버튼을 클릭하면, 쿠폰을 다운로드 할 수 있습니다.

8. 룰렛 이벤트

8.1 이벤트 상세 조회

룰렛 이벤트의 기본 정보를 조회할 수 있습니다.

8.2 이벤트 응모하기

룰렛 이벤트는 [START] 버튼을 클릭하여 참여할 수 있고, 당첨 결과에 따른 경품을 즉시 수령할 수 있습니다.

9. 구매자 추첨 이벤트

9.1 이벤트 상세 조회

이벤트 기본 정보와 회원 주문 정보 목록을 조회하여 지정된 목표 금액 달성여부를 조회할 수 있습니다. 화면은 구매사은이벤트와 동일합니다.

9.2 이벤트 응모하기

해당 이벤트에 등록된 [응모하기] 버튼을 클릭하면 응모가 완료됩니다.


댓글 이벤트 -댓글 수정/삭제

로그인 사용자가 댓글 이벤트 참여 및 댓글 조회하는 기능을 제공하고 있습니다.

1. 댓글 더보기


설문 이벤트 - 리스트 및 상세 페이지

설문 이벤트는 고객리뷰를 통해 접근할 수 있습니다.

1. 설문 이벤트 리스트

등록 된 설문 이벤트의 상태, 제목, 기간 정보를 조회하여 리스트 생성할 수 있습니다.

2. 설문 이벤트 상세페이지

해당 설문 이벤트의 상세 내용을 조회하여 항목을 선택하여 클릭 할 수 있습니다.

3.설문 이벤트 응모하기

설문 선택이 완료되면 응모하기 버튼이 활성화 됩니다.

[응모하기] 버튼을 클릭하면 응모가 완료됩니다.

설문 이벤트 응모하기 API는 이벤트 문서의 3. 이벤트 응모하기를 참고해주세요.


이벤트 참여 내역 페이지

고객이 참여한 이벤트 내역 정보를 확인할 수 있습니다.

1. 이벤트 참여 내역

고객이 이벤트 참여 내역 목록으로 조회 할 수 있습니다.