콘텐츠로 건너뛰기
/
카탈로그 필터 규칙 가져오기

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

작업

카탈로그 필터 규칙 삭제Server-sideAdmin

요청

특정 규칙을 삭제합니다.

보안
basicAuth
경로
project_idinteger필수

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

예제: 44056
rule_idnumber필수

규칙 ID입니다.

예제: 1
curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ko/api/shop-builder/v2/project/44056/admin/user/attribute/rule/1

응답

성공적으로 삭제했습니다.

응답
콘텐츠 없음

카탈로그 필터 규칙 가져오기Server-sideAdmin

요청

사용자 특성에 적용하는 특정 규칙을 가져옵니다.

보안
basicAuth
경로
project_idinteger필수

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

예제: 44056
rule_idnumber필수

규칙 ID입니다.

예제: 1
curl -i -X GET \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ko/api/shop-builder/v2/project/44056/admin/user/attribute/rule/1

응답

규칙을 성공적으로 수신했습니다.

본문application/json
attribute_conditionsArray of type = string (object) or type = number (object) or type = date (object)(personalized-catalog_user-attribute_conditions_model-get)[ 1 .. 100 ] items필수

사용자 특성 검증 조건. 사용자 특성이 지정된 모든 조건과 일치하는지 여부에 따라 카탈로그의 아이템 가용성을 결정합니다.

One of:
attribute_conditions[].​attributestring(user-attribute_conditions_properties_attribute)[ 1 .. 255 ] characters^[-_.\d\w]+$

사용자 특성 코드입니다.

attribute_conditions[].​can_be_missingboolean(user-attribute_conditions_properties_can_be_missing)

사용자 특성에서 특성이 누락된 경우에도 조건이 충족됨을 나타냅니다. 이 특성이 없는 사용자에게 항목을 표시하려면 true를 전달하십시오. 특성이 있지만 값이 조건에 지정된 값과 일치하지 않는 사용자는 항목을 볼 수 없습니다. false - 특성이 있지만 값이 조건에 지정된 값과 일치하지 않거나 특성이 누락된 사용자는 항목을 볼 수 없습니다.

attribute_conditions[].​operatorstring(user-attribute_conditions_properties_operator_string)

조건에 따라 수행하는 작업 유형입니다. string 특성 유형에 해당합니다.

열거형 값설명
eq

같음

ne

같지 않음

attribute_conditions[].​typestring(user-attribute_conditions_properties_type-string)

사용자 특성 유형입니다.

값"string"
attribute_conditions[].​valuestring(user-attribute_conditions_properties_value)<= 255 characters

사용자 특성 값을 비교할 조건 값입니다. 유형은 특성 유형에 따라 다릅니다.

is_enabledboolean필수

규칙을 사용할 수 있는 경우.

is_satisfied_for_unauthboolean

인증되지 않은 사용자에게 아이템이 표시되는지 여부입니다. true이면 카탈로그 표시 규칙에 관계없이 인증되지 않은 사용자에게 아이템이 표시됩니다. 기본값은 false입니다.

itemsArray of objects필수
items[].​bundle_typestring

번들 유형입니다. 아이템 유형이 번들인 경우 반환됩니다.

열거형"standard""virtual_currency_package"
items[].​item_idnumber

아이템 ID입니다.

items[].​namestring

아이템 이름입니다.

items[].​skustring

아이템 SKU입니다.

items[].​typestring

아이템 유형입니다.

열거형"virtual_good""virtual_currency""bundle""physical_good""unit"
namestring필수

규칙의 읽을 수 있는 이름입니다. 관리자 페이지에서 규칙을 표시할 때 사용합니다.

rule_idnumber필수

규칙 ID입니다.

응답
application/json
{
  "attribute_conditions": [
    { … }
  ],
  "is_enabled": true,
  "is_satisfied_for_unauth": true,
  "items": [
    { … }
  ],
  "name": "Ork race armor rule",
  "rule_id": 1
}

패치 카탈로그 필터 규칙Server-sideAdmin

요청

사용자 특성에 적용하는 특정 규칙을 업데이트합니다. 현재 값을 지정되지 않은 특성에 사용합니다.

보안
basicAuth
경로
project_idinteger필수

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

예제: 44056
rule_idnumber필수

규칙 ID입니다.

예제: 1
본문application/json
attribute_conditionsArray of type = string (object) or type = number (object) or type = date (object)(personalized-catalog_user-attribute_conditions_model-post)[ 1 .. 100 ] items

사용자 특성 검증 조건. 사용자 특성이 지정된 모든 조건과 일치하는지 여부에 따라 카탈로그의 아이템 가용성을 결정합니다.

is_enabledboolean

규칙을 사용할 수 있는 경우.

is_satisfied_for_unauthboolean

인증되지 않은 사용자에게 아이템이 표시되는지 여부입니다. true이면 카탈로그 표시 규칙에 관계없이 인증되지 않은 사용자에게 아이템이 표시됩니다. 기본값은 false입니다.

itemsArray of objects[ 1 .. 100 ] items
namestring[ 1 .. 255 ] characters^\S

규칙의 읽을 수 있는 이름입니다. 관리자 페이지에서 규칙을 표시할 때 사용합니다.

curl -i -X PATCH \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ko/api/shop-builder/v2/project/44056/admin/user/attribute/rule/1 \
  -H 'Content-Type: application/json' \
  -d '{
    "is_enabled": false
  }'

응답

성공적으로 업데이트했습니다.

응답
콘텐츠 없음

관리자

작업

카탈로그

작업

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

작업

장바구니(서버 측)

작업

결제(클라이언트 측)

작업

결제(서버 측)

작업

주문

작업

무료 아이템

작업

웹훅

작업

선주문

작업

판매자

작업

카탈로그

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

작업

공통 지역

작업

카탈로그

작업

권한

작업

관리자

작업

일반

작업

쿠폰

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

작업

프로모션 코드

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

작업

고유 카탈로그 혜택

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

작업

할인

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

작업

보너스

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

작업

관리자

작업

카탈로그

작업

가상 결제

작업

관리

작업

관리자

작업

클라이언트

작업

클랜 클라이언트

작업

관리자

작업

클라이언트

작업

관리자

작업

클라이언트

작업

관리자

작업

클라이언트

작업

관리자

작업