Passer au contenu
/
Lire un lot spécifique

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
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/fr/api/digital-distribution-hub/

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://store.xsolla.com/api/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)
items[].​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 []
items[].​attributes[].​external_idstring(Catalog_admin-attribute-external_id)[ 1 .. 255 ] characters^[a-zA-Z0-9-_]+$

ID unique de l'attribut. Le paramètre external_id ne peut comprendre que des caractères alphanumériques latins minuscules, des tirets et des traits bas.

Exemple: "attribute_1"
items[].​attributes[].​namestring

Nom de l'attribut.

Exemple: "Genre"
items[].​attributes[].​valuesArray of objects
items[].​attributes[].​values[].​external_idstring(Catalog_value-external_id)[ 1 .. 255 ] characters^[-_.\d\w]+$

ID unique de la valeur d'un attribut. Le external_id ne peut comprendre que des caractères alphanumériques latins minuscules, des tirets et des tirets bas.

Exemple: "attribute_value"
items[].​attributes[].​values[].​valuestring

Valeur de l'attribut.

Exemple: "Strategy"
items[].​bundle_typestring(Catalog_bundle_type)

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

Exemple: "standart"
items[].​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"}]
items[].​content[].​descriptionstring

Description de l'objet.

Exemple: "Big Rocket - description"
items[].​content[].​image_urlstring

URL de l'image.

Exemple: "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png"
items[].​content[].​namestring

Nom de l'objet.

Exemple: "Big Rocket"
items[].​content[].​priceobject or null

Prix de l'objet.

items[].​content[].​price.​amountstring

Prix de l'objet avec remise.

Exemple: "100.99"
items[].​content[].​price.​amount_without_discountstring

Prix de l'objet.

Exemple: "100.99"
items[].​content[].​price.​currencystring

Devise d'achat par défaut. Code de devise à trois lettres selon la norme ISO 4217.

Exemple: "USD"
items[].​content[].​quantityinteger

Quantité de l'objet dans le package.

Exemple: 250
items[].​content[].​skustring

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

Exemple: "big_rocket"
items[].​content[].​typestring

Type d'objet : virtual_good/virtual_currency/bundle.

Exemple: "virtual_currency"
items[].​content[].​virtual_pricesArray of objects

Prix virtuels.

items[].​content[].​virtual_prices[].​amountinteger

Prix de l'objet en monnaie virtuelle avec remise.

Exemple: 100
items[].​content[].​virtual_prices[].​amount_without_discountinteger

Prix de l'objet.

Exemple: 200
items[].​content[].​virtual_prices[].​descriptionstring

Description de la monnaie virtuelle.

Exemple: "Big Rocket - description"
items[].​content[].​virtual_prices[].​image_urlstring

Image de la monnaie virtuelle.

Exemple: "http://image.png"
items[].​content[].​virtual_prices[].​is_defaultboolean

Indique si le prix est le prix par défaut de l'objet.

Exemple: true
items[].​content[].​virtual_prices[].​namestring

Nom de la monnaie virtuelle.

Exemple: "SHOTGUN FOR TRUE RAIDERS"
items[].​content[].​virtual_prices[].​skustring

UGS de la monnaie virtuelle.

Exemple: "vc_test"
items[].​content[].​virtual_prices[].​typestring

Type de monnaie virtuelle.

Exemple: "virtual_currency"
items[].​descriptionstring or null(Catalog_client_description)

Description de l'objet.

Exemple: "Big Rocket - description."
items[].​groupsArray of objects(Catalog_groups_response)

Groupes auxquels l'objet appartient.

Par défaut []
Exemple: [{"external_id":"horror","name":{"en":"Horror"}}]
items[].​groups[].​external_idstring
Exemple: "horror"
items[].​groups[].​nameobject
Exemple: {"en":"Horror"}
items[].​image_urlstring or null(Catalog_image_url)

URL de l'image.

Exemple: "https://image.example.com"
items[].​is_freestring(Catalog_is_free)

Toujours false.

Par défaut "false"
Exemple: "false"
items[].​namestring(Catalog_client_name)

Nom de l'objet.

Exemple: "Big Rocket"
items[].​priceobject or null(Catalog_price)

Prix de l'objet.

items[].​price.​amountstring(Catalog_amount)^\d*\.?\d*$obligatoire

Prix de l'objet avec remise.

Exemple: "100.99"
items[].​price.​amount_without_discountstring(Catalog_amount_without_discount)^\d*\.?\d*$obligatoire

Prix de l'objet.

Exemple: "100.99"
items[].​price.​currencystring(Catalog_currency)obligatoire

Devise d'achat. Code à trois lettres selon la norme ISO 4217.

Exemple: "USD"
items[].​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"
items[].​total_content_priceobject or null(Catalog_total_content_price)

Somme des prix du contenu du lot.

items[].​total_content_price.​amountstring

Somme des prix du contenu du lot avec remise.

Exemple: "100.99"
items[].​total_content_price.​amount_without_discountstring

Somme des prix du contenu du lot.

Exemple: "100.99"
items[].​total_content_price.​currencystring(Catalog_currency)

Devise d'achat. Code à trois lettres selon la norme ISO 4217.

Exemple: "USD"
items[].​typestring(Catalog_type)

Type d'objet.

Exemple: "bundle"
items[].​virtual_pricesArray of objects(Catalog_virtual_prices)

Prix virtuels.

items[].​virtual_prices[].​amountinteger

Prix de l'objet en monnaie virtuelle avec remise.

Exemple: 100
items[].​virtual_prices[].​amount_without_discountinteger

Prix de l'objet en monnaie virtuelle.

