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

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

Lire la liste des régionsServer-sideAdmin

Requête

Récupère la liste des régions.

Utilisez les régions pour gérer les restrictions régionales.

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/v2/project/44056/admin/region

Réponses

La liste des régions a été reçue avec succès.

Corpsapplication/json
regionsArray of objects(Regions_200-region-short-model)
Réponse
application/json
{
  "regions": [
    { … },
    { … }
  ]
}

Créer une régionServer-sideAdmin

Requête

Crée une région.

Utilisez les régions pour gérer les restrictions régionales.

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
countriesArray of strings(Regions_countries)obligatoire

Liste des pays à ajouter dans une région.
Code de 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 : ["JP", "CN", "VN"]

nameobject(Regions_name)obligatoire

Nom de la région. Doit comprendre des paires clé/valeur, où la clé est une région au format "^[a-z]{2}-[A-Z]{2}$", la valeur est une chaîne.

Par défaut {"de-DE":"Asien","en-US":"Asia"}
Exemple: {"de-DE":"Asien","en-US":"Asia"}
name.​property name*stringpropriété supplémentaire
curl -i -X POST \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/fr/api/catalog/v2/project/44056/admin/region \
  -H 'Content-Type: application/json' \
  -d '{
    "countries": [
      "JP",
      "CN",
      "VN"
    ],
    "name": {
      "de-DE": "Asien",
      "en-US": "Asia"
    }
  }'

Réponses

La région a été créée avec succès.

Corpsapplication/json
region_idinteger(Regions_region_id)

ID de la région. Identifiant unique de la région au sein du projet.

Exemple: 42
Réponse
application/json
{
  "region_id": 42
}

Supprimer une régionServer-sideAdmin

Requête

Supprime une région spécifique.

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
region_idintegerobligatoire

ID de la région. Identifiant unique de la région au sein du projet.

Exemple: 42
curl -i -X DELETE \
  -u <username>:<password> \
  https://xsolla.redocly.app/_mock/fr/api/catalog/v2/project/44056/admin/region/42

Réponses

La région a été supprimée avec succès.

Corps
Réponse
Aucun contenu

Administrateur

Opérations