Passer au contenu

Digital Distribution Hub (1.0.0)

Aperçu

Digital Distribution Hub est une nouvelle solution Xsolla qui comble le fossé entre les paiements numériques et les paiements en espèces via la technologie des paiements push et le e-commerce.

Cette référence décrit les endpoints API de deux produits Xsolla : In-Game Store et Pay Station. Deux URL de base sont utilisées :

  • https://store.xsolla.com/api pour les groupes Communs, Catalogue, Panier, et Commande.
  • https://ps.xsolla.com pour le groupe Notifications.

Les endpoints API dans le groupe Catalogue ne requièrent pas d'autorisation.

Pour utiliser les opérations des groupes Panier et Commande, vous devez générer un jeton via Create user token.

Note

Cette référence présente un projet d'une future API et non une interface entièrement fonctionnelle. Actuellement, vous ne pouvez essayer que les endpoints des groupes Catalogue et Notifications. Si vous souhaitez nous faire part de vos commentaires, envoyez-nous un e-mail à l'adresse suivante : techdoc@xsolla.com.
Télécharger la description d'OpenAPI
index.json
index.yaml
Langues
Serveurs
Mock server
https://xsolla.redocly.app/_mock/fr/api/digital-distribution-hub/
https://store.xsolla.com/api/

Panier

Opérations

Clés de jeu

Opérations

Objets et monnaie virtuels

Opérations

Lots

Opérations

Lire une liste de lots

Requête

Récupère une liste de lots pour la constitution d'un catalogue.

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 50 éléments par réponse.
Sécurité
AuthForClient
Chemin
project_idintegerobligatoire

ID de projet.

Exemple: 44056
Requête
limitinteger

Nombre maximal d'éléments sur une page.

Exemple: limit=50
offsetinteger

Numéro de l'élément à partir duquel la liste est générée (le compte commence à 0).

Exemple: offset=0
localestring

Langue de la réponse. Code de langue à deux lettres minuscules selon la norme ISO 639-1.

Par défaut "en"
additional_fields[]Array of strings

Liste des champs supplémentaires. Ces champs figureront dans la réponse si vous les envoyez dans votre requête. Champs disponibles media_list, order et long_description.

countrystring

Pays pour la détermination des prix régionaux et des restrictions pour le catalogue. Code pays à deux lettres majuscules selon la norme ISO 3166-1 alpha-2. Si vous ne spécifiez pas explicitement le pays, il sera déterminé en fonction de l'adresse IP de l'utilisateur.

Par défaut "US"
curl -i -X GET \
  'https://xsolla.redocly.app/_mock/fr/api/digital-distribution-hub/v2/project/44056/items/bundle?limit=50&offset=0&locale=en&additional_fields%5B%5D=string&country=US' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Réponses

La liste de lots a été reçue avec succès.

Corpsapplication/json
itemsArray of objects(Catalog_client_bundle)
Réponse
application/json
{
  "items": [
    { … }
  ]
}

Lire un lot spécifique

Requête

Récupère des informations sur un lot spécifique.

Sécurité
AuthForClient
Chemin
project_idintegerobligatoire

ID de projet.

Exemple: 44056
skustringobligatoire

UGS du lot.

Exemple: kg_1
curl -i -X GET \
  https://xsolla.redocly.app/_mock/fr/api/digital-distribution-hub/v2/project/44056/items/bundle/sku/kg_1 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Réponses

Le lot spécifié a été reçu avec succès.

Corpsapplication/json
attributesArray of objects(Catalog_client-attributes-common)

Liste des attributs et de leurs valeurs correspondantes pour l'objet. Peut être utilisée pour le filtrage du catalogue.

Par défaut []
bundle_typestring(Catalog_bundle_type)

Type de lot. Dans ce cas, il s'agit toujours de standart.

Exemple: "standart"
contentArray of objects(Catalog_client_content)

Contenu du lot.

Exemple: [{"attributes":[],"description":"Big Rocket - short description.","groups":[],"image_url":"https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png","is_free":false,"name":"Big Rocket","price":{"amount":10.99,"amount_without_discount":10.99,"currency":"USD"},"quantity":100,"sku":"big_rocket","type":"virtual_currency"}]
descriptionstring or null(Catalog_client_description)

Description de l'objet.

Exemple: "Big Rocket - description."
groupsArray of objects(Catalog_groups_response)

Groupes auxquels l'objet appartient.

Par défaut []
Exemple: [{"external_id":"horror","name":{"en":"Horror"}}]
image_urlstring or null(Catalog_image_url)

URL de l'image.

Exemple: "https://image.example.com"
is_freestring(Catalog_is_free)

Toujours false.

Par défaut "false"
Exemple: "false"
namestring(Catalog_client_name)

Nom de l'objet.

Exemple: "Big Rocket"
priceobject or null(Catalog_price)

Prix de l'objet.

skustring(Catalog_sku)

ID unique de l'objet. L'UGS ne peut comprendre que des caractères alphanumériques latins minuscules, des points, des tirets et des traits bas.

Exemple: "bundle_1"
total_content_priceobject or null(Catalog_total_content_price)

Somme des prix du contenu du lot.

typestring(Catalog_type)

Type d'objet.

Exemple: "bundle"
virtual_pricesArray of objects(Catalog_virtual_prices)

Prix virtuels.

Réponse
application/json
{
  "attributes": [],
  "bundle_type": "standard",
  "content": [
    { … }
  ],
  "description": "pricePoint_44056_1.",
  "groups": [],
  "is_free": false,
  "media_list": [],
  "name": "kg_10.00_bundle",
  "order": 999,
  "price": {
    "amount": 9.99,
    "amount_without_discount": 9.99,
    "currency": "USD"
  },
  "sku": "kg_1",
  "total_content_amount": {
    "amount": 10.99,
    "amount_without_discount": 10.99,
    "currency": "USD"
  },
  "type": "bundle",
  "virtual_prices": []
}

Jeton d'utilisateur

Opérations

Notifications

Opérations

Commande

Opérations