콘텐츠로 건너뛰기

Metaverse Orbs API (1.0.0)

Metaverse Orbs API

OpenAPI 설명 다운로드
index.json
index.yaml
언어
서버
http://orbs.babka.com/
Mock server
https://xsolla.redocly.app/_mock/ko/api/metaframe/

MultiCurrencies

작업

Get multi virtual currencies balance

요청

Gets information about multi virtual currencies and shards balance.

보안
Bearer
경로
merchantIdstring필수

Merchant ID of the client

projectIdstring필수

Project ID of the project

curl -i -X GET \
  'http://orbs.babka.com/v2/merchants/{merchantId}/projects/{projectId}/multicurrency-balance' \
  -H 'Authorization: YOUR_API_KEY_HERE'

응답

Values of multi virtual crrencies balances.

본문application/json
itemsArray of objects(Balances)

List of multicurrency balances.

예제: [{"balance":14,"image_url":"https://imgurl.com","name":"Blue Orb Point","points":{"base":240,"point":80},"shards":2,"virtual_currency_sku":"xxxxx"}]
items[].​balanceinteger

Multicurrency balance.

items[].​image_urlstring

Multicurrency image url.

items[].​is_allowable_to_buyboolean

To distingush between partially available and available status of virtual currency

items[].​namestring

Multicurrency name.

items[].​pointsobject

Shards balance in time points.

items[].​points.​baseinteger

Shard base, number of time points in one Multicurrency.

items[].​points.​pointinteger

Shard balance in time points.

items[].​shardsinteger

Shard balance.

items[].​virtual_currency_skustring

Multicurrency sku.

응답
application/json
{
  "items": [
    { … }
  ]
}

Topup user's multicurrency balance

요청

Top up user multicurrency balance.

보안
Server
경로
merchantIdstring필수

Merchant ID of the client

projectIdstring필수

Project ID of the project

헤더
X-OPERATION-IDstring(UUID)= 36 characters필수

Unique operation ID.

X-HOST-IDstring(UUID)= 36 characters필수

Unique operator ID.

본문application/json
shardsinteger(int64)>= 1필수

Number of Shards to topup.

예제: 22
user_idstring(UUID)non-empty필수

Xsolla Account ID.

예제: "b8fa3003-2448-49fb-bbe2-7f72f420e350"
virtual_currency_skustringnon-empty필수

Multicurrency SKU

예제: "sapphire_point"
curl -i -X POST \
  'http://orbs.babka.com/v2/merchants/{merchantId}/projects/{projectId}/multicurrency-balance-topup' \
  -H 'Content-Type: application/json' \
  -H 'X-HOST-ID: stringstringstringstringstringstring' \
  -H 'X-OPERATION-ID: stringstringstringstringstringstring' \
  -H 'X-SERVER-AUTHORIZATION: YOUR_API_KEY_HERE' \
  -d '{
    "shards": 22,
    "user_id": "b8fa3003-2448-49fb-bbe2-7f72f420e350",
    "virtual_currency_sku": "sapphire_point"
  }'

응답

Operation successful

본문application/json
balanceobject
예제: {"balance":1,"shards":5}
balance.​balanceinteger

Multicurrency balance.

예제: 1
balance.​shardsinteger

Multicurrency Shards balance.

예제: 5
응답
application/json
{
  "balance": {
    "balance": 1,
    "shards": 5
  }
}

Retrieve info about automatic purchase

요청

Retrieve information about automatic purchase.

보안
Server
경로
merchantIdstring필수

Merchant ID of the client

projectIdstring필수

Project ID of the project

userIdstring(UUID)= 36 characters필수

Unique User ID.

헤더
X-HOST-IDstring(UUID)= 36 characters필수

Unique operator ID.

curl -i -X GET \
  'http://orbs.babka.com/v2/merchants/{merchantId}/projects/{projectId}/user/{userId}/auto-topup' \
  -H 'X-HOST-ID: stringstringstringstringstringstring' \
  -H 'X-SERVER-AUTHORIZATION: YOUR_API_KEY_HERE'

응답

Information about automatic purchase.

본문application/json
itemsArray of objects(Item)
예제: [{"enabled":false,"virtual_currency_sku":"xxx-xxx-xxx"}]
items[].​enabledboolean필수

Whether automatic purchase of multicurrency is enabled for the user.

items[].​virtual_currency_skustring필수

Virtual Currency SKU

응답
application/json
{
  "items": [
    { … }
  ]
}

Update info about automatic purchase

요청

Updates information about automatic purchase.

보안
Server
경로
merchantIdstring필수

Merchant ID of the client

projectIdstring필수

Project ID of the project

userIdstring(UUID)= 36 characters필수

Unique User ID.

헤더
X-HOST-IDstring(UUID)= 36 characters필수

Unique operator ID.

본문application/json
itemsArray of objects(Item)
예제: [{"enabled":false,"virtual_currency_sku":"xxx-xxx-xxx"}]
items[].​enabledboolean

Whether automatic purchase of Blue Orbs is enabled for the user.

items[].​virtual_currency_skustring필수

Virtual Currency SKU.

curl -i -X PUT \
  'http://orbs.babka.com/v2/merchants/{merchantId}/projects/{projectId}/user/{userId}/auto-topup' \
  -H 'Content-Type: application/json' \
  -H 'X-HOST-ID: stringstringstringstringstringstring' \
  -H 'X-SERVER-AUTHORIZATION: YOUR_API_KEY_HERE' \
  -d '{
    "items": [
      {
        "enabled": false,
        "virtual_currency_sku": "xxx-xxx-xxx"
      }
    ]
  }'

응답

Information about automatic purchase.

본문application/json
itemsArray of objects(Item)
예제: [{"enabled":false,"virtual_currency_sku":"xxx-xxx-xxx"}]
items[].​enabledboolean필수

Whether automatic purchase of multicurrency is enabled for the user.

items[].​virtual_currency_skustring필수

Virtual Currency SKU

응답
application/json
{
  "items": [
    { … }
  ]
}

Charge

작업

Package

작업

Manual purchase

작업