Statut d'importation.
Catalog API (2.0.0)
- Version : 2.0.0
- Serveurs :
https://store.xsolla.com/api - Contactez-nous par e-mail
- **URL de contact :**https://xsolla.com/
- Version TLS requise : 1.2
L’API Catalog permet de configurer un catalogue des objets en jeu côté Xsolla et de l’afficher aux utilisateurs dans votre magasin.
L’API permet de gérer les entités de catalogue suivantes :
- Objets virtuels — objets en jeu tels que armes, skins, boosters.
- Monnaie virtuelle — monnaie utilisée pour acheter des objets virtuels.
- Packages de monnaie virtuelle — lots prédéfinis de monnaie virtuelle.
- Lots — packages combinant objets virtuels, monnaie virtuelle ou clés de jeu vendus sous un seul UGS.
- Clés de jeu — clés pour jeux et DLC distribuées via Steam ou d’autres fournisseurs DRM.
- Groupes — regroupements logiques pour organiser et trier les éléments du catalogue.
L’API est divisée en groupes suivants :
Admin — appels pour créer, mettre à jour, supprimer et configurer les objets et groupes du catalogue. Authentification via l’authentification d’accès de base avec vos identifiants marchand ou projet. Non destinés à un usage côté magasin.Catalog — appels pour récupérer des objets et construire des vitrines personnalisées pour les utilisateurs finaux. Conçue pour gérer des charges importantes. Supporte l’autorisation optionnelle par JWT utilisateur pour retourner des données personnalisées telles que des limites spécifiques à l’utilisateur et des promotions actives.
Télécharger la description d'OpenAPI
Langues
Serveurs
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/fr/api/catalog/
Chemin
ID de projet. Ce paramètre se trouve dans le Compte éditeur à côté du nom du projet.
Exemple: 44056
- https://connector.xsolla.com/v1/admin/projects/{project_id}/connectors/import_items/import/status
- Mock serverhttps://xsolla.redocly.app/_mock/fr/api/catalog/v1/admin/projects/{project_id}/connectors/import_items/import/status
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
-u <username>:<password> \
https://connector.xsolla.com/v1/admin/projects/44056/connectors/import_items/import/statusStatut d'importation récupéré avec succès.
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 de création de l'opération d'importation dans le fuseau horaire GMT+3.
Exemple: "2024-11-19T14:27:31+03:00"
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"
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}
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" }
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
Corpsapplication/jsonID de projet. Ce paramètre se trouve dans le Compte éditeur à côté du nom du projet.
Exemple: 44056
Valeur fixe déterminant le type d'opération pour l'importation d'objets.
Valeur"import_items"
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"
Actions d'importation :
Par défaut "create_and_update"
| Enum Valeur | Description |
|---|---|
| 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. |
- https://connector.xsolla.com/v1/projects/{project_id}/import/from_external_file
- Mock serverhttps://xsolla.redocly.app/_mock/fr/api/catalog/v1/projects/{project_id}/import/from_external_file
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://connector.xsolla.com/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éponse
application/json
{ "import_id": "af9f3638a16e11ef880da2cd677d2d24" }