Zum Inhalt springen
/
Retrieve info about autom...

Metaverse Orbs API (1.0.0)

Metaverse Orbs API

OpenAPI-Beschreibung herunterladen
index.json
index.yaml
Sprachen
Server
http://orbs.babka.com/
Mock server
https://xsolla.redocly.app/_mock/de/api/metaframe/

MultiCurrencies

Operationen

Get multi virtual currencies balance

Anfrage

Gets information about multi virtual currencies and shards balance.

Sicherheit
Bearer
Pfad
merchantIdstringerforderlich

Merchant ID of the client

projectIdstringerforderlich

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'

Antworten

Values of multi virtual crrencies balances.

Bodyapplication/json
itemsArray of objects(Balances)

List of multicurrency balances.

Beispiel: [{"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.

Antwort
application/json
{
  "items": [
    { … }
  ]
}

Topup user's multicurrency balance

Anfrage

Top up user multicurrency balance.

Sicherheit
Server
Pfad
merchantIdstringerforderlich

Merchant ID of the client

projectIdstringerforderlich

Project ID of the project

Header
X-OPERATION-IDstring(UUID)= 36 characterserforderlich

Unique operation ID.

X-HOST-IDstring(UUID)= 36 characterserforderlich

Unique operator ID.

Bodyapplication/json
shardsinteger(int64)>= 1erforderlich

Number of Shards to topup.

Beispiel: 22
user_idstring(UUID)non-emptyerforderlich

Xsolla Account ID.

Beispiel: "b8fa3003-2448-49fb-bbe2-7f72f420e350"
virtual_currency_skustringnon-emptyerforderlich

Multicurrency SKU

Beispiel: "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"
  }'

Antworten

Operation successful

Bodyapplication/json
balanceobject
Beispiel: {"balance":1,"shards":5}
balance.​balanceinteger

Multicurrency balance.

Beispiel: 1
balance.​shardsinteger

Multicurrency Shards balance.

Beispiel: 5
Antwort
application/json
{
  "balance": {
    "balance": 1,
    "shards": 5
  }
}

Retrieve info about automatic purchase

Anfrage

Retrieve information about automatic purchase.

Sicherheit
Server
Pfad
merchantIdstringerforderlich

Merchant ID of the client

projectIdstringerforderlich

Project ID of the project

userIdstring(UUID)= 36 characterserforderlich

Unique User ID.

Header
X-HOST-IDstring(UUID)= 36 characterserforderlich

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'

Antworten

Information about automatic purchase.

Bodyapplication/json
itemsArray of objects(Item)
Beispiel: [{"enabled":false,"virtual_currency_sku":"xxx-xxx-xxx"}]
items[].​enabledbooleanerforderlich

Whether automatic purchase of multicurrency is enabled for the user.

items[].​virtual_currency_skustringerforderlich

Virtual Currency SKU

Antwort
application/json
{
  "items": [
    { … }
  ]
}

Update info about automatic purchase

Anfrage

Updates information about automatic purchase.

Sicherheit
Server
Pfad
merchantIdstringerforderlich

Merchant ID of the client

projectIdstringerforderlich

Project ID of the project

userIdstring(UUID)= 36 characterserforderlich

Unique User ID.

Header
X-HOST-IDstring(UUID)= 36 characterserforderlich

Unique operator ID.

Bodyapplication/json
itemsArray of objects(Item)
Beispiel: [{"enabled":false,"virtual_currency_sku":"xxx-xxx-xxx"}]
items[].​enabledboolean

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

items[].​virtual_currency_skustringerforderlich

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"
      }
    ]
  }'

Antworten

Information about automatic purchase.

Bodyapplication/json
itemsArray of objects(Item)
Beispiel: [{"enabled":false,"virtual_currency_sku":"xxx-xxx-xxx"}]
items[].​enabledbooleanerforderlich

Whether automatic purchase of multicurrency is enabled for the user.

items[].​virtual_currency_skustringerforderlich

Virtual Currency SKU

Antwort
application/json
{
  "items": [
    { … }
  ]
}

Charge

Operationen

Package

Operationen

Manual purchase

Operationen