コンテンツへスキップ
/
Retrieve info about autom...

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/ja/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

操作