Zum Inhalt springen

Shop Builder API (2.0.0)

Overview

  • Version: 2.0.0
  • Servers: https://store.xsolla.com/api
  • Contact Us by Email
  • Contact URL: https://xsolla.com/
  • Required TLS version: 1.2

Shop Builder API provides a third-party solution for implementing the server side for your store interface. Use the endpoints to manage in-game items, in-game currencies, cart, player inventory, promotions, game library, etc.

OpenAPI-Beschreibung herunterladen
index.json
index.yaml
Sprachen
Server
Mock server
https://xsolla.redocly.app/_mock/de/api/deprecated/inventory/
https://store.xsolla.com/api/

Client

Operationen

Verwaltung

Operationen

Benutzern gekaufte Artikel gewährenServer-sideAdmin

Anfrage

Fügt die angegebenen, gekauften Artikel dem angegebenen Benutzerinventaren hinzu.

Achtung

Es können nur 50 Vorgänge gleichzeitig verarbeitet werden. Vorgänge, die dieses Limit überschreiten, werden ignoriert.
Sicherheit
basicAuth
Pfad
project_idintegererforderlich

Projekt-ID.

Standard 44056
Bodyapplication/jsonerforderlichArray [
commentstring[ 1 .. 255 ] characters

Vorgangsbeschreibung. Zum Beispiel: „Belohnungen für monatliche Herausforderung“.

Standard "Monthly challenge rewards"
custom_parametersobject(Player-Inventory_custom_parameters)[ 1 .. 200 ] properties

Projektspezifische Parameter.

Beispiel: {"array_param":[{"user_device_info":{"engine_version":"Unity 2020.2.0b5","os":"windows"},"user_public_id":{"nickname":"player1"}},{"user_device_info":{"engine_version":"UE 4.25","os":"mac"},"user_public_id":{"nickname":"player1"}}],"bool_param":true,"int_param":100,"null_param":null,"object_param":{"key":"value"}}
itemsArray of objectsnon-emptyerforderlich
items[].​quantitynumbererforderlich

Anzahl der Artikel dieser Klasse, die gewährt werden müssen.

Standard 1
items[].​skustringerforderlich

Artikelklassenkennung. Die SKU darf nur lateinische alphanumerische Kleinbuchstaben, Punkte, Bindestriche und Unterstriche enthalten.

Standard "booster_mega_1"
platformstring

Publishing-Plattform, auf der der Benutzer spielt.

Standard "xsolla"
Enum"playstation_network""xbox_live""xsolla""pc_standalone""nintendo_shop""google_play""app_store_ios""android_standalone""ios_standalone""android_other"
purchaseobjecterforderlich
purchase.​amountstringerforderlich

Kaufbetrag vor Abzügen.

Standard "2.99"
purchase.​currencystringerforderlich

Kaufwährung gemäß ISO 4217.

Standard "USD"
purchase.​external_purchase_datestringerforderlich

Kaufdatum gemäß ISO 8601.

Standard "2020-01-01T05:00:00+05:00"
purchase.​external_purchase_idstringerforderlich

Rechnungskennung der Plattform, auf der der Kauf getätigt wurde.

Standard "10-534-35"
userobjecterforderlich
user.​idstring

Die eindeutige Benutzerkennung auf der Plattform.

Standard "d342dad2-9d59-11e9-a384-42010aa8003f"
]
curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/deprecated/inventory/v2/project/{project_id}/inventory/purchase' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "purchase": {
        "amount": "3.5",
        "comment": "xsolla",
        "currency": "USD",
        "custom_parameters": [
          {
            "user_device_info": {
              "engine_version": "Unity 2020.2.0b5",
              "os": "windows"
            },
            "user_public_id": {
              "nickname": "player1"
            }
          },
          {
            "comment": "xsolla",
            "custom_parameters": {
              "content_creator_rewards": [
                {
                  "content_creator": {
                    "id": "cc1"
                  },
                  "reward": {
                    "amount": "10.00",
                    "currency": "USD"
                  }
                },
                {
                  "content_creator": {
                    "id": "cc2"
                  },
                  "reward": {
                    "amount": "15.00",
                    "currency": "RUB"
                  }
                }
              ]
            },
            "items": [
              {
                "quantity": 5,
                "sku": "com.xsolla.panda_sdk3"
              },
              {
                "quantity": 3,
                "sku": "com.xsolla.panda_sdk2"
              }
            ],
            "platform": "xsolla",
            "purchase": {
              "amount": "3.5",
              "currency": "USD",
              "external_purchase_date": "2020-01-01T00:00:00+05:00",
              "external_purchase_id": "1000001"
            },
            "user": {
              "id": "83857636-65b4-11e8-9ccb-42010a8a001c"
            }
          }
        ],
        "external_purchase_date": "2020-01-01T00:00:00+05:00",
        "external_purchase_id": "1000000",
        "items": [
          {
            "quantity": 5,
            "sku": "com.xsolla.panda_sdk1"
          },
          {
            "quantity": 3,
            "sku": "com.xsolla.panda_sdk2"
          }
        ],
        "platform": "xsolla",
        "user": {
          "id": "672c91cd-65db-4b6e-ad68-6e93b21249d8"
        }
      }
    }
  ]'

