콘텐츠로 건너뛰기
/
쿠폰 코드 생성하기

LiveOps API (2.0.0)

개요

LiveOps는 프로모션 및 맞춤형 혜택을 통해 진행 중인 플레이어 참여를 독려하는 툴킷입니다.

API를 사용하여 다음 기능을 관리할 수 있습니다:

  • 프로모션 - 쿠폰, 프로모션 코드, 할인 및 보너스 캠페인을 생성하고 관리합니다.
  • 개인화 - 특정 승인된 사용자에 한해 아이템 카탈로그를 표시하고 프로모션을 적용할 수 있는 조건을 지정합니다.
  • 프로모션 한도 - 사용자당 프로모션 사용 횟수에 대한 한도를 설정하고, 해당 한도에 대한 정기적인 초기화 일정을 구성합니다.
  • 리워드 체인 및 가치 포인트 - 가치 포인트 적립과 연계된 보상 진행 단계 설정.
  • 일일 체인 - 매일 반복되는 보상을 설정하여 정기적인 로그인을 유도합니다.
  • 혜택 체인 - 단계별 가격 책정 및 무료 보상 옵션을 통해 순차적 구매 혜택을 구축합니다.
  • 업셀링 - 추가적인 가치가 있는 아이템을 구매할 수 있도록 사용자에게 제공되는 판매 방법.

API 호출

API는 다음 그룹으로 구분됩니다:

  • Admin - 캠페인 및 체인 구성의 생성, 업데이트, 활성화 및 삭제를 수행합니다. 상품 또는 프로젝트 자격 증명으로 기본 액세스 인증을 통해 인증됩니다.
  • Client - 인증된 최종 사용자를 대신하여 이용 가능한 프로모션을 검색하고, 활성 체인을 확인하며, 코드를 사용하고, 보상을 요청하는 기능을 제공합니다. 사용자 JWT를 통해 인증됩니다.
OpenAPI 설명 다운로드
index.json
index.yaml
언어
서버
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/ko/api/liveops/

일반

작업

쿠폰

이 API를 사용하여 쿠폰을 관리할 수 있습니다.

작업

쿠폰 코드 생성하기Server-sideAdmin

요청

쿠폰 코드를 생성합니다.

보안
basicAuth
경로
project_idinteger필수

프로젝트 ID입니다. 이 매개 변수는 관리자 페이지의 프로젝트 이름 옆에서 확인할 수 있습니다.

예제: 44056
external_idinteger필수

프로모션 외부 ID입니다. 프로젝트 내부의 고유 프로모션 식별자입니다.

예제: coupon_44056_1
본문application/json
coupon_codestring(Promotions_coupon_code)[ 1 .. 128 ] characters^[a-zA-Z0-9]+$

고유한 대/소문자 구분 코드입니다. 문자와 숫자를 포함합니다.

기본값 "WINTER2021"
예제: "WINTER2021"
curl -i -X POST \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/coupon/coupon_44056_1/code \
  -H 'Content-Type: application/json' \
  -d '{
    "coupon_code": "WINTER2021"
  }'

응답

코드를 성공적으로 생성했습니다.

본문application/json
codestring(Promotions_coupon_code)[ 1 .. 128 ] characters^[a-zA-Z0-9]+$

고유한 대/소문자 구분 코드입니다. 문자와 숫자를 포함합니다.

기본값 "WINTER2021"
예제: "WINTER2021"
응답
application/json
{
  "code": "WINTER2021"
}

쿠폰 코드 생성하기Server-sideAdmin

요청

쿠폰 코드를 생성합니다.

보안
basicAuth
경로
project_idinteger필수

프로젝트 ID입니다. 이 매개 변수는 관리자 페이지의 프로젝트 이름 옆에서 확인할 수 있습니다.

예제: 44056
external_idinteger필수

프로모션 외부 ID입니다. 프로젝트 내부의 고유 프로모션 식별자입니다.

예제: coupon_44056_1
본문application/json
countinteger(Promotions_coupon-generate-count)[ 1 .. 100000 ]필수
예제: 10
curl -i -X PUT \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/coupon/coupon_44056_1/code/generate \
  -H 'Content-Type: application/json' \
  -d '{
    "count": 10
  }'

응답

코드를 성공적으로 생성했습니다.

본문application/json
countinteger(Promotions_coupon-generate-count)[ 1 .. 100000 ]
예제: 10
응답
application/json
{
  "count": 10
}

쿠폰 프로모션 비활성화Server-sideAdmin

요청

쿠폰 프로모션을 비활성화합니다. 생성된 쿠폰 프로모션은 기본적으로 비활성화되어 있습니다. 프로모션을 활성화할 때까지 사용할 수 없습니다. 이 엔드포인트를 사용하여 쿠폰 프로모션을 비활성화합니다.

보안
basicAuth
경로
project_idinteger필수

프로젝트 ID입니다. 이 매개 변수는 관리자 페이지의 프로젝트 이름 옆에서 확인할 수 있습니다.

예제: 44056
external_idinteger필수

프로모션 외부 ID입니다. 프로젝트 내부의 고유 프로모션 식별자입니다.

예제: coupon_44056_1
curl -i -X PUT \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/coupon/coupon_44056_1/deactivate

응답

쿠폰을 성공적으로 비활성화했습니다.

응답
콘텐츠 없음

프로모션 코드

이 API를 사용하여 프로모션 코드를 관리할 수 있습니다.

작업

고유 카탈로그 혜택

이 API를 사용하여 고유 카탈로그 혜택을 관리할 수 있습니다.

작업

할인

이 API를 사용하여 할인 프로모션을 관리할 수 있습니다.

작업

보너스

이 API를 사용하여 보너스 프로모션을 관리할 수 있습니다.

작업

개인 맞춤형 카탈로그

이 API를 사용하여 사용자 특성에 대한 규칙을 지정할 수 있습니다. 사용자가 구체적인 규칙에 대한 모든 조건을 충족하면 개인 맞춤형 아이템이 표시됩니다.

개인 맞춤형 프로모션에 대한 내용은 프로모션 섹션을 참조하십시오.

구매 전에 특성을 전달하려면 엑솔라 로그인 API를 사용하거나 페이 스테이션 API를 사용하여 토큰을 생성하는 동안 user.attributes 특성으로 특성을 전달할 수 있습니다.

작업

관리

작업

관리자

작업

클라이언트

작업

클랜 클라이언트

작업

관리자

작업

클라이언트

작업

관리자

작업

클라이언트

작업

관리자

작업

클라이언트

작업