콘텐츠로 건너뛰기

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 특성으로 특성을 전달할 수 있습니다.

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

특정 아이템을 사용하는 주문 생성Client-side

요청

클라이언트-서버 연동에 사용됩니다. 지정된 아이템으로 주문을 생성하고 이에 대한 결제 토큰을 생성합니다. 생성된 주문은 new 주문 상태를 가져옵니다.

클라이언트 IP는 사용자의 국가를 확인하는 데 사용되며, 해당 통화 및 주문에 사용 사용할 수 있는 결제 방식을 적용하는 데 사용됩니다.

결제 UI를 새 창에서 열려면 https://secure.xsolla.com/paystation4/?token={token} 링크를 사용합니다. 여기서 {token}은 수신한 토큰입니다.

테스트를 진행할 때에는 https://sandbox-secure.xsolla.com/paystation4/?token={token} URL을 사용합니다.

참고

이 방식은 IP를 사용하여 사용자의 국가를 확인하고 주문에 사용할 통화를 선택하므로 서버 측이 아닌 클라이언트 측에서만 이 방식을 사용해야 합니다. 서버 측에서 이 방식을 사용하면 통화가 잘못 결정되어 페이 스테이션의 결제 방식에 영향을 줄 수 있습니다.
보안
XsollaLoginUserJWT
경로
project_idinteger필수

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

예제: 44056
item_skustring필수

아이템 SKU입니다.

예제: booster_mega_1
본문application/json
currencystring

주문 가격 통화입니다. ISO 4217에 따른 3글자 통화 코드입니다. 엑솔라에서 지원하는 통화에 대한 자세한 정보는 설명서를 확인하십시오.

custom_parametersobject[ 1 .. 200 ] properties

프로젝트별 매개 변수입니다.

localestring

응답 언어입니다.

promo_codestring

결제 시 프로모션 코드 프로모션용 코드를 사용합니다.

quantityinteger>= 1

아이템 수량입니다.

기본값 1
sandboxboolean

샌드박스 모드로 주문을 생성합니다. 이 옵션은 회사 사용자 목록에서 지정한 사용자에게 사용할 수 있습니다.

기본값 false
settingsobject

사용자의 결제 프로세스와 결제 UI를 구성하는 설정입니다.

curl -i -X POST \
  https://xsolla.redocly.app/_mock/ko/api/shop-builder/v2/project/44056/payment/item/booster_mega_1 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "custom_parameters": {
      "character_id": "ingameUsername"
    },
    "promo_code": "discount_code",
    "quantity": 5,
    "sandbox": true,
    "settings": {
      "ui": {
        "desktop": {
          "header": {
            "close_button": false,
            "is_visible": true,
            "type": "normal",
            "visible_logo": true,
            "visible_name": true,
            "visible_purchase": true
          }
        },
        "theme": "63295a9a2e47fab76f7708e1"
      }
    }
  }'

응답

주문을 성공적으로 생성했습니다.

본문application/json
order_idinteger

주문 ID입니다.

tokenstring

결제 토큰입니다.

응답
application/json
{ "order_id": 641, "token": "f4puMEFFDZcx9nv5HoNHIkPe9qghvBQo" }

유료 혜택 체인 단계 주문 생성Client-side

요청

지정된 유료 혜택 체인 단계와 연결된 아이템의 주문을 생성합니다. 생성된 주문은 new 주문 상태를 가져옵니다.

결제 UI를 새 창에서 열려면 https://secure.xsolla.com/paystation4/?token={token} 링크를 사용합니다. 여기서 {token}은(는) 수신된 토큰입니다.

테스트를 진행할 경우 https://sandbox-secure.xsolla.com/paystation4/?token={token}을 사용합니다.

알림

이 메서드는 클라이언트 측에서 사용해야 합니다. 사용자의 IP 주소는 통화 및 사용 가능한 결제 방법에 영향을 미치는 국가를 결정하는 데 사용됩니다. 서버 측에서 이 메서드를 사용하면 통화가 잘못 감지되어 페이 스테이션의 결제 방식에 영향을 줄 수 있습니다.

알림

유료 혜택 체인 단계에서만 이 호출을 사용하세요. 무료 단계의 경우 무료 혜택 체인 단계 신청 호출을 대신 사용해 주세요.
보안
XsollaLoginUserJWT
경로
project_idinteger필수

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

예제: 44056
offer_chain_idinteger필수

혜택 체인 ID입니다.

예제: 101
step_numberinteger필수

혜택 체인 단계 번호입니다.

예제: 1
curl -i -X POST \
  https://xsolla.redocly.app/_mock/ko/api/shop-builder/v2/project/44056/user/offer_chain/101/step/number/1/order \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

응답

주문을 성공적으로 생성했습니다.

본문application/json
order_idinteger

주문 ID입니다.

tokenstring

결제 토큰입니다.

응답
application/json
{ "order_id": 641, "token": "f4puMEFFDZcx9nv5HoNHIkPe9qghvBQo" }
작업
작업
작업
작업
작업
작업

카탈로그

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

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

쿠폰

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

작업

프로모션 코드

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

작업

고유 카탈로그 혜택

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

작업

할인

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

작업

보너스

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

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