Antworten

Erfolgreicher Benutzerkauf.

Bodyapplication/json
countinteger
Beispiel: 10
operationsArray of objects
Antwort
application/json
{
  "count": 2,
  "operations": [
    { … },
    { … }
  ]
}

Inventarartikel widerrufenServer-sideAdmin

Anfrage

Widerruft den Zugriff auf Artikel für mehrere Benutzer.

Achtung

Es können nur 50 Vorgänge gleichzeitig verarbeitet werden. Vorgänge, die dieses Limit überschreiten, werden ignoriert.
Sicherheit
basicAuth
Pfad
project_idintegererforderlich

Projekt-ID.

Standard 44056
Bodyapplication/jsonerforderlichArray [
commentstring[ 1 .. 255 ] characters

Operationsbeschreibung. Zum Beispiel: "Artikel wurde einem anderen Spieler übergeben".

Standard "Item was transferred to another player"
itemsArray of objectsnon-emptyerforderlich
items[].​quantityinteger>= 1erforderlich

Anzahl der Artikel dieser Klasse, die widerrufen werden mussten.

Standard 1
items[].​skustringnon-emptyerforderlich

Eindeutige Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten.

Standard "booster_mega_1"
platformstring

Publishing-Plattform, auf der der Benutzer spielt.

Standard "xsolla"
Enum"playstation_network""xbox_live""xsolla""pc_standalone""nintendo_shop""google_play""app_store_ios""android_standalone""ios_standalone""android_other"
Beispiel: "xsolla"
userobjecterforderlich
user.​idstring

Die eindeutige Benutzerkennung auf der Plattform.

Standard "d342dad2-9d59-11e9-a384-42010aa8003f"
]
curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/deprecated/inventory/v2/project/{project_id}/inventory/revoke' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "comment": "Item was transferred to another player",
      "items": [
        {
          "quantity": 1,
          "sku": "booster_mega_1"
        }
      ],
      "platform": "xsolla",
      "user": {
        "id": "d342dad2-9d59-11e9-a384-42010aa8003f"
      }
    }
  ]'

Antworten

Widerruf der Benutzerartikel erfolgreich.

Bodyapplication/json
countinteger

Anzahl der Benutzer, deren Artikel erfolgreich widerrufen wurden.

Beispiel: 10
operationsArray of objects

Vorgangsbeschreibung.

Antwort
application/json
{
  "count": 2,
  "operations": [
    { … },
    { … }
  ]
}

Benutzern Artikel gewährenServer-sideAdmin

Anfrage

Fügt die angegebenen Artikel dem angegebenen Benutzerinventaren hinzu.

Achtung

Es können nur 50 Vorgänge gleichzeitig verarbeitet werden. Vorgänge, die dieses Limit überschreiten, werden ignoriert.
Sicherheit
basicAuth
Pfad
project_idintegererforderlich

