Passer au contenu
/
Définir des objets à des...

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.

Télécharger la description d'OpenAPI
index.json
index.yaml
Langues
Serveurs
Mock server
https://xsolla.redocly.app/_mock/fr/api/deprecated/inventory/
https://store.xsolla.com/api/

Client

Opérations

Gestion

Opérations

Octroyer des objets à des utilisateurs par achatsServer-sideAdmin

Requête

Ajoute des objets spécifiques aux inventaires des utilisateurs spécifiques en fonction de leurs achats.

Attention

Seules 50 opérations peuvent être traitées à la fois. Les opérations qui dépassent cette limite seront ignorées.
Sécurité
basicAuth
Chemin
project_idintegerobligatoire

ID de projet.

Par défaut 44056
Corpsapplication/jsonobligatoireArray [
commentstring[ 1 .. 255 ] characters

Description de l'opération. Par exemple : « Récompenses mensuelles. »

Par défaut "Monthly challenge rewards"
custom_parametersobject(Player-Inventory_custom_parameters)[ 1 .. 200 ] properties

Paramètres spécifiques au projet.

Exemple: {"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-emptyobligatoire
items[].​quantitynumberobligatoire

Nombre d'objets de cette classe à octroyer.

Par défaut 1
items[].​skustringobligatoire

Identifiant de la classe de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules, des points, des tirets et des traits bas.

Par défaut "booster_mega_1"
platformstring

Plateforme de publication sur laquelle l'utilisateur joue.

Par défaut "xsolla"
Enum"playstation_network""xbox_live""xsolla""pc_standalone""nintendo_shop""google_play""app_store_ios""android_standalone""ios_standalone""android_other"
purchaseobjectobligatoire
purchase.​amountstringobligatoire

Montant de l'achat avant toute déduction.

Par défaut "2.99"
purchase.​currencystringobligatoire

Devise d'achat selon la norme ISO 4217.

Par défaut "USD"
purchase.​external_purchase_datestringobligatoire

Date d'achat selon la norme ISO 8601.

Par défaut "2020-01-01T05:00:00+05:00"
purchase.​external_purchase_idstringobligatoire

Identifiant de facture de l'achat sur la plateforme sur laquelle l'achat a été effectué.

Par défaut "10-534-35"
userobjectobligatoire
user.​idstring

Identifiant unique de l'utilisateur sur la plateforme.

Par défaut "d342dad2-9d59-11e9-a384-42010aa8003f"
]
curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/fr/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"
        }
      }
    }
  ]'

Réponses

Achat de l'utilisateur effectué avec succès.

Corpsapplication/json
countinteger
Exemple: 10
operationsArray of objects
Réponse
application/json
{
  "count": 2,
  "operations": [
    { … },
    { … }
  ]
}

Révoquer des objets d'inventaireServer-sideAdmin

Requête

Révoque l'accès de plusieurs utilisateurs à des objets.

Attention

Seules 50 opérations peuvent être traitées à la fois. Les opérations qui dépassent cette limite seront ignorées.
Sécurité
basicAuth
Chemin
project_idintegerobligatoire

ID de projet.

Par défaut 44056
Corpsapplication/jsonobligatoireArray [
commentstring[ 1 .. 255 ] characters

Description de l'opération. Par exemple : « L'objet a été transféré à un autre joueur. »

Par défaut "Item was transferred to another player"
itemsArray of objectsnon-emptyobligatoire
items[].​quantityinteger>= 1obligatoire

Nombre d'objets de cette classe à révoquer.

Par défaut 1
items[].​skustringnon-emptyobligatoire

ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules et majuscules, des points, des tirets et des traits bas.

Par défaut "booster_mega_1"
platformstring

Plateforme de publication sur laquelle l'utilisateur joue.

Par défaut "xsolla"
Enum"playstation_network""xbox_live""xsolla""pc_standalone""nintendo_shop""google_play""app_store_ios""android_standalone""ios_standalone""android_other"
Exemple: "xsolla"
userobjectobligatoire
user.​idstring

Identifiant unique de l'utilisateur sur la plateforme.

Par défaut "d342dad2-9d59-11e9-a384-42010aa8003f"
]
curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/fr/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"
      }
    }
  ]'

