The following documentation was deprecated. Current version is available at developers.xsolla.com

사용자 생성 콘텐츠

사용자 생성 콘텐츠(UGC) 모듈은 게임 사용자가 만든 인게임 콘텐츠를 팔 수 있는 게임을 위해 설계되었습니다. 여기에는 다음과 같은 참가자를 포함합니다.

  • 콘텐츠 작성자 - 콘텐츠를 생성하는 사용자, 가격을 설정하고 게임 콘텐츠 제공
  • 게임 - 콘텐츠 관리 서비스 제공(콘텐츠 작성자 대시보드), 사용자로부터 컨텐츠 접수
  • 마켓플레이스 - 콘텐츠 상점
  • 고객 - 마켓플레이스에서 콘텐츠를 구매하고 게임에서 이를 사용할 수 있는 사용자

통합 가이드

모듈 통합 방법:

  1. Xsolla 게시자 계정을 등록합니다.
  2. 프로젝트를 생성합니다.
  3. 콘텐츠 작성자 대시보드를 구축할 수 있도록 API를 통합합니다.
  4. 마켓플레이스를 구축할 수 있도록 API를 통합합니다.
  5. 상점 UI를 설정합니다.
  6. 웹훅 처리를 설정합니다.
  7. 결제 프로세스를 테스트합니다.
  8. 모듈을 시작하고 계약서에 서명합니다.

통합에 필요한 매개변수는 다음과 같습니다.

  • 판매자 ID — 게시자 계정 URL에 표시: https://publisher.xsolla.com/{merchant_id}/.
  • API 키게시자 계정 > 설정 > 회사에서 생성.
  • 프로젝트 ID — 프로젝트 설정을 볼 때 게시자 계정 URL에 표시: https://publisher.xsolla.com/{merchant_id}/projects/{project_id}/.
  • 프로젝트 비밀 키 — 프로젝트 설정에서 생성.

프로젝트 생성

  1. 프로젝트로 이동하여 새 프로젝트 생성을 클릭합니다.
  2. 프로젝트 설정에서,
    1) 프로젝트 웹훅에 서명할 비밀 키를 생성합니다.
    2) 가상 아이템 모듈을 활성화합니다.

콘텐츠 작성자 대시보드 구축 방법

다음과 같은 페이지가 인터페이스에 포함되어 있어야 합니다.

  1. 등록 및 로그인
  2. 법률 계약서 - 계약서 서명 페이지
  3. 자산 제출 - 콘텐츠 작성 페이지
  4. 승인 - 콘텐츠 승인 페이지
  5. 거래 - 거래 목록 페이지
  6. 세금 인터뷰 - 지불금 수령을 위한 납세 신고서 작성 페이지
  7. 은행 계좌 - 지불금 수령을 위해 필요한 정보
  8. 지불금 - 지불금 목록

등록 및 로그인

Xsolla 로그인을 사용하여 등록 및 로그인하는 것이 좋습니다. 이를 적용하는 자세한 내용은 Xsolla 로그인 통합 가이드를 참조하십시오.

등록이 성공적으로 끝나면 Xsolla 시스템에서 콘텐츠 작성자 기록을 생성해야 합니다. 이를 위해, 새 콘텐츠 작성자 추가법인 생성 API 방법을 사용합니다.

모든 콘텐츠 작성자는 법률 계약서에 서명해야 합니다. 법률 계약서 페이지를 열려면 법률 계약서 링크를 가져오기 API 방법을 사용합니다. 결과 링크는 iframe 또는 새 창에서 계약서 페이지를 여는데 사용됩니다.

자산 제출

콘텐츠 작성자가 새 UGC를 업로드하면 관리자는 Xsolla 시스템에서 해당 UGC를 생성하고 아이템 생성 방법을 사용하여 파일을 업로드해야 합니다.

콘텐츠용 파일 업로드 요청

$ curl -v 'https://api.xsolla.com/merchant/merchants/project/{project_id}/virtual_items/items/{item_id}/files' \
-X PUT \
-u merchant_id:merchant_api_key \
-H 'Content-Type: image/png' \
-H 'Accept: application/json' \
-d '[image data]

승인

승인 후에는 사용자 생성 콘텐츠가 콘텐츠 상점에 표시되어야 합니다. 아이템을 표시하려면, JSON 본문에서 "enabled"를 true로 설정하고콘텐츠 방법 업데이트를 요청합니다.

거래

작성자는 자신의 콘텐츠에서 이루어진 모든 거래를 확인할 수 있어야 합니다. 모든 거래 목록 나열 방법을 사용하여 거래 목록을 가져올 수 있습니다. 이 경우 거래에 대한 자세한 목록이 표시됩니다.

세금 인터뷰

각 콘텐츠 작성자는 지불금을 받으려면 세금 인터뷰 양식에 세금 정보를 입력해야 합니다. 세금 인터뷰 페이지에 액세스하려면 세금 인터뷰 양식 링크 가져오기 방법을 사용하십시오. 결과 링크는 iframe 또는 새 창에서 세금 인터뷰 페이지를 여는데 사용됩니다.

은행 계좌

콘텐츠 작성자의 은행 계좌 세부 정보를 준비합니다. Xsolla는 해당 은행 계좌로 지불금을 입금합니다. 결제 방식 생성 방법을 사용하여 Xsolla 시스템에 정보를 추가합니다.

지불금

이 페이지에서 콘텐츠 작성자가 지불금 목록을 확인하게 됩니다. 모든 거래 가져오기 방법을 사용하여 지불금 목록을 가져옵니다. legal_entity_id 또는 상태로 지불금을 필터링할 수 있습니다. 지불금 상태는 다음과 같이 될 수 있습니다.

  • 보류 - 지불 요청 대기 중
  • 준비 완료 - 지불 대기 중
  • 지불 완료 - 성공적으로 지불됨

상태="보류"인 지불금은 모두 요청이 있는 경우 지불될 수 있습니다.

$ curl -v 'https://api.xsolla.com/merchant/merchants/{merchant_id}/legal_entities/{legal_entity_id}/transfers/payout' \
-X POST \
-u merchant_id:merchant_api_key
-d '{
       "draft_ids": [ 23, 45, 34]
    }
'

마켓플레이스 구축

상점에는 다음과 같은 페이지가 포함되어 있습니다.

  1. 마켓플레이스 - 사용자가 생성한 콘텐츠 목록이 표시됩니다.
  2. 체크 아웃 - 콘텐츠에 대한 자세한 정보를 표시하고 사용자는 이를 통해 결제를 확인할 수 있습니다.

마켓플레이스

마켓플레이스에는 구매할 수 있는 모든 아이템 또는 상품이 표시됩니다. 아이템 목록을 가져오려면, 아이템 목록 가져오기 방법을 사용하십시오.

체크 아웃

체크 아웃 페이지는 사용자에게 아이템에 대한 자세한 정보를 제공합니다. 정보를 가져오려면, 아이템 정보 가져오기 방법을 사용합니다.

토큰을 받아 상점 열기

상점 UI를 게임에 통합하려면 액세스 토큰이 필요합니다. 액세스 토큰은 게임, 사용자 및 구매 매개변수를 식별하는 문자열입니다.

Xsolla API는 HTTP 기본 인증을 사용합니다. 판매자 ID를 기본 인증 사용자 이름으로 제공하고 API 키를 암호로 제공하십시오.

결제 프로세스를 테스트하려면 값을 "mode":"sandbox"로 설정하십시오.

토큰 엔드포인트 URL:

https://api.xsolla.com/merchant/merchants/{merchant_id}/token

HTTP POST 요청에서, 상점 UI의 매개변수를 사용할 수 있습니다. 요청 및 응답 페이로드는 JSON 형식으로 되어 있습니다.

요청 예제

아래에는 Xsolla PHP SDK를 사용하여 PHP에서 토큰을 얻는 방법에 대한 샘플 코드가 제공되어 있습니다. 다른 프로그래밍 언어를 사용하고 있는 경우, CURL 탭을 클릭하여 CURL 예제를 살펴보십시오.

PHP
CURL
<?php

use Xsolla\SDK\API\XsollaClient;
use Xsolla\SDK\API\PaymentUI\TokenRequest;

$tokenRequest = new TokenRequest($projectId, $userId);
$tokenRequest->setUserEmail('email@example.com')
    ->setExternalPaymentId('12345')
    ->setSandboxMode(true)
    ->setUserName('USER_NAME')
    ->setCustomParameters(array('key1' => 'value1', 'key2' => 'value2'));

$xsollaClient = XsollaClient::factory(array(
    'merchant_id' => MERCHANT_ID,
    'api_key' => API_KEY
));
$token = $xsollaClient->createPaymentUITokenFromRequest($tokenRequest);
    curl -v https://api.xsolla.com/merchant/merchants/{merchant_id}/token \
    -X POST \
    -u your_merchant_id:merchant_api_key \
    -H 'Content-Type:application/json' \
    -H 'Accept: application/json' \
    -d '
    {
        "user": {
            "id": {
                "value": "1234567"
            },
            "email": {
                "value": "email@example.com"
            }
        },
        "settings": {
            "project_id": 14004,
            "mode": "sandbox"
        }
    }'

매개변수 전체 목록은 API Reference에서 확인할 수 있습니다.

상점 UI 열기

상점을 열 수 있는 세 가지 방법:

  • Pay Station 임베드 스크립트 사용.
  • 새 창 사용
  • Iframe 사용

샌드박스 모드로 상점을 열려면 다음 URL을 사용하십시오. https://sandbox-secure.xsolla.com/

Pay Station 임베드

Pay Station 임베드 스크립트가 장치 유형을 결정하고 라이트박스(데스크톱 화면) 또는 새 창(모바일 및 태블릿 화면)에서 상점 UI를 엽니다. 비동기 스크립트 로딩 기능을 사용하는 것이 좋습니다.

비동기 스크립트 로딩 예제:

 <script>
     var options = {
         access_token: 'ACCESS_TOKEN', //TODO use access token, received on previous step
         sandbox: true //TODO please do not forget to remove this setting when going live
     };
     var s = document.createElement('script');
     s.type = "text/javascript";
     s.async = true;
     s.src = "https://static.xsolla.com/embed/paystation/1.0.7/widget.min.js";
     s.addEventListener('load', function (e) {
         XPayStationWidget.init(options);
     }, false);
     var head = document.getElementsByTagName('head')[0];
     head.appendChild(s);
 </script>

<button data-xpaystation-widget-open>Buy Credits</button>

매개변수 전체 목록은 API Reference에서 확인할 수 있습니다.

새 창

새 창에서 상점 UI를 열려면 다음 링크를 사용하십시오. https://secure.xsolla.com/paystation2/?access_token=ACCESS_TOKEN, 여기에서 ACCESS_TOKEN이전 단계에서 입수한 토큰입니다.

Iframe

Iframe에서 상점 UI를 열려면 다음 메커니즘을 실행해야 합니다.

  • 장치 유형(데스크톱 또는 모바일)을 지정하고 토큰의 settings.ui.version 매개변수 내에서 전송합니다.
  • postMessage를 통해 결제 UI로부터 이벤트를 수신합니다.

새 창에서 상점 UI를 열려면 다음 링크를 사용하십시오. https://secure.xsolla.com/paystation2/?access_token=ACCESS_TOKEN, 여기에서 ACCESS_TOKEN이전 단계에서 입수한 토큰입니다.

웹훅 설정

Xsolla는 프로젝트에 다음과 같은 웹훅을 전송합니다.

  • 사용자 유효성 검사
  • 결제
  • 환불

아무런 문제없이 웹훅 알림을 받았음을 확인하려면 사용자 서버가 본문없이 204 HTTP 상태 코드를 반환해야 합니다. 예제를 포함한 웹훅 메커니즘에 대한 내용은 API Reference에 자세히 설명되어 있습니다.

서명 생성

서명 생성 방법:

  1. Xsolla 서버 요청 시 전송된 데이터와 프로젝트의 비밀 키(프로젝트 설정에서 생성)를 연결합니다.
  2. SHA1 알고리즘을 사용하여 문자열 해시합니다.
  3. 서명 헤더에 서명을 전송합니다.

웹훅을 처리할 때 수신한 서명이 서명 헤더에 설정된 서명과 일치하는 확인합니다.

사용자 유효성 검사

Xsolla 서버는 사용자가 게임에 존재하는지 확인하기 위해 프로젝트 웹훅 URL로 요청을 전송합니다.

요청 예제

PHP
CURL
$request = array(
    'notification_type' => 'user_validation',
    'user' => array(
        'ip' => '127.0.0.1',
        'phone' => '18777976552',
        'email'=> 'email@example.com',
        'id'=> '1234567',
        'country' => 'US'
    )
)
curl -v https://example.com/ \
-X POST \
-H 'Content-Type:application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Signature 13342703ccaca5064ad33ba451d800c5e823db8f' \
-d '
{
    "notification_type": "user_validation",
    "user": {
        "ip": "127.0.0.1",
        "phone": "18777976552",
        "email": "email@example.com",
        "id": "1234567",
        "country": "US"
    }
}'

매개변수 전체 목록은API Reference에서 확인할 수 있습니다.

결제

Xsolla 서버는 사용자가 결제를 완료할 때마다 결제 세부 정보가 포함되어 있는 웹훅을 전송합니다.

요청 예제

PHP
CURL
$request = array(
    'notification_type' => 'payment',
    'purchase' => array(
        'virtual_items' => array(
            'items' => array(
                0 => array(
                    'sku' => 'test_item1',
                    'amount' => 1,
                    ),
                1 => array(
                    'sku' => 'test_item2',
                    'amount' => 1,
                    ),
                2 => array(
                    'sku' => 'test_item3',
                    'amount' => 1,
                    ),
            )
        ),
        'total' => array(
            'currency' => 'USD',
            'amount' => 9.99
        )
    ),
    'user' => array(
        'ip' => '127.0.0.1',
        'phone' => '18777976552',
        'email' => 'email@example.com',
        'id' => '1234567',
        'country' => 'US'
    ),
    'transaction' => array(
        'id' => 87654321,
        'payment_date' => '2014-09-23T19:25:25+04:00',
        'payment_method' => 1380,
        'dry_run' => 1
    ),
    'payment_details' => array(
        'payment' => array(
            'currency' => 'USD',
            'amount' => 9.99
        ),
        'vat' => array(
            'currency' => 'USD',
            'amount' => 0
        ),
        'payout_currency_rate' => 1,
        'payout' => array(
            'currency' => 'USD',
            'amount' => 9.49
        ),
        'xsolla_fee' => array(
            'currency' => 'USD',
            'amount' => 0.19
        ),
        'payment_method_fee' => array(
            'currency' => 'USD',
            'amount' => 0.31
        )
    )
)
curl -v https://example.com/ \
-X POST \
-H 'Content-Type:application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Signature 13342703ccaca5064ad33ba451d800c5e823db8f' \
-d '
{
    "notification_type": "payment",
    "purchase": {
        "virtual_items": {
            "items": [
                {
                    "sku": "test_item1",
                    "amount": 1
                },
                {
                    "sku": "test_item2",
                    "amount": 1
                },
                {
                    "sku": "test_item3",
                    "amount": 2
                },
            ]
        },
        "total": {
            "currency": "USD",
            "amount": 9.99
        }
    },
    "user": {
        "ip": "127.0.0.1",
        "phone": "18777976552",
        "email": "email@example.com",
        "id": "1234567",
        "country": "US"
    },
    "transaction": {
        "id": 87654321,
        "payment_date": "2014-09-23T19:25:25+04:00",
        "payment_method": 1380,
        "dry_run": 1
    },
    "payment_details": {
        "payment": {
            "currency": "USD",
            "amount": 9.99
        },
        "vat": {
            "currency": "USD",
            "amount": 0
        },
        "payout_currency_rate": 1,
        "payout": {
            "currency": "USD",
            "amount": 9.49
        },
        "xsolla_fee": {
            "currency": "USD",
            "amount": 0.19
        },
        "payment_method_fee": {
            "currency": "USD",
            "amount": 0.31
        }
    }
}'

매개변수 전체 목록은 API Reference에서 확인할 수 있습니다.

환불

사용자가 결제를 취소할 경우, Xsolla 서버가 지불 정보와 함께 웹훅 알림을 전송합니다.

요청 예제