Projekt-ID.

Standard 44056
Bodyapplication/jsonerforderlichArray [
commentstring[ 1 .. 255 ] characters

Vorgangsbeschreibung. Zum Beispiel: „Belohnungen für monatliche Herausforderung“.

Standard "Monthly challenge rewards"
itemsArray of objectsnon-emptyerforderlich
items[].​quantitynumbererforderlich

Anzahl der Artikel dieser Klasse, die gewährt werden müssen.

Standard 1
items[].​skustringerforderlich

Artikelklassenkennung. Die SKU darf nur lateinische alphanumerische Kleinbuchstaben, Punkte, Bindestriche und Unterstriche enthalten.

Standard "booster_mega_1"
platformstring

Publishing-Plattform, auf der der Benutzer spielt.

Standard "xsolla"
Enum"playstation_network""xbox_live""xsolla""pc_standalone""nintendo_shop""google_play""app_store_ios""android_standalone""ios_standalone""android_other"
userobjecterforderlich
user.​idstring

Die eindeutige Benutzerkennung auf der Plattform.

Standard "d342dad2-9d59-11e9-a384-42010aa8003f"
]
curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/deprecated/inventory/v2/project/{project_id}/inventory/reward' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "comment": "Monthly challenge rewards",
      "items": [
        {
          "quantity": 1,
          "sku": "booster_mega_1"
        }
      ],
      "platform": "playstation_network",
      "user": {
        "id": "d342dad2-9d59-11e9-a384-42010aa8003f"
      }
    }
  ]'

Antworten

Erfolgreiche Benutzerbelohnung.

Bodyapplication/json
countinteger
Beispiel: 10
operationsArray of objects
Antwort
application/json
{
  "count": 2,
  "operations": [
    { … },
    { … }
  ]
}

Artikel für Benutzer festlegenServer-sideAdmin

Anfrage

Legt angegebene Artikel für angegebene Benutzerinventare fest. Beachten Sie, dass neue Daten alte Daten ersetzen.

Achtung

Es können nur 50 Vorgänge gleichzeitig verarbeitet werden. Vorgänge, die dieses Limit überschreiten, werden ignoriert.
Sicherheit
basicAuth
Pfad
project_idintegererforderlich

Projekt-ID.

Standard 44056
Bodyapplication/jsonerforderlichArray [
commentstring[ 1 .. 255 ] characters

Vorgangsbeschreibung. Beispiel: "Monatliche Inventarsynchronisierung".

Standard "Monthly inventory syncing"
itemsArray of objectsnon-emptyerforderlich
items[].​quantitynumbererforderlich

Anzahl der Artikel dieser Klasse, die gewährt werden müssen.

Standard 1
items[].​skustringerforderlich

Artikelklassenkennung. Die SKU darf nur lateinische alphanumerische Kleinbuchstaben, Punkte, Bindestriche und Unterstriche enthalten.

Standard "booster_mega_1"
platformstring

Publishing-Plattform, auf der der Benutzer spielt.

Standard "xsolla"
Enum"playstation_network""xbox_live""xsolla""pc_standalone""nintendo_shop""google_play""app_store_ios""android_standalone""ios_standalone""android_other"
userobjecterforderlich
user.​idstring

Die eindeutige Benutzerkennung auf der Plattform.

Standard "d342dad2-9d59-11e9-a384-42010aa8003f"
]
curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/deprecated/inventory/v2/project/{project_id}/inventory/set' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "comment": "Monthly inventory syncing",
      "items": [
        {
          "quantity": 1,
          "sku": "booster_mega_1"
        }
      ],
      "platform": "playstation_network",
      "user": {
        "id": "d342dad2-9d59-11e9-a384-42010aa8003f"
      }
    }
  ]'

Antworten

Erfolgreiche Antwort.

Bodyapplication/json
countinteger
Beispiel: 10
operationsArray of objects
Antwort
application/json
{
  "count": 2,
  "operations": [
    { … },
    { … }
  ]
}

Inventarübergreifend

Operationen