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

Paiement (côté client)

Opérations

Paiement (côté serveur)

Opérations

Commande

Opérations

Biens gratuits

Opérations

Gestion

Opérations

Actualiser toutes les limites d'achat pour un utilisateur spécifiqueServer-sideAdmin

Requête

Actualise toutes les limites d'achat de tous les objets pour un utilisateur spécifique afin qu'il puisse à nouveau acheter ces objets.

L'API des limites utilisateur vous permet de vendre un objet en quantité limitée. Pour configurer les limites d'achat, accédez à la section Administrateur du module du type d'objet souhaité :

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
Corpsapplication/json
userobject(User-limit_user)obligatoire
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$obligatoire

External ID de l'utilisateur

curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/fr/api/catalog/v2/project/44056/admin/user/limit/item/all \
  -H 'Content-Type: application/json' \
  -d '{
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    }
  }'

Réponses

La limite a été actualisée avec succès.

Réponse
Aucun contenu

Réduire le nombre d'objets offerts pour un utilisateur spécifiqueServer-sideAdmin

Requête

Réduit le nombre restant d'objets offerts pour un utilisateur spécifique dans la limite appliquée.

L'API des limites utilisateur vous permet de vendre un objet en quantité limitée. Pour configurer les limites d'achat, accédez à la section Administrateur du module du type d'objet souhaité :

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
item_skustringobligatoire

UGS de l'objet.

Exemple: booster_mega_1
Corpsapplication/json
availableinteger(User-limit_available)>= 1obligatoire

Nombre restant d'objets ou d'utilisations de la promotion disponibles pour l'utilisateur dans la limite appliquée.

userobject(User-limit_user)obligatoire
user.​user_external_idstring(User-limit_user-external-id)non-empty^\S+$obligatoire

External ID de l'utilisateur

curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/fr/api/catalog/v2/project/44056/admin/user/limit/item/sku/booster_mega_1 \
  -H 'Content-Type: application/json' \
  -d '{
    "available": 1,
    "user": {
      "user_external_id": "d342dad2-9d59-11e9-a384-42010aa8003f"
    }
  }'

Réponses

Les limites d'achat pour un utilisateur ont été reçues avec succès.

Corpsapplication/json
per_userobject
Réponse
application/json
{
  "per_user": {
    "available": 9,
    "total": 10
  }
}

Lire le nombre d'objets offerts pour un utilisateur spécifiqueServer-sideAdmin

Requête

Récupère le nombre restant d'objets disponibles pour un utilisateur spécifique dans la limite appliquée.

L'API des limites utilisateur vous permet de vendre un objet en quantité limitée. Pour configurer les limites d'achat, accédez à la section Administrateur du module du type d'objet souhaité :

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
item_skustringobligatoire

UGS de l'objet.

Exemple: booster_mega_1
Requête
user_external_idstringobligatoire

External ID de l'utilisateur

Exemple: user_external_id=d342dad2-9d59-11e9-a384-42010aa8003f
curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/fr/api/catalog/v2/project/44056/admin/user/limit/item/sku/booster_mega_1?user_external_id=d342dad2-9d59-11e9-a384-42010aa8003f'

Réponses

Les limites d'achat pour un utilisateur ont été reçues avec succès.

Corpsapplication/json
per_userobject
Réponse
application/json
{
  "per_user": {
    "available": 9,
    "total": 10
  }
}

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