콘텐츠로 건너뛰기

개요

카탈로그 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/
작업
작업
작업
작업
작업
작업
작업
작업
작업
작업
작업
작업
작업
작업
작업
작업

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

요청

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

보안
basicAuth
경로
project_idinteger필수

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

예제: 44056
curl -i -X GET \
  -u <username>:<password> \
  https://connector.xsolla.com/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://connector.xsolla.com/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" }
작업
작업
작업

카탈로그

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

작업
작업
작업