콘텐츠로 건너뛰기

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를 사용하여 보너스 프로모션을 관리할 수 있습니다.

작업
작업
작업
작업
작업

지정된 사용자가 사용할 수 있는 아이템의 수량을 설정합니다Server-sideAdmin

요청

지정된 사용자가 제한 설정이 증가되거나 감소된 후 적용된 제한 설정 내에서 구매할 수 있는 아이템 개수를 설정합니다.

사용자 제한 API를 사용하면 제한된 수량만 아이템을 판매할 수 있습니다. 구매 한도를 구성하려면 원하는 아이템 유형 모듈의 관리 섹션으로 이동합니다.

보안
basicAuth
경로
project_idinteger필수

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

예제: 44056
item_skustring필수

아이템 SKU입니다.

예제: booster_mega_1
본문application/json
availableinteger(User-limit_available_flexible)>= 0필수

적용된 제한 설정 내에서 사용자가 사용할 수 있는 남은 아이템 또는 프로모션 사용 수량입니다.

userobject(User-limit_user)필수
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$필수

사용자 외부 ID입니다.

curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ko/api/shop-builder/v2/project/44056/admin/user/limit/item/sku/booster_mega_1 \
  -H 'Content-Type: application/json' \
  -d '{
    "available": 0,
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    }
  }'

응답

사용자 한 명에 대한 구매 제한 설정을 성공적으로 수신했습니다.

본문application/json
per_userobject
응답
application/json
{ "per_user": { "available": 9, "total": 10 } }

요청

사용자가 아이템을 다시 구입할 수 있도록 아이템의 구매 한도를 새로고침합니다. user 매개변수가 null인 경우 이 호출은 모든 사용자에 대해 이 제한을 새로고침합니다.

사용자 제한 API를 사용하면 제한된 수량만 아이템을 판매할 수 있습니다. 구매 한도를 구성하려면 원하는 아이템 유형 모듈의 관리 섹션으로 이동합니다.

보안
basicAuth
경로
project_idinteger필수

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

예제: 44056
item_skustring필수

아이템 SKU입니다.

예제: booster_mega_1
본문application/json
userobject or null(User-limit_user_flexible)필수
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$

사용자 외부 ID입니다.

curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ko/api/shop-builder/v2/project/44056/admin/user/limit/item/sku/booster_mega_1/all \
  -H 'Content-Type: application/json' \
  -d '{
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    }
  }'

응답

제한 설정을 성공적으로 새로고침했습니다.

응답
콘텐츠 없음

지정된 사용자의 모든 프로모션 제한 설정 새로고침Server-sideAdmin

요청

지정된 사용자에 대한 모든 프로모션의 모든 제한 설정을 새로고침하여 해당 프로모션을 다시 사용할 수 있도록 합니다.

사용자 제한 API를 사용하면 사용자가 프로모션을 사용할 수 있는 횟수를 제한할 수 있습니다. 사용자 제한 자체를 구성하려면 원하는 프로모션 유형의 관리 섹션으로 이동합니다.

보안
basicAuth
경로
project_idinteger필수

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

예제: 44056
본문application/json
userobject(User-limit_user)필수
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$필수

사용자 외부 ID입니다.

curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ko/api/shop-builder/v2/project/44056/admin/user/limit/promotion/all \
  -H 'Content-Type: application/json' \
  -d '{
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    }
  }'

응답

프로모션 제한 설정을 성공적으로 새로고침했습니다.

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