Passer au contenu

Metaverse Orbs API (1.0.0)

Metaverse Orbs API

Télécharger la description d'OpenAPI
index.json
index.yaml
Langues
Serveurs
Mock server
https://xsolla.redocly.app/_mock/fr/api/metaframe/
http://orbs.babka.com/

MultiCurrencies

Opérations

Get multi virtual currencies balance

Requête

Gets information about multi virtual currencies and shards balance.

Sécurité
Bearer
Chemin
merchantIdstringobligatoire

Merchant ID of the client

projectIdstringobligatoire

Project ID of the project

curl -i -X GET \
  'https://xsolla.redocly.app/_mock/fr/api/metaframe/v2/merchants/{merchantId}/projects/{projectId}/multicurrency-balance' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Réponses

Values of multi virtual crrencies balances.

Corpsapplication/json
itemsArray of objects(Balances)

List of multicurrency balances.

Exemple: [{"balance":14,"image_url":"https://imgurl.com","name":"Blue Orb Point","points":{"base":240,"point":80},"shards":2,"virtual_currency_sku":"xxxxx"}]
Réponse
application/json
{
  "items": [
    { … }
  ]
}

Topup user's multicurrency balance

Requête

Top up user multicurrency balance.

Sécurité
Server
Chemin
merchantIdstringobligatoire

Merchant ID of the client

projectIdstringobligatoire

Project ID of the project

En-têtes
X-OPERATION-IDstring(UUID)= 36 charactersobligatoire

Unique operation ID.

X-HOST-IDstring(UUID)= 36 charactersobligatoire

Unique operator ID.

Corpsapplication/json
shardsinteger(int64)>= 1obligatoire

Number of Shards to topup.

Exemple: 22
user_idstring(UUID)non-emptyobligatoire

Xsolla Account ID.

Exemple: "b8fa3003-2448-49fb-bbe2-7f72f420e350"
virtual_currency_skustringnon-emptyobligatoire

Multicurrency SKU

Exemple: "sapphire_point"
curl -i -X POST \
  'https://xsolla.redocly.app/_mock/fr/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"
  }'

Réponses

Operation successful

Corpsapplication/json
balanceobject
Exemple: {"balance":1,"shards":5}
Réponse
application/json
{
  "balance": {
    "balance": 1,
    "shards": 5
  }
}

Retrieve info about automatic purchase

Requête

Retrieve information about automatic purchase.

Sécurité
Server
Chemin
merchantIdstringobligatoire

Merchant ID of the client

projectIdstringobligatoire

Project ID of the project

userIdstring(UUID)= 36 charactersobligatoire

Unique User ID.

En-têtes
X-HOST-IDstring(UUID)= 36 charactersobligatoire

Unique operator ID.

curl -i -X GET \
  'https://xsolla.redocly.app/_mock/fr/api/metaframe/v2/merchants/{merchantId}/projects/{projectId}/user/{userId}/auto-topup' \
  -H 'X-HOST-ID: stringstringstringstringstringstring' \
  -H 'X-SERVER-AUTHORIZATION: YOUR_API_KEY_HERE'

Réponses

Information about automatic purchase.

Corpsapplication/json
itemsArray of objects(Item)
Exemple: [{"enabled":false,"virtual_currency_sku":"xxx-xxx-xxx"}]
Réponse
application/json
{
  "items": [
    { … }
  ]
}

Update info about automatic purchase

Requête

Updates information about automatic purchase.

Sécurité
Server
Chemin
merchantIdstringobligatoire

Merchant ID of the client

projectIdstringobligatoire

Project ID of the project

userIdstring(UUID)= 36 charactersobligatoire

Unique User ID.

En-têtes
X-HOST-IDstring(UUID)= 36 charactersobligatoire

Unique operator ID.

Corpsapplication/json
itemsArray of objects(Item)
Exemple: [{"enabled":false,"virtual_currency_sku":"xxx-xxx-xxx"}]
curl -i -X PUT \
  'https://xsolla.redocly.app/_mock/fr/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"
      }
    ]
  }'

Réponses

Information about automatic purchase.

Corpsapplication/json
itemsArray of objects(Item)
Exemple: [{"enabled":false,"virtual_currency_sku":"xxx-xxx-xxx"}]
Réponse
application/json
{
  "items": [
    { … }
  ]
}

Charge

Opérations

Package

Opérations

Manual purchase

Opérations