콘텐츠로 건너뛰기

개요

카탈로그 API를 통해 엑솔라 측 인게임 아이템에 대한 카탈로그를 구성하고 스토어 사용자에게 카탈로그를 표시합니다.

API를 통해 다음 카탈로그 엔터티를 관리할 수 있습니다:

  • 가상 아이템 - 무기, 스킨, 부스터와 같은 인게임 아이템.
  • 인게임 재화 - 가상 아이템을 구매하는 데 사용되는 가상 화폐.
  • 인게임 재화 패키지 - 사전 정의된 인게임 재화 번들.
  • 번들 - 가상 아이템, 통화 또는 단일 SKU로 판매되는 게임 키의 결합 패키지.
  • 게임 키 - Steam이나 기타 DRM 제공업체와 같은 플랫폼을 통해 배포되는 게임 및 DLC의 키.
  • 그룹 - 카탈로그 내 아이템을 정리하고 분류하기 위한 로직 그룹.

API 호출

API는 다음 그룹으로 구분됩니다:

  • Admin - 카탈로그 아이템 및 그룹 생성, 업데이트, 삭제 및 구성을 위한 호출. 상품 또는 프로젝트 자격 증명으로 기본 액세스 인증을 통해 인증됩니다. 스토어프런트 용도로 사용되지 않습니다.
  • Catalog - 아이템 검색 및 최종 사용자를 위한 맞춤형 스토어프론트 구축을 위한 호출. 높은 부하 시나리오를 처리하도록 설계되었습니다. 사용자별 한도나 진행 중인 프로모션과 같은 개인화된 데이터를 반환하기 위해 선택적 사용자 JWT 인증을 지원합니다.
OpenAPI 설명 다운로드
언어
서버
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/ko/api/catalog/
작업
작업
작업
작업
작업
작업
작업
작업
작업
작업
작업

특정 장바구니의 모든 아이템으로 주문 생성Client-side

요청

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

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

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

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

참고

이 방식은 IP를 사용하여 사용자의 국가를 확인하고 주문에 사용할 통화를 선택하므로 서버 측이 아닌 클라이언트 측에서만 이 방식을 사용해야 합니다. 서버 측에서 이 방식을 사용하면 통화가 잘못 결정되어 페이 스테이션의 결제 방식에 영향을 줄 수 있습니다.
보안
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://store.xsolla.com/api/v2/project/44056/payment/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입니다.

tokenstring

결제 토큰입니다.

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

특정 아이템을 사용하는 주문 생성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://store.xsolla.com/api/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" }
작업
작업
작업
작업
작업
작업
작업
작업

카탈로그

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

작업
작업
작업