PHP
CURL
$request = array(
    'notification_type' => 'refund',
    'purchase' => array(
        'virtual_currency' => array(
            'name' => 'Coins',
            'quantity' => 100,
            'currency' => 'USD',
            'amount' => 9.99
        ),
        'total' => array(
            'currency' => 'USD',
            'amount' => 9.99
        )
    ),
    'user' => array(
        'ip' => '127.0.0.1',
        'phone' => '18777976552',
        'email' => 'email@example.com',
        'id' => '1234567',
        'country' => 'US'
    ),
    'transaction' => array(
        'id' => 87654321,
        'payment_date' => '2014-09-23T19:25:25+04:00',
        'payment_method' => 1380,
        'dry_run' => 1
    ),
    'refund_details' => (
            'code' => 1,
            'reason' => 'Fraud'
    ),
    'payment_details' => array(
        'payment' => array(
            'currency' => 'USD',
            'amount' => 9.99
        ),
        'vat' => array(
            'currency' => 'USD',
            'amount' => 0
        ),
        'payout_currency_rate' => 1,
        'payout' => array(
            'currency' => 'USD',
            'amount' => 9.49
        ),
        'xsolla_fee' => array(
            'currency' => 'USD',
            'amount' => 0.19
        ),
        'payment_method_fee' => array(
            'currency' => 'USD',
            'amount' => 0.31
        )
    )
);
curl -v https://example.com/ \
-X POST \
-H 'Content-Type:application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Signature 13342703ccaca5064ad33ba451d800c5e823db8f' \
-d '
{
    "notification_type":"refund",
    "purchase":{
        "virtual_currency":{
            "name": "Coins",
            "quantity":10,
            "currency":"USD",
            "amount":100
        },
        "subscription":{
            "plan_id": "b5dac9c8",
            "subscription_id": "10",
            "date_create": "2014-09-22T19:25:25+04:00",
            "currency": "USD",
            "amount": 9.99
        },
        "checkout":{
            "currency":"USD",
            "amount":50
        },
        "virtual_items":{
            "items":[
                {
                    "sku": "test_item1",
                    "amount":1
                }
            ],
            "currency":"USD",
            "amount":50
        },
        "total":{
            "currency":"USD",
            "amount":200
        }
    },
    "user": {
        "ip": "127.0.0.1",
        "phone": "18777976552",
        "email": "email@example.com",
        "id": "1234567",
        "name": "Xsolla User",
        "country": "US"
    },
    "transaction":{
        "id":1,
        "external_id":1,
        "dry_run":1,
        "agreement":1
    },
    "refund_details":{
        "code":1,
        "reason":"Fraud"
    },
    "payment_details":{
        "xsolla_fee":{
            "currency":"USD",
            "amount":"10"
        },
        "payout":{
            "currency":"USD",
            "amount":"200"
        },
        "payment_method_fee":{
            "currency":"USD",
            "amount":"20"
        },
        "payment":{
            "currency":"USD",
           "amount":"230"
        }
    }
}'

매개변수 전체 목록은 API Reference에서 확인할 수 있습니다.

웹훅 테스트

웹훅 처리 테스트 방법:

  1. 게시자 계정에서, 모듈 설정을 엽니다.
  2. 테스트 탭으로 이동합니다.
  3. 테스트 데이터를 입력한 후 테스트를 클릭합니다. Xsolla 서버는 가능한 모든 웹훅을 전송합니다.
  4. 녹색으로 표시된 테스트는 유효한 응답을 한 경우이며 빨간색으로 표시된 테스트는 오류가 발생한 경우입니다.

결제 프로세스 테스트

Xsolla 샌드박스는 실제 결제를 제외한 결제 프로세스 관련 모든 기능을 지원하는 독립형 환경입니다. "mode" = "sandbox"를 전송하여 샌드박스에 액세스할 수 있습니다( 토큰 입수 시 가능).

은행 카드 결제 테스트 방법:

  1. 샌드박스 모드로 상점을 엽니다.
  2. 구매할 항목을 선택합니다.
  3. 신용/체크카드를 클릭합니다.
  4. 나머지 필드에 은행 카드 세부 정보와 값을 입력합니다. 오류를 확인하기 위해 잘못된 세부 정보(카드 번호, 만료일, CVV)를 입력할 수도 있습니다.

테스트에 사용할 은행 카드 목록

중요 정보! 샌드박스 은행 카드 결제는 USD, EUR, RUB, GBP, SGD, HKD 또는 THB로만 이용할 수 있습니다.

모듈 시작

테스트를 성공적으로 완료한 후 모듈을 시작하려면 게시자 계정에서 설정을 열고 시작 탭으로 이동한 다음, 켜기를 클릭하십시오.

중요 정보! 실제 지불을 받으려면 먼저 다음을 수행해야 합니다.

  1. "mode" = "sandbox"를 제거합니다.
  2. 계약서에 서명합니다.