Réponses

La révocation des objets des utilisateurs a été effectuée avec succès.

Corpsapplication/json
countinteger

Nombre d'utilisateurs dont les objets ont été révoqués avec succès.

Exemple: 10
operationsArray of objects

Description des opérations.

Réponse
application/json
{
  "count": 2,
  "operations": [
    { … },
    { … }
  ]
}

Octroyer des objets à des utilisateursServer-sideAdmin

Requête

Ajoute des objets spécifiques aux inventaires des utilisateurs spécifiques.

Attention

Seules 50 opérations peuvent être traitées à la fois. Les opérations qui dépassent cette limite seront ignorées.
Sécurité
basicAuth
Chemin
project_idintegerobligatoire

ID de projet.

Par défaut 44056
Corpsapplication/jsonobligatoireArray [
commentstring[ 1 .. 255 ] characters

Description de l'opération. Par exemple : « Récompenses mensuelles. »

Par défaut "Monthly challenge rewards"
itemsArray of objectsnon-emptyobligatoire
items[].​quantitynumberobligatoire

Nombre d'objets de cette classe à octroyer.

Par défaut 1
items[].​skustringobligatoire

Identifiant de la classe de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules, des points, des tirets et des traits bas.

Par défaut "booster_mega_1"
platformstring

Plateforme de publication sur laquelle l'utilisateur joue.

Par défaut "xsolla"
Enum"playstation_network""xbox_live""xsolla""pc_standalone""nintendo_shop""google_play""app_store_ios""android_standalone""ios_standalone""android_other"
userobjectobligatoire
user.​idstring

Identifiant unique de l'utilisateur sur la plateforme.

Par défaut "d342dad2-9d59-11e9-a384-42010aa8003f"
]
curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/fr/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"
      }
    }
  ]'

Réponses

Récompenses octroyées aux utilisateurs avec succès.

Corpsapplication/json
countinteger
Exemple: 10
operationsArray of objects
Réponse
application/json
{
  "count": 2,
  "operations": [
    { … },
    { … }
  ]
}

Définir des objets à des utilisateursServer-sideAdmin

Requête

Définit des objets spécifiques aux inventaires des utilisateurs spécifiques. Notez que les nouvelles données remplaceront les anciennes données.

Attention

Seules 50 opérations peuvent être traitées à la fois. Les opérations qui dépassent cette limite seront ignorées.
Sécurité
basicAuth
Chemin
project_idintegerobligatoire

ID de projet.

Par défaut 44056
Corpsapplication/jsonobligatoireArray [
commentstring[ 1 .. 255 ] characters

Description de l'opération. Par exemple : « Synchronisation mensuelle de l'inventaire. »

Par défaut "Monthly inventory syncing"
itemsArray of objectsnon-emptyobligatoire
items[].​quantitynumberobligatoire

Nombre d'objets de cette classe à octroyer.

Par défaut 1
items[].​skustringobligatoire

Identifiant de la classe de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules, des points, des tirets et des traits bas.

Par défaut "booster_mega_1"
platformstring

Plateforme de publication sur laquelle l'utilisateur joue.

Par défaut "xsolla"
Enum"playstation_network""xbox_live""xsolla""pc_standalone""nintendo_shop""google_play""app_store_ios""android_standalone""ios_standalone""android_other"
userobjectobligatoire
user.​idstring

Identifiant unique de l'utilisateur sur la plateforme.

Par défaut "d342dad2-9d59-11e9-a384-42010aa8003f"
]
curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/fr/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"
      }
    }
  ]'

Réponses

Réponse de succès.

Corpsapplication/json
countinteger
Exemple: 10
operationsArray of objects
Réponse
application/json
{
  "count": 2,
  "operations": [
    { … },
    { … }
  ]
}

Inventaire multiplateforme

Opérations