콘텐츠로 건너뛰기

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를 사용하여 프로모션 코드를 관리할 수 있습니다.

작업

고유 카탈로그 혜택

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

작업

할인

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

작업

보너스

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

작업

관리자

작업

카탈로그

작업

가상 결제

작업

관리

작업

관리자

작업

클라이언트

작업

클랜 클라이언트

작업

관리자

작업

클라이언트

작업

관리자

작업

클라이언트

작업

관리자

작업

클라이언트

작업

관리자

작업

아이템 가져오기 상태 검색Server-sideAdmin

요청

프로젝트로 아이템을 가져오는 진행률에 대한 정보를 검색합니다. 이 API 호출은 API 또는 관리자 페이지 API를 통해 수행된 마지막 가져오기에 대한 데이터를 검색합니다.

보안
basicAuth
경로
project_idinteger필수

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

예제: 44056
curl -i -X GET \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ko/api/shop-builder/v1/admin/projects/44056/connectors/import_items/import/status

응답

가져오기 상태가 성공적으로 검색되었습니다.

본문application/json
date_completedstring

GMT+3 시간대로 표시되는 가져오기 작업 완료 타임스탬프입니다. 오류로 인해 가져오기가 중단되고 가져온 아이템이 없는 경우 빈 문자열이 반환됩니다.

예제: "2024-11-19T15:27:31+03:00"
date_createdstring

GMT+3 시간대로 표시되는 가져오기 생성 작업의 타임스탬프입니다.

예제: "2024-11-19T14:27:31+03:00"
date_updatedstring

오류로 인해 가져오기가 중단된 GMT+3 시간대로 표시되는 타임스탬프입니다.

예제: "2024-11-19T15:27:31+03:00"
errorstring

일반 가져오기 오류에 대한 설명입니다.

error_codestring

일반 가져오기 오류에 대한 코드입니다.

progressinteger

가져오기 실행 진행률(%)입니다.

예제: 100
resultobject

특정 아이템 SKU에 대한 가져오기 결과 및 가져오기 오류에 대한 데이터가 있는 개체입니다.

예제: {"errors_by_sku":[{"error_code":4055,"error_message":"[0401-4055]: Item default price not set","sku":"com.xsolla.sword_1","type":"virtual_items"},{"error_code":1817,"error_message":"[0410-1817]: SKU can't be empty","sku":"","type":null}],"errors_count":2,"total_entities_count":10}
statusstring

가져오기 상태입니다.

열거형 값설명
done

가져오기에 성공했습니다.

error

오류로 인해 가져오기가 완료되지 않았거나 부분적으로만 완료되었습니다.

initialized

가져오기가 시작되었습니다.

process

가져오기가 진행 중입니다.

예제: "error"
응답
application/json
{
  "date_completed": "2024-11-19T15:27:31+03:00",
  "date_created": "2024-11-19T14:27:31+03:00",
  "date_updated": "2024-11-19T15:27:31+03:00",
  "error": null,
  "error_code": null,
  "progress": 100,
  "result": {
    "errors_by_sku": [ … ],
    "errors_count": 2,
    "total_entities_count": 10
  },
  "status": "error"
}

JSON 파일을 통해 아이템 가져오기Server-sideAdmin

요청

지정된 URL을 통해 JSON 파일에서 스토어로 아이템을 가져옵니다. JSON 파일에서 가져오기에 대한 자세한 정보는 설명서를 참조하세요.

보안
basicAuth
경로
project_idinteger필수

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

예제: 44056
본문application/json
connector_external_idstring필수

아이템을 가져오기 위한 작업 유형을 지정하는 고정 값입니다.

값"import_items"
file_urlstring필수

JSON 형식의 데이터가 있는 파일의 URL입니다. 파일은 공개 액세스가 가능한 스토리지 서비스에 호스팅되어야 합니다. 스토어 > 가상 아이템 > 카탈로그 관리 > 아이템 가져오기(JSON) 섹션의 관리자 페이지에서 파일 템플릿을 다운로드할 수 있습니다.

예제: "https://my-bucket.s3.amazonaws.com/items.json"
modestring

가져오기 작업:

기본값 "create_and_update"
열거형 값설명
create

새 아이템 추가.

create_and_update

새 아이템 추가 및 기존 아이템 업데이트.

sync

새로 추가, 기존 아이템 업데이트 및 누락된 아이템 비활성화.

curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/ko/api/shop-builder/v1/projects/44056/import/from_external_file \
  -H 'Content-Type: application/json' \
  -d '{
    "connector_external_id": "import_items",
    "file_url": "https://my-bucket.s3.amazonaws.com/items.json",
    "mode": "create"
  }'

응답

파일을 성공적으로 가져와서 처리 중입니다.

본문application/json
import_idstring

가져오기 작업 ID입니다. JSON 파일을 가져오는 데 문제가 있는 경우, 이 ID를 고객 성공 관리자에게 보고하거나 csm@Xsolla.com으로 이메일을 보내십시오.

예제: "af9f3638a16e11ef880da2cd677d2d24"
응답
application/json
{
  "import_id": "af9f3638a16e11ef880da2cd677d2d24"
}