콘텐츠로 건너뛰기

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

요청

관리 대상 프로젝트에서 가치 포인트가 있는 모든 아이템의 목록을 가져옵니다.

보안
basicAuth
경로
project_idinteger필수

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

예제: 44056
value_point_skustring필수

가치 포인트 SKU입니다.

예제: value_point_3
curl -i -X GET \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ko/api/shop-builder/v2/project/44056/admin/items/value_point_3/value_points/rewards

응답

가치 포인트 보상이 있는 아이템 목록을 성공적으로 수신했습니다.

본문application/json
itemsArray of objects(admin-item-value-point-reward)
응답
application/json
{ "items": [ {}, {} ] }

아이템에 대한 가치 포인트를 부분적으로 업데이트Server-sideAdmin

요청

아이템의 SKU에 의해 하나 이상의 아이템에 대한 가치 포인트 수를 부분적으로 업데이트합니다. 사용자는 지정된 아이템을 구매한 후 이러한 가치 포인트를 받게 됩니다.

가치 포인트 업데이트의 원칙:

  • 아이템에 아직 가치 포인트가 없는 경우 amount 필드에 0이 아닌 값을 보내면 가치 포인트가 생성됩니다.
  • 아이템에 이미 가치 포인트가 있는 경우 amount 필드에 0이 아닌 값을 보내면 가치 포인트가 업데이트됩니다.
  • amount를 0으로 설정하면 해당 아이템에 대한 기존 가치 포인트가 삭제됩니다.

PUT 메서드(아이템에 대한 가치 포인트 설정)와 달리 이 PATCH 메서드는 프로젝트의 아이템에 대한 모든 기존 가치 포인트를 덮어쓰지 않고 지정된 아이템만 업데이트합니다.

단일 요청으로 최대 100개의 아이템을 업데이트할 수 있습니다. 중복 아이템 SKU는 동일한 요청에 포함될 수 없습니다.

보안
basicAuth
경로
project_idinteger필수

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

예제: 44056
value_point_skustring필수

가치 포인트 SKU입니다.

예제: value_point_3
본문application/jsonArray [
amountinteger>= 0필수

가치 포인트의 금액입니다.

skustring(sku)[ 1 .. 255 ] characters^[a-zA-Z0-9_\-–.]*$필수

고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.

예제: "booster_mega_1"
]
curl -i -X PATCH \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ko/api/shop-builder/v2/project/44056/admin/items/value_point_3/value_points/rewards \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "amount": 100,
      "sku": "booster_1"
    },
    {
      "amount": 0,
      "sku": "booster_mega"
    }
  ]'

응답

아이템에 대한 가치 포인트 보상이 성공적으로 업데이트되었습니다.

본문
응답
콘텐츠 없음

아이템에 대한 가치 포인트 설정Server-sideAdmin

요청

하나 또는 여러 아이템에 SKU별로 가치 포인트를 할당합니다. 사용자가 이러한 아이템을 구매하면 가치 포인트를 받습니다.

이 PUT 요청은 프로젝트에서 이전에 설정한 모든 아이템의 가치 포인트를 덮어씁니다.

실수로 가치 포인트가 삭제되는 것을 방지하려면 각 PUT 요청에 모든 아이템과 해당 가치 포인트를 포함해야 합니다.

다른 아이템의 가치 포인트는 그대로 유지하면서 특정 아이템의 가치 포인트만 업데이트하려면 GET 요청을 사용하여 현재 가치 포인트 세트를 검색하고 원하는 아이템의 가치 포인트를 수정한 다음 수정된 가치 포인트 세트를 특정 아이템의 업데이트된 가치 포인트와 함께 다시 보내야 합니다.

보안
basicAuth
경로
project_idinteger필수

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

예제: 44056
value_point_skustring필수

가치 포인트 SKU입니다.

예제: value_point_3
본문application/jsonArray [
amountinteger필수

가치 포인트의 금액입니다.

skustring(sku)[ 1 .. 255 ] characters^[a-zA-Z0-9_\-–.]*$필수

고유 아이템 ID입니다. SKU는 소문자 및 대문자 라틴 영숫자, 마침표, 대시 및 밑줄만 포함할 수 있습니다.

예제: "booster_mega_1"
]
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ko/api/shop-builder/v2/project/44056/admin/items/value_point_3/value_points/rewards \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "amount": 100,
      "sku": "com.xsolla.booster_1"
    },
    {
      "amount": 200,
      "sku": "com.xsolla.booster_mega"
    }
  ]'

응답

아이템에 대한 가치 포인트 보상이 성공적으로 업데이트되었습니다.

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