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

Requête

Supprime une région spécifique.

Sécurité
basicAuth
Chemin
project_idintegerobligatoire

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

Exemple: 44056
region_idintegerobligatoire

ID de la région. Identifiant unique de la région au sein du projet.

Exemple: 42
curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/fr/api/shop-builder/v2/project/44056/admin/region/42

Réponses

La région a été supprimée avec succès.

Corps
Réponse
Aucun contenu

Requête

Récupère des informations sur une région spécifique.

Utilisez les régions pour gérer les restrictions régionales.

Sécurité
basicAuth
Chemin
project_idintegerobligatoire

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

Exemple: 44056
region_idintegerobligatoire

ID de la région. Identifiant unique de la région au sein du projet.

Exemple: 42
curl -i -X GET \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/fr/api/shop-builder/v2/project/44056/admin/region/42

Réponses

La région spécifiée a été reçue avec succès.

Corpsapplication/json
countriesArray of strings(Regions_countries)

Liste des pays à ajouter dans une région.
Code de pays à deux lettres majuscules selon la norme ISO 3166-1 alpha-2. Consultez la documentation pour obtenir des informations détaillées sur les pays pris en charge par Xsolla.
Exemple : ["JP", "CN", "VN"]

idinteger(Regions_region_id)

ID de la région. Identifiant unique de la région au sein du projet.

Exemple: 42
nameobject(Regions_name)

Nom de la région. Doit comprendre des paires clé/valeur, où la clé est une région au format "^[a-z]{2}-[A-Z]{2}$", la valeur est une chaîne.

Par défaut {"de-DE":"Asien","en-US":"Asia"}
Exemple: {"de-DE":"Asien","en-US":"Asia"}
Réponse
application/json
{ "value": { "countries": [], "id": 44, "name": {} } }

Mettre à jour une régionServer-sideAdmin

Requête

Met à jour les informations sur une région spécifique.

Utilisez les régions pour gérer les restrictions régionales.

Sécurité
basicAuth
Chemin
project_idintegerobligatoire

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

Exemple: 44056
region_idintegerobligatoire

ID de la région. Identifiant unique de la région au sein du projet.

Exemple: 42
Corpsapplication/json
countriesArray of strings(Regions_countries)obligatoire

Liste des pays à ajouter dans une région.
Code de pays à deux lettres majuscules selon la norme ISO 3166-1 alpha-2. Consultez la documentation pour obtenir des informations détaillées sur les pays pris en charge par Xsolla.
Exemple : ["JP", "CN", "VN"]

nameobject(Regions_name)obligatoire

Nom de la région. Doit comprendre des paires clé/valeur, où la clé est une région au format "^[a-z]{2}-[A-Z]{2}$", la valeur est une chaîne.

Par défaut {"de-DE":"Asien","en-US":"Asia"}
Exemple: {"de-DE":"Asien","en-US":"Asia"}
name.​property name*stringpropriété supplémentaire
curl -i -X PUT \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/fr/api/shop-builder/v2/project/44056/admin/region/42 \
  -H 'Content-Type: application/json' \
  -d '{
    "countries": [
      "JP",
      "CN",
      "VN"
    ],
    "name": {
      "de-DE": "Asien",
      "en-US": "Asia"
    }
  }'

Réponses

La région a été mise à jour avec succès.

Corps
Réponse
Aucun contenu
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
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations
Opérations