Exemple: 200
items[].​virtual_prices[].​descriptionstring or null

Description de la monnaie virtuelle.

Exemple: "Most popular gold"
items[].​virtual_prices[].​image_urlstring or null

Image de la monnaie virtuelle.

Exemple: "http://image.png"
items[].​virtual_prices[].​is_defaultboolean

Indique si le prix est le prix par défaut de l'objet.

Exemple: true
items[].​virtual_prices[].​namestring

Nom de la monnaie virtuelle.

Exemple: "Gold"
items[].​virtual_prices[].​skustring

UGS de la monnaie virtuelle.

Exemple: "gold"
items[].​virtual_prices[].​typestring

Type de monnaie virtuelle.

Exemple: "virtual_currency"
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://store.xsolla.com/api/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 []
attributes[].​external_idstring(Catalog_admin-attribute-external_id)[ 1 .. 255 ] characters^[a-zA-Z0-9-_]+$

ID unique de l'attribut. Le paramètre external_id ne peut comprendre que des caractères alphanumériques latins minuscules, des tirets et des traits bas.

Exemple: "attribute_1"
attributes[].​namestring

Nom de l'attribut.

Exemple: "Genre"
attributes[].​valuesArray of objects
attributes[].​values[].​external_idstring(Catalog_value-external_id)[ 1 .. 255 ] characters^[-_.\d\w]+$

ID unique de la valeur d'un attribut. Le external_id ne peut comprendre que des caractères alphanumériques latins minuscules, des tirets et des tirets bas.

Exemple: "attribute_value"
attributes[].​values[].​valuestring

Valeur de l'attribut.

Exemple: "Strategy"
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"}]
content[].​descriptionstring

Description de l'objet.

Exemple: "Big Rocket - description"
content[].​image_urlstring

URL de l'image.

Exemple: "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png"
content[].​namestring

Nom de l'objet.

Exemple: "Big Rocket"
content[].​priceobject or null

Prix de l'objet.

content[].​price.​amountstring

Prix de l'objet avec remise.

Exemple: "100.99"
content[].​price.​amount_without_discountstring

Prix de l'objet.

Exemple: "100.99"
content[].​price.​currencystring

Devise d'achat par défaut. Code de devise à trois lettres selon la norme ISO 4217.

Exemple: "USD"
content[].​quantityinteger

Quantité de l'objet dans le package.

Exemple: 250
content[].​skustring

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

Exemple: "big_rocket"
content[].​typestring

Type d'objet : virtual_good/virtual_currency/bundle.

Exemple: "virtual_currency"
content[].​virtual_pricesArray of objects

Prix virtuels.

content[].​virtual_prices[].​amountinteger

Prix de l'objet en monnaie virtuelle avec remise.

Exemple: 100
content[].​virtual_prices[].​amount_without_discountinteger

Prix de l'objet.

Exemple: 200
content[].​virtual_prices[].​descriptionstring

Description de la monnaie virtuelle.

Exemple: "Big Rocket - description"
content[].​virtual_prices[].​image_urlstring

Image de la monnaie virtuelle.

Exemple: "http://image.png"
content[].​virtual_prices[].​is_defaultboolean

Indique si le prix est le prix par défaut de l'objet.

Exemple: true
content[].​virtual_prices[].​namestring

Nom de la monnaie virtuelle.

Exemple: "SHOTGUN FOR TRUE RAIDERS"
content[].​virtual_prices[].​skustring

UGS de la monnaie virtuelle.

Exemple: "vc_test"
content[].​virtual_prices[].​typestring

Type de monnaie virtuelle.

Exemple: "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"}}]
groups[].​external_idstring
Exemple: "horror"
groups[].​nameobject
Exemple: {"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.

price.​amountstring(Catalog_amount)^\d*\.?\d*$obligatoire

Prix de l'objet avec remise.

Exemple: "100.99"
price.​amount_without_discountstring(Catalog_amount_without_discount)^\d*\.?\d*$obligatoire

Prix de l'objet.

Exemple: "100.99"
price.​currencystring(Catalog_currency)obligatoire

Devise d'achat. Code à trois lettres selon la norme ISO 4217.

Exemple: "USD"
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.

total_content_price.​amountstring

Somme des prix du contenu du lot avec remise.

Exemple: "100.99"
total_content_price.​amount_without_discountstring

Somme des prix du contenu du lot.

Exemple: "100.99"
total_content_price.​currencystring(Catalog_currency)

Devise d'achat. Code à trois lettres selon la norme ISO 4217.

Exemple: "USD"
typestring(Catalog_type)

Type d'objet.

Exemple: "bundle"
virtual_pricesArray of objects(Catalog_virtual_prices)

Prix virtuels.

virtual_prices[].​amountinteger

Prix de l'objet en monnaie virtuelle avec remise.

Exemple: 100
virtual_prices[].​amount_without_discountinteger

Prix de l'objet en monnaie virtuelle.

Exemple: 200
virtual_prices[].​descriptionstring or null

Description de la monnaie virtuelle.

Exemple: "Most popular gold"
virtual_prices[].​image_urlstring or null

Image de la monnaie virtuelle.

Exemple: "http://image.png"
virtual_prices[].​is_defaultboolean

Indique si le prix est le prix par défaut de l'objet.

Exemple: true
virtual_prices[].​namestring

Nom de la monnaie virtuelle.

Exemple: "Gold"
virtual_prices[].​skustring

UGS de la monnaie virtuelle.

Exemple: "gold"
virtual_prices[].​typestring

Type de monnaie virtuelle.

Exemple: "virtual_currency"
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