Passer au contenu

Catalog 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

Catalog API fournit des endpoints pour gérer le catalogue de votre boutique en jeu et traiter les achats. Utilisez les endpoints pour configurer des objets virtuels, des monnaies virtuelles, des clés de jeu, des lots, des flux de panier et de paiement, des attributs d'articles et pour importer des articles depuis des sources externes.

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

Administrateur

Opérations

Catalogue

Opérations

Paiement virtuel

Opérations

Catalogue

Opérations

Droit

Opérations

Administrateur

Opérations

Administrateur

Opérations

Catalogue

Opérations

Panier (côté client)

Opérations

Panier (côté serveur)

Opérations

Remplir le panier d'objetsServer-side

Requête

Remplit d'objets le panier actuel. Si le panier contient déjà un objet avec la même UGS, l'objet existant sera remplacé par la valeur passée.

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
Requête
localestring

Langue de la réponse. Code de langue à deux lettres minuscules selon la norme ISO 639-1.

Par défaut "en"
En-têtes
x-user-forstring

L'identifiant de l'utilisateur peut être passé en utilisant le JWT utilisateur Xsolla Login ou le jeton d'accès Pay Station.

Exemple: ACCESS_TOKEN/LOGIN_JWT
x-user-idstring<= 32 characters

Vous pouvez utiliser votre propre ID utilisateur lorsque vous vendez un panier contenant des jeux.

Exemple: UNIQUE_ID
Corpsapplication/json
countrystring= 2 characters

Code 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 : country=US

Exemple: "US"
currencystring= 3 characters

Devise du prix de l'objet affiché dans le panier. Code de devise à trois lettres selon ISO 4217. Consultez la documentation pour obtenir des informations détaillées sur les devises prises en charge par Xsolla.

Exemple: "USD"
itemsArray of objectsnon-emptyobligatoire
items[].​quantitynumber>= 1obligatoire

Quantité de l'objet.

Exemple: 2
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.

Exemple: "t-shirt"
curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/fr/api/catalog/v2/admin/project/44056/cart/fill?locale=en' \
  -H 'Content-Type: application/json' \
  -H 'x-user-for: ACCESS_TOKEN/LOGIN_JWT' \
  -H 'x-user-id: UNIQUE_ID' \
  -d '{
    "currency": "USD",
    "items": [
      {
        "quantity": 2,
        "sku": "com.xsolla.cup01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.t-shirt01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.cup01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.hat01"
      }
    ]
  }'

Réponses

Le panier contenant des objets a été renvoyé avec succès.

Corpsapplication/json
cart_idstring

ID de panier. Passez-le à la requête pour la page d'achat ou aux endpoints de l'API de paiement.

Exemple: "cart_id"
is_freeboolean(value-cart_is_free)

Si ce paramètre est défini sur true, le panier est gratuit.

Par défaut false
Exemple: false
itemsArray of objects
priceobject or null

Prix du panier.

promotionsArray of objects(Catalog_cart_promotions)

Promotions appliquées à l'ensemble du panier. Le tableau est renvoyé dans les cas suivants :

  • Une promotion affecte le montant total du panier, comme un code promo avec le paramètre Discount on purchase.

  • Une promotion ajoute des objets bonus au panier.

Si aucune promotion de ce type n’est appliquée, un tableau vide est renvoyé.

warningsArray of objects
Réponse
application/json
{
  "cart_id": "cart_id",
  "is_free": false,
  "items": [
    { … },
    { … },
    { … }
  ],
  "price": {
    "amount": "15.97",
    "amount_without_discount": "22.96",
    "currency": "USD"
  },
  "promotions": [
    { … }
  ],
  "warnings": [
    { … }
  ]
}

Remplir le panier d'objets par ID de panierServer-side

Requête

Remplit d'objets le panier par son ID. Si le panier contient déjà un objet avec la même UGS, l'objet existant sera remplacé par la valeur passée.

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
cart_idstringobligatoire

ID de panier.

Exemple: custom_id
Requête
localestring

Langue de la réponse. Code de langue à deux lettres minuscules selon la norme ISO 639-1.

Par défaut "en"
En-têtes
x-user-forstring

L'identifiant de l'utilisateur peut être passé en utilisant le JWT utilisateur Xsolla Login ou le jeton d'accès Pay Station.

Exemple: ACCESS_TOKEN/LOGIN_JWT
x-user-idstring<= 32 characters

Vous pouvez utiliser votre propre ID utilisateur lorsque vous vendez un panier contenant des jeux.

Exemple: UNIQUE_ID
Corpsapplication/json
countrystring= 2 characters

Code 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 : country=US

Exemple: "US"
currencystring= 3 characters

Devise du prix de l'objet affiché dans le panier. Code de devise à trois lettres selon ISO 4217. Consultez la documentation pour obtenir des informations détaillées sur les devises prises en charge par Xsolla.

Exemple: "USD"
itemsArray of objectsnon-emptyobligatoire
items[].​quantitynumber>= 1obligatoire

Quantité de l'objet.

Exemple: 2
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.

Exemple: "t-shirt"
curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/fr/api/catalog/v2/admin/project/44056/cart/custom_id/fill?locale=en' \
  -H 'Content-Type: application/json' \
  -H 'x-user-for: ACCESS_TOKEN/LOGIN_JWT' \
  -H 'x-user-id: UNIQUE_ID' \
  -d '{
    "currency": "USD",
    "items": [
      {
        "quantity": 2,
        "sku": "com.xsolla.cup01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.t-shirt01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.cup01"
      },
      {
        "quantity": 1,
        "sku": "com.xsolla.hat01"
      }
    ]
  }'

Réponses

Le panier contenant des objets a été renvoyé avec succès.

Corpsapplication/json
cart_idstring

ID de panier. Passez-le à la requête pour la page d'achat ou aux endpoints de l'API de paiement.

Exemple: "cart_id"
is_freeboolean(value-cart_is_free)

Si ce paramètre est défini sur true, le panier est gratuit.

Par défaut false
Exemple: false
itemsArray of objects
priceobject or null

Prix du panier.

promotionsArray of objects(Catalog_cart_promotions)

Promotions appliquées à l'ensemble du panier. Le tableau est renvoyé dans les cas suivants :

  • Une promotion affecte le montant total du panier, comme un code promo avec le paramètre Discount on purchase.

  • Une promotion ajoute des objets bonus au panier.

Si aucune promotion de ce type n’est appliquée, un tableau vide est renvoyé.

warningsArray of objects
Réponse
application/json
{
  "cart_id": "cart_id",
  "is_free": false,
  "items": [
    { … },
    { … },
    { … }
  ],
  "price": {
    "amount": "15.97",
    "amount_without_discount": "22.96",
    "currency": "USD"
  },
  "promotions": [
    { … }
  ],
  "warnings": [
    { … }
  ]
}

Paiement (côté client)

Opérations

Paiement (côté serveur)

Opérations

Commande

Opérations

Biens gratuits

Opérations

Gestion

Opérations

Administrateur

Opérations

Webhooks

Opérations

Pré-commandes

Opérations

Commerçant

Opérations

Catalogue

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

Opérations

Régions communes

Opérations

Administrateur

Opérations