콘텐츠로 건너뛰기

Catalog API (2.0.0)

개요

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

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

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

API 호출

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

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

관리자

작업

카탈로그

작업

가상 결제

작업

카탈로그

작업

권한

작업

관리자

작업

관리자

작업

카탈로그

작업

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

작업

장바구니(서버 측)

작업

결제(클라이언트 측)

작업

결제(서버 측)

작업

주문

작업

무료 아이템

작업

관리

작업

관리자

작업

웹훅

작업

웹훅 설정에 대한 정보 가져오기Server-sideAdmin

요청

스토어의 웹훅 설정에 대한 정보를 가져옵니다. 자세한 정보는 웹훅 설명서를 확인하십시오.

보안
basicAuth
경로
project_idinteger필수

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

예제: 44056
curl -i -X GET \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/webhook

응답

웹훅 설정에 대한 정보를 성공적으로 수신했습니다.

본문application/json
is_enabledboolean
예제: true
secretstring
예제: "my_secret"
urlstring
예제: "http://site.ru/webhook"
응답
application/json
{
  "is_enabled": true,
  "secret": "my_secret",
  "url": "http://site.ru/webhook"
}

웹훅 설정에 대한 정보 업데이트Server-sideAdmin

요청

스토어의 웹훅 설정에 대한 정보를 업데이트합니다. 자세한 정보는 웹훅 설명서를 참조하세요.

보안
basicAuth
경로
project_idinteger필수

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

예제: 44056
본문application/json필수

웹훅 설정에 대한 정보입니다.

is_enabledboolean필수

게임 서비스 웹훅이 활성화되었는지 여부입니다.

게임 서비스 웹훅의 경우, 이 API 호출에서 지정된 설정은 프로젝트 설정 > 웹훅 섹션의 관리자 페이지에서 구성한 설정보다 우선시됩니다.

예제: true
secretstring필수

게임 서비스 웹훅을 서며ㅇ하기 위한 프로젝트 비밀 키입니다.

게임 서비스의 경우 이 API 호출에서 지정된 키는 프로젝트 설정 > 웹훅 섹션의 관리자 페이지에서 생성한 키보다 우선시됩니다.

예제: "my_secret_key"
urlstring필수

게임 서비스 웹훅 수신을 위한 서버의 URL입니다. URL은 공개적으로 액세스 가능해야 하며 HTTPS 프로토콜을 사용해야 합니다(예: https://example.com). 웹훅을 테스트하는 도구에서 찾은 URL을 지정할 수도 있습니다.

게임 서비스 웹훅의 경우, 이 API 호출에서 지정된 설정은 프로젝트 설정 > 웹훅 섹션의 관리자 페이지에서 구성한 설정보다 우선시됩니다.

예제: "http://site.ru/webhook"
versioninteger

웹훅 버전입니다. 버전 '2'에서 아이템 배열에는 버전 '1'(기본값)에 없는 매개 변수 is_free, is_bonus 및 is_bundle_content가 포함됩니다.

열거형12
예제: 1
curl -i -X PUT \
  -u <username>:<password> \
  https://store.xsolla.com/api/v2/project/44056/admin/webhook \
  -H 'Content-Type: application/json' \
  -d '{
    "is_enabled": true,
    "secret": "my_secret_key",
    "url": "http://site.ru/webhook",
    "version": 1
  }'

응답

웹훅 설정에 대한 정보를 성공적으로 업데이트했습니다.

응답
콘텐츠 없음

선주문

작업

판매자

작업

카탈로그

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

작업

공통 지역

작업

관리자

작업