콘텐츠로 건너뛰기

Catalog API (2.0.0)

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

Catalog API는 인게임 스토어 카탈로그를 관리하고 구매를 처리하기 위한 엔드포인트를 제공합니다. 엔드포인트를 사용하여 가상 아이템, 인게임 재화, 게임 키, 번들, 장바구니 및 결제 플로우, 아이템 속성을 구성하고 외부 소스에서 아이템을 가져올 수 있습니다.

OpenAPI 설명 다운로드
index.json
index.yaml
언어
서버
Mock server
https://xsolla.redocly.app/_mock/ko/api/catalog/
https://store.xsolla.com/api/

관리자

작업

카탈로그

작업

가상 결제

작업

카탈로그

작업

권한

작업

관리자

작업

관리자

작업

카탈로그

작업

장바구니(클라이언트 측)

작업

장바구니(서버 측)

작업

결제(클라이언트 측)

작업

결제(서버 측)

작업

주문

작업

무료 아이템

작업

무료 장바구니로 주문 생성하기Client-side

요청

무료 장바구니의 모든 아이템으로 주문을 생성합니다. 생성된 주문은 done 주문 상태를 가져옵니다.

보안
AuthForCart
경로
project_idinteger필수

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

예제: 44056
본문application/json
currencystring

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

custom_parametersobject[ 1 .. 200 ] properties

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

localestring

응답 언어입니다.

sandboxboolean

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

기본값 false
settingsobject

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

curl -i -X POST \
  https://xsolla.redocly.app/_mock/ko/api/catalog/v2/project/44056/free/cart \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "custom_parameters": {
      "character_id": "ingameUsername"
    },
    "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입니다.

응답
application/json
{
  "order_id": 641
}

특정 무료 장바구니로 주문 생성하기Client-side

요청

특정 무료 장바구니의 모든 아이템으로 주문을 생성합니다. 생성된 주문은 done 주문 상태를 가져옵니다.

보안
AuthForCart
경로
project_idinteger필수

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

예제: 44056
cart_idstring필수

장바구니 ID입니다.

예제: custom_id
본문application/json
currencystring

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

custom_parametersobject[ 1 .. 200 ] properties

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

localestring

응답 언어입니다.

sandboxboolean

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

기본값 false
settingsobject

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

curl -i -X POST \
  https://xsolla.redocly.app/_mock/ko/api/catalog/v2/project/44056/free/cart/custom_id \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "custom_parameters": {
      "character_id": "ingameUsername"
    },
    "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입니다.

응답
application/json
{
  "order_id": 641
}

지정한 무료 아이템으로 주문 생성하기Client-side

요청

지정한 무료 아이템으로 주문을 생성합니다. 생성된 주문은 done 주문 상태를 가져옵니다.

보안
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/catalog/v2/project/44056/free/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입니다.

응답
application/json
{
  "order_id": 641
}

관리

작업

관리자

작업

웹훅

작업

선주문

작업

판매자

작업

카탈로그

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

작업

공통 지역

작업

관리자

작업