Passer au contenu

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
Langues
Serveurs
Mock server
https://xsolla.redocly.app/_mock/fr/api/shop-builder/
https://store.xsolla.com/api/
Opérations

Catalogue personnalisé

Cette API permet de spécifier des règles pour les attributs utilisateur. Si l'utilisateur remplit toutes les conditions d'une règle concrète, des objets personnalisés seront affichés.

Pour les promotions personnalisées, voir la section Promotions.

Pour passer des attributs avant un achat, utilisez Xsolla Login API ou passez-les dans la propriété user.attributes lors de la génération du jeton à l'aide de Pay Station API.

Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations

Catalogue

Cette API permet de récupérer tout type d'objet vendable ou tout objet spécifique.

Opérations
Opérations
Opérations
Opérations
Opérations
Opérations

Coupons

Cette API permet de gérer les coupons.

Opérations

Codes promo

Cette API permet de gérer les codes promo.

Opérations

Offres uniques du catalogue

Cette API permet de gérer les offres uniques du catalogue.

Opérations

Remises

Cette API permet de gérer les promotions par réduction

Opérations

Bonus

Cette API permet de gérer les promotions par bonus.

Opérations
Opérations
Opérations
Opérations

Créer une commande à partir d'un objet spécifique en monnaie virtuelleClient-side

Requête

Crée l'achat d'un objet en utilisant de la monnaie virtuelle.

Sécurité
XsollaLoginUserJWT
Chemin
project_idintegerobligatoire

ID de projet. Ce paramètre se trouve dans le Compte éditeur à côté du nom du projet.

Exemple: 44056
item_skustringobligatoire

UGS de l'objet.

Exemple: booster_mega_1
virtual_currency_skustringobligatoire

UGS de la monnaie virtuelle.

Exemple: crystal
Requête
platformstring

Plateforme de publication sur laquelle l'utilisateur joue : xsolla (par défaut), playstation_network, xbox_live, pc_standalone, nintendo_shop, google_play, app_store_ios, android_standalone, ios_standalone, android_other, ios_other, pc_other.

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"
Corpsapplication/json
custom_parametersobject or null(Cart-Payment_custom_parameters)[ 1 .. 200 ] properties

Vos paramètres personnalisés représentés sous la forme d'un JSON valide de paires clé-valeur.
Pour configurer des filtres anti-fraude, passez des paramètres supplémentaires via ce champ. Voir la documentation de Pay Station.

Exemple: {"custom_parameters":{"bool_param":true,"int_param":100,"null_param":null,"string_param":"example"}}
curl -i -X POST \
  'https://xsolla.redocly.app/_mock/fr/api/shop-builder/v2/project/44056/payment/item/booster_mega_1/virtual/crystal?platform=playstation_network' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "custom_parameters": {
      "array_param": [
        {
          "object1": {
            "param": "https://xsolla.com"
          },
          "property": {
            "int_property": 112,
            "string_property": "xsolla"
          }
        },
        {
          "object2": {
            "param": "https://developers.xsolla.com/fr"
          },
          "property": {
            "int_property": 112,
            "string_property": "email@example.com"
          }
        }
      ],
      "bool_param": true,
      "int_param": 100,
      "null_param": null,
      "object_param": {
        "key": "value"
      }
    }
  }'

Réponses

Achat rapide virtuel réussi.

Corpsapplication/json
order_idinteger

ID de commande.

Réponse
application/json
{ "order_id": 641 }
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations