Saltar para o conteúdo

Metaverse Orbs API (1.0.0)

Metaverse Orbs API

Transferir a descrição da OpenAPI
index.json
index.yaml
Idiomas
Servidores
http://orbs.babka.com/
Mock server
https://xsolla.redocly.app/_mock/pt/api/metaframe/

MultiCurrencies

Operações

Get multi virtual currencies balance

Pedido

Gets information about multi virtual currencies and shards balance.

Segurança
Bearer
Caminho
merchantIdstringobrigatório

Merchant ID of the client

projectIdstringobrigatório

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'

Respostas

Values of multi virtual crrencies balances.

Corpoapplication/json
itemsArray of objects(Balances)

List of multicurrency balances.

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

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

Topup user's multicurrency balance

Pedido

Top up user multicurrency balance.

Segurança
Server
Caminho
merchantIdstringobrigatório

Merchant ID of the client

projectIdstringobrigatório

Project ID of the project

Cabeçalhos
X-OPERATION-IDstring(UUID)= 36 charactersobrigatório

Unique operation ID.

X-HOST-IDstring(UUID)= 36 charactersobrigatório

Unique operator ID.

Corpoapplication/json
shardsinteger(int64)>= 1obrigatório

Number of Shards to topup.

Exemplo: 22
user_idstring(UUID)non-emptyobrigatório

Xsolla Account ID.

Exemplo: "b8fa3003-2448-49fb-bbe2-7f72f420e350"
virtual_currency_skustringnon-emptyobrigatório

Multicurrency SKU

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

Respostas

Operation successful

Corpoapplication/json
balanceobject
Exemplo: {"balance":1,"shards":5}
balance.​balanceinteger

Multicurrency balance.

Exemplo: 1
balance.​shardsinteger

Multicurrency Shards balance.

Exemplo: 5
Resposta
application/json
{
  "balance": {
    "balance": 1,
    "shards": 5
  }
}

Retrieve info about automatic purchase

Pedido

Retrieve information about automatic purchase.

Segurança
Server
Caminho
merchantIdstringobrigatório

Merchant ID of the client

projectIdstringobrigatório

Project ID of the project

userIdstring(UUID)= 36 charactersobrigatório

Unique User ID.

Cabeçalhos
X-HOST-IDstring(UUID)= 36 charactersobrigatório

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'

Respostas

Information about automatic purchase.

Corpoapplication/json
itemsArray of objects(Item)
Exemplo: [{"enabled":false,"virtual_currency_sku":"xxx-xxx-xxx"}]
items[].​enabledbooleanobrigatório

Whether automatic purchase of multicurrency is enabled for the user.

items[].​virtual_currency_skustringobrigatório

Virtual Currency SKU

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

Update info about automatic purchase

Pedido

Updates information about automatic purchase.

Segurança
Server
Caminho
merchantIdstringobrigatório

Merchant ID of the client

projectIdstringobrigatório

Project ID of the project

userIdstring(UUID)= 36 charactersobrigatório

Unique User ID.

Cabeçalhos
X-HOST-IDstring(UUID)= 36 charactersobrigatório

Unique operator ID.

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

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

items[].​virtual_currency_skustringobrigatório

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

Respostas

Information about automatic purchase.

Corpoapplication/json
itemsArray of objects(Item)
Exemplo: [{"enabled":false,"virtual_currency_sku":"xxx-xxx-xxx"}]
items[].​enabledbooleanobrigatório

Whether automatic purchase of multicurrency is enabled for the user.

items[].​virtual_currency_skustringobrigatório

Virtual Currency SKU

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

Charge

Operações

Package

Operações

Manual purchase

Operações