ID unique du DRM.
- Lire la liste des jeux qu'un utilisateur détient
Accorder un droit (administrateur)
Révoquer un droit (administrateur)
Échanger un code de jeu côté client
Lire la liste des jeux qu...
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
Corpsapplication/jsonobligatoireID de projet. Ce paramètre se trouve dans le Compte éditeur à côté du nom du projet.
Exemple: 44056
Objet contenant des propriétés du DRM.
Exemple: {"sku":"com.xsolla.key_1"}
Objet contenant des propriétés de jeu.
Exemple: {"sku":"com.xsolla.game_1"}
Quel type de droit doit être retiré. Si le paramètre est défini sur sandbox, le droit est retiré à l'utilisateur en mode bac à sable. Si le paramètre est défini sur default, le droit est retiré à l'utilisateur en mode de production.
Enum"default""sandbox"
Exemple: "default"
- https://store.xsolla.com/api/v2/project/{project_id}/admin/entitlement/revoke
- Mock serverhttps://xsolla.redocly.app/_mock/fr/api/catalog/v2/project/{project_id}/admin/entitlement/revoke
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
-u <username>:<password> \
https://store.xsolla.com/api/v2/project/44056/admin/entitlement/revoke \
-H 'Content-Type: application/json' \
-d '{
"drm": {
"sku": "com.xsolla.key_1"
},
"game": {
"sku": "com.xsolla.game_1"
},
"mode": "default",
"user_external_id": "user-external-id"
}'Requête
Récupère la liste des jeux que l'utilisateur détient. La réponse contiendra un tableau de jeux qu'un utilisateur spécifique détient.
Attention
Tous les projets sont soumis à une limite de nombre d'objets que vous pouvez obtenir dans la réponse. La valeur par défaut et la valeur maximale sont 10 éléments par réponse. Pour obtenir plus de données page par page, utilisez les champs limit et offset.
Tous les projets sont soumis à une limite de nombre d'objets que vous pouvez obtenir dans la réponse. La valeur par défaut et la valeur maximale sont 10 éléments par réponse. Pour obtenir plus de données page par page, utilisez les champs limit et offset.
Sécurité
XsollaLoginUserJWT
Chemin
ID de projet. Ce paramètre se trouve dans le Compte éditeur à côté du nom du projet.
Exemple: 44056
Requête
Numéro de l'élément à partir duquel la liste est générée (le décompte commence à 0).
Exemple: offset=0
Quel type de droits doit être renvoyé. Si le paramètre est défini sur 1, les droits reçus par l'utilisateur en mode bac à sable sont renvoyés. Si le paramètre n'est pas passé ou est défini sur 0, les droits reçus par l'utilisateur en mode de production sont renvoyés.
Par défaut 0
- https://store.xsolla.com/api/v2/project/{project_id}/entitlement
- Mock serverhttps://xsolla.redocly.app/_mock/fr/api/catalog/v2/project/{project_id}/entitlement
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://store.xsolla.com/api/v2/project/44056/entitlement?limit=50&offset=0&sandbox=0&additional_fields%5B%5D=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Réponse
application/json
{ "has_more": false, "items": [ { … } ], "total_items_count": 1 }
Chemin
Corpsapplication/jsonobligatoireID de projet. Ce paramètre se trouve dans le Compte éditeur à côté du nom du projet.
Exemple: 44056
- https://store.xsolla.com/api/v2/project/{project_id}/entitlement/redeem
- Mock serverhttps://xsolla.redocly.app/_mock/fr/api/catalog/v2/project/{project_id}/entitlement/redeem
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X POST \
https://store.xsolla.com/api/v2/project/44056/entitlement/redeem \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"code": "AAAA-BBBB-CCCC-DDDD",
"sandbox": false
}'