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

Administrateur

Opérations

Lire le statut de l'importation d'objetsServer-sideAdmin

Requête

Récupère des informations sur la progression de l'importation d'objets dans le projet. Cet appel API récupère des données sur la dernière importation effectuée par le biais de l'API ou du Compte éditeur.

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
curl -i -X GET \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/fr/api/catalog/v1/admin/projects/44056/connectors/import_items/import/status

Réponses

Statut d'importation récupéré avec succès.

Corpsapplication/json
date_completedstring

Heure de fin de l'opération d'importation dans le fuseau horaire GMT+3. Si une erreur interrompt le processus et qu'aucun élément n'est importé, une chaîne vide sera renvoyée.

Exemple: "2024-11-19T15:27:31+03:00"
date_createdstring

Date de création de l'opération d'importation dans le fuseau horaire GMT+3.

Exemple: "2024-11-19T14:27:31+03:00"
date_updatedstring

Date d'interruption de l'importation en raison d'une erreur dans le fuseau horaire GMT+3.

Exemple: "2024-11-19T15:27:31+03:00"
errorstring

Description de l'erreur générale d'importation.

error_codestring

Code de l'erreur générale d'importation.

progressinteger

État d'avancement de l'exécution de l'importation en pourcentage.

Exemple: 100
resultobject

Objet contenant des données sur les résultats et les erreurs d'importation pour chaque UGS spécifique.

Exemple: {"errors_by_sku":[{"error_code":4055,"error_message":"[0401-4055]: Item default price not set","sku":"com.xsolla.sword_1","type":"virtual_items"},{"error_code":1817,"error_message":"[0410-1817]: SKU can't be empty","sku":"","type":null}],"errors_count":2,"total_entities_count":10}
statusstring

Statut d'importation.

Enum ValeurDescription
done

Importation réussi.

error

L'importation a échoué ou n'a été réalisée que partiellement en raison d'erreurs.

initialized

Importation initiée.

process

Importation est en cours.

Exemple: "error"
Réponse
application/json
{
  "date_completed": "2024-11-19T15:27:31+03:00",
  "date_created": "2024-11-19T14:27:31+03:00",
  "date_updated": "2024-11-19T15:27:31+03:00",
  "error": null,
  "error_code": null,
  "progress": 100,
  "result": {
    "errors_by_sku": [ … ],
    "errors_count": 2,
    "total_entities_count": 10
  },
  "status": "error"
}

Importer des objets via un fichier JSONServer-sideAdmin

Requête

Importe des objets dans le magasin à partir d'un fichier JSON via l'URL spécifiée. Pour plus d'informations, consultez la documentation.

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
connector_external_idstringobligatoire

Valeur fixe déterminant le type d'opération pour l'importation d'objets.

Valeur"import_items"
file_urlstringobligatoire

URL d'un fichier contenant des données au format JSON. Le fichier doit être hébergé sur un service de stockage à accès public. Téléchargez le modèle de fichier dans le Compte éditeur dans la section Store > Virtual Items > Catalog Management > Import Items (JSON).

Exemple: "https://my-bucket.s3.amazonaws.com/items.json"
modestring

Actions d'importation :

Par défaut "create_and_update"
Enum ValeurDescription
create

Ajouter de nouveaux objets.

create_and_update

Ajouter de nouveaux objets et mettre à jour les objets existants.

sync

Ajouter de nouveaux objets, mettre à jour les objets existants et désactiver les objets manquants.

curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/fr/api/catalog/v1/projects/44056/import/from_external_file \
  -H 'Content-Type: application/json' \
  -d '{
    "connector_external_id": "import_items",
    "file_url": "https://my-bucket.s3.amazonaws.com/items.json",
    "mode": "create"
  }'

Réponses

Fichier importé avec succès, traitement en cours.

Corpsapplication/json
import_idstring

ID de l'opération d'importation. Si vous rencontrez des difficultés lors de l'importation du fichier JSON, signalez cet ID à votre responsable de la réussite client ou envoyez un e-mail à csm@xsolla.com.

Exemple: "af9f3638a16e11ef880da2cd677d2d24"
Réponse
application/json
{
  "import_id": "af9f3638a16e11ef880da2cd677d2d24"
}

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