콘텐츠로 건너뛰기

Shop Builder 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

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 설명 다운로드
index.json
index.yaml
언어
서버
Mock server
https://xsolla.redocly.app/_mock/ko/api/shop-builder/
https://store.xsolla.com/api/

관리자

작업

개인 맞춤형 카탈로그

이 API를 사용하여 사용자 특성에 대한 규칙을 지정할 수 있습니다. 사용자가 구체적인 규칙에 대한 모든 조건을 충족하면 개인 맞춤형 아이템이 표시됩니다.

개인 맞춤형 프로모션에 대한 내용은 프로모션 섹션을 참조하십시오.

구매 전에 특성을 전달하려면 엑솔라 로그인 API를 사용하거나 페이 스테이션 API를 사용하여 토큰을 생성하는 동안 user.attributes 특성으로 특성을 전달할 수 있습니다.

작업

관리자

작업

카탈로그

작업

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

작업

장바구니(서버 측)

작업

결제(클라이언트 측)

작업

결제(서버 측)

작업

주문

작업

무료 아이템

작업

웹훅

작업

선주문

작업

판매자

작업

카탈로그

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

작업

공통 지역

작업

카탈로그

작업

권한

작업

관리자

작업

일반

작업

쿠폰

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

작업

프로모션 코드

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

작업

코드에 대한 프로모션 코드 제한 가져오기Server-sideAdmin

요청

코드를 사용할 수 있는 남은 횟수를 가져옵니다. 코드를 필터링하려면 codes 쿼리 매개 변수를 사용합니다.

코드 제한 자체를 구성하려면 관리자 섹션으로 이동합니다.

보안
basicAuth
경로
project_idinteger필수

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

예제: 44056
external_idinteger필수

프로모션 외부 ID입니다. 프로젝트 내부의 고유 프로모션 식별자입니다.

예제: coupon_44056_1
쿼리
codes[]Array of strings

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

limitinteger>= 1

페이지 요소 개수 제한입니다.

예제: limit=50
offsetinteger>= 0

목록이 생성된 요소의 개수입니다(개수는 0부터 시작함).

예제: offset=0
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ko/api/shop-builder/v2/project/44056/admin/code/limit/promocode/external_id/coupon_44056_1?codes%5B%5D=string&limit=50&offset=0'

응답

코드에 대한 프로모션 코드 제한 사항을 성공적으로 수신했습니다.

본문application/json
has_moreboolean

코드가 존재하는 다른 페이지가 있는 경우입니다.

itemsArray of objects(Code-limit-promo-code)
promotion_idinteger

프로모션 ID입니다. 프로젝트 내부의 고유 프로모션 식별자입니다.

total_items_countnumber

총 코드 개수입니다.

응답
application/json
{
  "has_more": false,
  "items": [
    { … },
    { … }
  ],
  "promotion_id": 1,
  "total_items_count": 2
}

프로모션 코드 프로모션 활성화Server-sideAdmin

요청

프로모션 코드 프로모션을 활성화합니다.

생성된 프로모션 코드 프로모션은 기본적으로 비활성화되어 있습니다. 프로모션을 활성화할 때까지 사용할 수 없습니다. 이 엔드포인트를 사용하여 프로모션 코드 프로모션을 활성화합니다.

보안
basicAuth
경로
project_idinteger필수

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

예제: 44056
external_idinteger필수

프로모션 외부 ID입니다. 프로젝트 내부의 고유 프로모션 식별자입니다.

예제: coupon_44056_1
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ko/api/shop-builder/v2/project/44056/admin/promocode/coupon_44056_1/activate

응답

프로모션 코드를 성공적으로 활성화했습니다.

응답
콘텐츠 없음

프로모션 코드 프로모션용 코드 가져오기Server-sideAdmin

요청

프로모션 코드 프로모션용 코드를 가져옵니다.

보안
basicAuth
경로
project_idinteger필수

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

예제: 44056
external_idinteger필수

프로모션 외부 ID입니다. 프로젝트 내부의 고유 프로모션 식별자입니다.

예제: coupon_44056_1
쿼리
limitinteger>= 1

페이지 요소 개수 제한입니다.

예제: limit=50
offsetinteger>= 0

목록이 생성된 요소의 개수입니다(개수는 0부터 시작함).

예제: offset=0
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/ko/api/shop-builder/v2/project/44056/admin/promocode/coupon_44056_1/code?limit=50&offset=0'

응답

프로모션 코드용 코드 목록을 성공적으로 수신했습니다.

본문application/json
codesArray of objects
total_countnumber

프로모션 코드의 총 코드 개수입니다.

응답
application/json
{
  "codes": [
    { … },
    { … },
    { … },
    { … },
    { … }
  ],
  "total_count": 5
}

고유 카탈로그 혜택

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

작업

할인

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

작업

보너스

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

작업

관리자

작업

카탈로그

작업

가상 결제

작업

관리

작업

관리자

작업

클라이언트

작업

클랜 클라이언트

작업

관리자

작업

클라이언트

작업

관리자

작업

클라이언트

작업

관리자

작업

클라이언트

작업

관리자

작업