콘텐츠로 건너뛰기

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

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

요청

주문 및 주문에 대한 지불 토큰을 생성합니다. 주문은 요청 본문에 전달된 아이템에 기반하여 생성됩니다.

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

테스트 목적으로 https://sandbox-secure.xsolla.com/paystation4/?token={token} URL을 사용합니다.

참고

user.country.value 매개 변수는 주문에 대한 통화를 선택하는 데 사용됩니다. 사용자의 국가를 알 수 없는 경우, 대신 X-User-Ip 헤더의 사용자 IP를 제공할 수 있습니다.
이 메서드가 적절히 작동하기 위해서는 두 가지 옵션 중 하나가 필요합니다.
선택한 통화는 페이 스테이션의 결제 방식에 사용됩니다.
보안
basicAuth
경로
project_idinteger필수

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

예제: 44056
본문application/json
custom_parametersobject or null(Cart-Payment_custom_parameters)[ 1 .. 200 ] properties

사용자 지정 매개 변수는 키-값 쌍의 유효한 JSON 집합으로 표시됩니다.
이 필드를 통해 추가 매개 변수를 전달하여 부정 결제 방지 필터를 구성할 수 있습니다. 페이 스테이션 설명서를 참조해주세요.

예제: {"custom_parameters":{"bool_param":true,"int_param":100,"null_param":null,"string_param":"example"}}
promo_codestring(Promotions_coupon_code)[ 1 .. 128 ] characters^[a-zA-Z0-9]+$

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

기본값 "WINTER2021"
예제: "WINTER2021"
purchaseobject(Cart_admin_payment)필수
purchase.​itemsArray of objectsnon-empty필수
purchase.​items[].​quantitynumber>= 1필수

아이템의 수량입니다.

예제: 2
purchase.​items[].​skustringnon-empty필수

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

예제: "t-shirt"
sandboxboolean(Cart-Payment_settings_sandbox)

결제 프로세스를 테스트하기 위해 true 값으로 설정합니다. 이 경우 테스트 결제 UI에 액세스하기 위해 https://sandbox-secure.Xsolla.com을 사용합니다.

기본값 false
settingsobject

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

userobject(Cart-Payment_admin-user-request-body)필수
user.​ageinteger

사용자 나이.

user.​countryobject
user.​emailobject
user.​idobject필수
user.​id.​valuestring[ 1 .. 255 ] characters

사용자 ID입니다. 테스트 목적으로 어떤 값이나 전달할 수 있습니다. 실제 결제를 수락하려면 시스템의 사용자 ID 값을 사용해야 합니다. 이 ID는 유효성 검사 웹훅에서 전달됩니다.

user.​is_legalboolean

사용자가 법인인지 여부를 나타냅니다.

user.​legalobject

법인 세부 정보가 있는 개체입니다. user.is_legaltrue인 경우 개체와 이에 해당하는 모든 매개 변수는 필수입니다.

user.​nameobject
user.​phoneobject
user.​steam_idobject
user.​tracking_idobject
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ko/api/shop-builder/v3/project/44056/admin/payment/token \
  -H 'Content-Type: application/json' \
  -d '{
    "purchase": {
      "items": [
        {
          "quantity": 2,
          "sku": "com.xsolla.cup01"
        },
        {
          "quantity": 1,
          "sku": "com.xsolla.t-shirt01"
        },
        {
          "quantity": 1,
          "sku": "com.xsolla.cup01"
        },
        {
          "quantity": 1,
          "sku": "com.xsolla.hat01"
        }
      ]
    },
    "settings": {
      "currency": "USD",
      "external_id": "AABBCCDD01",
      "language": "de",
      "payment_method": 1380,
      "return_url": "https://developers.xsolla.com/ko/",
      "ui": {
        "theme": "63295aab2e47fab76f7708e3"
      }
    },
    "user": {
      "country": {
        "allow_modify": false,
        "value": "US"
      },
      "email": {
        "value": "user@xsolla.com"
      },
      "id": {
        "value": "user-id"
      },
      "name": {
        "value": "user-name"
      }
    }
  }'

응답

결제 토큰 및 주문을 생성했습니다.

본문application/json
order_idinteger

주문 ID입니다.

예제: 1
tokenstring

결제 토큰입니다.

응답
application/json
{ "order_id": 12345, "token": "huooAqbXBSJxB8Q4dYBqJp4ybiInqsPb" }
작업
작업
작업
작업
작업

카탈로그

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

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

쿠폰

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

작업

프로모션 코드

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

작업

고유 카탈로그 혜택

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

작업

할인

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

작업

보너스

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

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