Zum Inhalt springen

Metaverse Orbs API (1.0.0)

Metaverse Orbs API

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

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 \
  'https://xsolla.redocly.app/_mock/de/api/metaframe/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"}]
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 \
  'https://xsolla.redocly.app/_mock/de/api/metaframe/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}
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 \
  'https://xsolla.redocly.app/_mock/de/api/metaframe/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"}]
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"}]
curl -i -X PUT \
  'https://xsolla.redocly.app/_mock/de/api/metaframe/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"}]
Antwort
application/json
{
  "items": [
    { … }
  ]
}

Charge

Operationen

Package

Operationen

Manual purchase

Operationen