콘텐츠로 건너뛰기

Overview

  • Version: 2.0.0
  • Servers: https://store.xsolla.com/api
  • Contact Us by Email
  • Contact URL: https://xsolla.com/
  • Required TLS version: 1.2

Shop Builder API provides a third-party solution for implementing the server side for your store interface. Use the endpoints to manage in-game items, in-game currencies, cart, player inventory, promotions, game library, etc.

OpenAPI 설명 다운로드
언어
서버
Mock server
https://xsolla.redocly.app/_mock/ko/api/shop-builder/
https://store.xsolla.com/api/
작업

개인 맞춤형 카탈로그

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

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

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

작업
작업
작업
작업
작업
작업
작업
작업
작업
작업
작업
작업

카탈로그

이 API를 사용하면 모든 종류의 판매할 수 있는 아이템 또는 특정 아이템을 가져올 수 있습니다.

작업
작업
작업
작업
작업
작업

쿠폰

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

작업

프로모션 코드

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

작업

고유 카탈로그 혜택

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

작업

할인

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

작업

보너스

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

작업

요청

보너스 프로모션을 가져옵니다.

프로모션은 사용자가 구매한 구매 항목에 무료 보너스 아이템을 추가합니다. 프로모션은 프로젝트 내의 모든 구매 또는 특정 아이템을 포함하는 구매에 적용할 수 있습니다.

보안
basicAuth
경로
project_idinteger필수

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

예제: 44056
promotion_idinteger필수

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

예제: 111425
curl -i -X GET \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ko/api/shop-builder/v3/project/44056/admin/promotion/111425/bonus

응답

보너스 프로모션을 성공적으로 수신했습니다.

본문application/json
attribute_conditionsArray of type = string (object) or type = number (object) or type = date (object)(promotion_user-attribute_conditions_model-get)[ 1 .. 100 ] items

사용자 특성 검증 조건. 사용자 특성이 지정된 모든 조건과 일치하는지 여부에 따라 프로모션의 가용성을 결정합니다.

bonusArray of objects or null
conditionArray of objects or null

프로모션을 적용하기 위해 구매 항목에 포함되어야 하는 아이템 세트입니다. 이 매개 변수가 null이면 프로젝트 내의 모든 구매 항목에 프로모션이 적용됩니다.

excluded_promotionsArray of integers(excluded_promotions)

이 프로모션을 적용할 때 제외할 프로모션 ID 목록입니다.
Example: [12, 789]

예제: [12,789]
idinteger

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

is_enabledboolean
기본값 true
limitsobject(Promotions_promotion_limits_response)

프로모션 제한입니다.

nameobject

프로모션의 이름입니다. 키가 "^[a-z]{2}-[A-Z]{2}$" 형식의 로케일인 키/값 쌍을 포함해야 하며 값은 문자열입니다.

예제: {"de-DE":"Sommersaison Bonus","en-US":"Summer season bonus"}
price_conditionsArray of objects or null(price_conditions_bonus)

프로모션을 적용하기 위한 가격 범위를 설정하는 조건을 가진 개체 배열입니다.
프로모션은 가격이 배열의 모든 조건을 충족하는 아이템에만 적용됩니다. 이 배열을 전달하는 경우 조건 개체의 값이 null로 설정됩니다.

promotion_periodsArray of objects(promotion_periods)

프로모션의 유효 기간. 기간이 여러 개 지정된 경우 date_fromdate_until가 모두 필요합니다.

응답
application/json
{ "bonus": [ {}, {}, {} ], "condition": [ {}, {} ], "excluded_promotions": [ 23, 45 ], "id": 1, "is_enabled": true, "limits": { "per_item": null, "per_user": {}, "recurrent_schedule": {} }, "name": { "de-DE": "Neujahrsbonus", "en-US": "New Year Bonus" }, "price_conditions": [ {}, {} ], "promotion_periods": [ {} ] }

요청

프로모션을 업데이트합니다.

참고

이전 데이터를 새 데이터로 교체합니다. 일부 프로모션만 업데이트하려면 요청 시 필요한 모든 데이터도 전송해야 합니다.

프로모션은 사용자가 구매한 구매 항목에 무료 보너스 아이템을 추가합니다. 프로모션은 프로젝트 내의 모든 구매 또는 특정 아이템을 포함하는 구매에 적용할 수 있습니다.

보안
basicAuth
경로
project_idinteger필수

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

예제: 44056
promotion_idinteger필수

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

예제: 111425
본문application/json
attribute_conditionsArray of type = string (object) or type = number (object) or type = date (object)(promotion_user-attribute_conditions_model-post)[ 1 .. 100 ] items

사용자 특성 검증 조건. 사용자 특성이 지정된 모든 조건과 일치하는지 여부에 따라 프로모션의 가용성을 결정합니다.

bonusArray of objects or null필수
bonus[].​quantitynumber

아이템 수량입니다.

기본값 1
bonus[].​skustring

아이템 SKU입니다.

기본값 "elven_shield"
conditionArray of objects or null필수

프로모션을 적용하기 위해 구매 항목에 포함되어야 하는 아이템 세트입니다. 이 매개 변수가 null이면 프로젝트 내의 모든 구매 항목에 프로모션이 적용됩니다.

condition[].​skustring

아이템 SKU입니다.

기본값 "elven_sword"
excluded_promotionsArray of integers(excluded_promotions)

이 프로모션을 적용할 때 제외할 프로모션 ID 목록입니다.
Example: [12, 789]

예제: [12,789]
idinteger

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

is_enabledboolean(Promotions_is_enabled)

프로모션 활성화 여부.

예제: true
limitsobject(Promotions_promotion_limits)

프로모션 제한입니다.

nameobject필수

프로모션의 이름입니다. 키가 "^[a-z]{2}-[A-Z]{2}$" 형식의 로케일인 키/값 쌍을 포함해야 하며 값은 문자열입니다.

예제: {"de-DE":"Sommersaison Bonus","en-US":"Summer season bonus"}
name.​property name*string추가 속성
price_conditionsArray of objects or null(price_conditions_bonus)

프로모션을 적용하기 위한 가격 범위를 설정하는 조건을 가진 개체 배열입니다.
프로모션은 가격이 배열의 모든 조건을 충족하는 아이템에만 적용됩니다. 이 배열을 전달하는 경우 조건 개체의 값이 null로 설정됩니다.

promotion_periodsArray of objects(promotion_periods)

프로모션의 유효 기간. 기간이 여러 개 지정된 경우 date_fromdate_until가 모두 필요합니다.

curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ko/api/shop-builder/v3/project/44056/admin/promotion/111425/bonus \
  -H 'Content-Type: application/json' \
  -d '{
    "attribute_conditions": [
      {
        "attribute": "account_status",
        "can_be_missing": false,
        "operator": "eq",
        "type": "string",
        "value": "golden"
      }
    ],
    "bonus": [
      {
        "quantity": 50000,
        "sku": "com.xsolla.mp_credits"
      }
    ],
    "condition": [
      {
        "sku": "com.xsolla.year_1_season_pass"
      }
    ],
    "name": {
      "de-DE": "Neujahrsbonus",
      "en-US": "New Year Bonus"
    },
    "promotion_periods": [
      {
        "date_from": "2020-04-15T18:16:00+05:00",
        "date_until": "2020-04-25T18:16:00+05:00"
      }
    ]
  }'

응답

프로모션을 성공적으로 업데이트했습니다.

응답
콘텐츠 없음
작업
작업
작업
작업
작업
작업
작업
작업
작업
작업
작업
작업
작업
작업