Saltar al contenido

Metaverse Orbs API (1.0.0)

Metaverse Orbs API

Descargar descripción de OpenAPI
index.json
index.yaml
Idiomas
Servidores
http://orbs.babka.com/
Mock server
https://xsolla.redocly.app/_mock/es/api/metaframe/

MultiCurrencies

Operaciones

Get multi virtual currencies balance

Solicitud

Gets information about multi virtual currencies and shards balance.

Seguridad
Bearer
Ruta
merchantIdstringrequerido

Merchant ID of the client

projectIdstringrequerido

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'

Respuestas

Values of multi virtual crrencies balances.

Cuerpoapplication/json
itemsArray of objects(Balances)

List of multicurrency balances.

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

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

Topup user's multicurrency balance

Solicitud

Top up user multicurrency balance.

Seguridad
Server
Ruta
merchantIdstringrequerido

Merchant ID of the client

projectIdstringrequerido

Project ID of the project

Encabezados
X-OPERATION-IDstring(UUID)= 36 charactersrequerido

Unique operation ID.

X-HOST-IDstring(UUID)= 36 charactersrequerido

Unique operator ID.

Cuerpoapplication/json
shardsinteger(int64)>= 1requerido

Number of Shards to topup.

Ejemplo: 22
user_idstring(UUID)non-emptyrequerido

Xsolla Account ID.

Ejemplo: "b8fa3003-2448-49fb-bbe2-7f72f420e350"
virtual_currency_skustringnon-emptyrequerido

Multicurrency SKU

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

Respuestas

Operation successful

Cuerpoapplication/json
balanceobject
Ejemplo: {"balance":1,"shards":5}
balance.​balanceinteger

Multicurrency balance.

Ejemplo: 1
balance.​shardsinteger

Multicurrency Shards balance.

Ejemplo: 5
Respuesta
application/json
{
  "balance": {
    "balance": 1,
    "shards": 5
  }
}

Retrieve info about automatic purchase

Solicitud

Retrieve information about automatic purchase.

Seguridad
Server
Ruta
merchantIdstringrequerido

Merchant ID of the client

projectIdstringrequerido

Project ID of the project

userIdstring(UUID)= 36 charactersrequerido

Unique User ID.

Encabezados
X-HOST-IDstring(UUID)= 36 charactersrequerido

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'

Respuestas

Information about automatic purchase.

Cuerpoapplication/json
itemsArray of objects(Item)
Ejemplo: [{"enabled":false,"virtual_currency_sku":"xxx-xxx-xxx"}]
items[].​enabledbooleanrequerido

Whether automatic purchase of multicurrency is enabled for the user.

items[].​virtual_currency_skustringrequerido

Virtual Currency SKU

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

Update info about automatic purchase

Solicitud

Updates information about automatic purchase.

Seguridad
Server
Ruta
merchantIdstringrequerido

Merchant ID of the client

projectIdstringrequerido

Project ID of the project

userIdstring(UUID)= 36 charactersrequerido

Unique User ID.

Encabezados
X-HOST-IDstring(UUID)= 36 charactersrequerido

Unique operator ID.

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

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

items[].​virtual_currency_skustringrequerido

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

Respuestas

Information about automatic purchase.

Cuerpoapplication/json
itemsArray of objects(Item)
Ejemplo: [{"enabled":false,"virtual_currency_sku":"xxx-xxx-xxx"}]
items[].​enabledbooleanrequerido

Whether automatic purchase of multicurrency is enabled for the user.

items[].​virtual_currency_skustringrequerido

Virtual Currency SKU

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

Charge

Operaciones

Package

Operaciones

Manual purchase

Operaciones