Passer au contenu
/
Lire une liste d'objets p...

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

Lire une liste d'objets virtuels

Requête

Récupère une liste d'objets virtuels 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. Pour obtenir plus de données page par page, utilisez les champs limit et offset.
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/virtual_items?limit=50&offset=0&locale=en&additional_fields%5B%5D=string&country=US' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Réponses

La liste d'objets virtuels a été reçue avec succès.

Corpsapplication/json
itemsArray of objects(Catalog_inline_response_200_5_items)
Exemple: [{"attributes":[{"external_id":"stack_size","name":"Stack size","values":[{"external_id":"size_e3364991f92e751689a68b96598a5a5a84010b85","value":"5"}]}],"description":"Big Rocket - description","groups":[{"external_id":"accessory","name":"Accessory"}],"image_url":"https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png","inventory_options":{"consumable":{"usages_count":1},"expiration_period":{"type":"day","value":1}},"is_free":false,"name":"Big Rocket","price":{"amount":"100.99","amount_without_discount":"100.99","currency":"USD"},"sku":"big_rocket","type":"virtual_good","virtual_item_type":"non_renewing_subscription","virtual_prices":[{"amount":100,"amount_without_discount":100,"description":"description","image_url":"http://image.png","is_default":true,"name":"SHOTGUN FOR TRUE RAIDERS","sku":"vc_test","type":"virtual_currency"}]},{"attributes":[{"external_id":"stack_size","name":"Stack size","values":[{"external_id":"size_e3364991f92e751689a68b96598a5a5a84010b85","value":"5"}]},{"external_id":"rating","name":"Rating","values":[{"external_id":"rating_e3364991f92e751689a68b96598a5a5a84010b85","value":"3.9"}]}],"description":"description","groups":[{"external_id":"hair","name":"Hair"}],"image_url":"http://image.png","inventory_options":{"consumable":{"usages_count":1},"expiration_period":{"type":"day","value":1}},"is_free":false,"name":"SHOTGUN FOR TRUE RAIDERS","price":{"amount":"101.0","amount_without_discount":"101.0","currency":"USD"},"sku":"shotgun_raider","type":"virtual_good","virtual_item_type":"non_renewing_subscription","virtual_prices":[{"amount":100,"amount_without_discount":100,"description":"description","image_url":"http://image.png","is_default":true,"name":"SHOTGUN FOR TRUE RAIDERS","sku":"vc_test","type":"virtual_currency"},{"amount":200,"amount_without_discount":200,"description":"description","image_url":"http://image.png","is_default":false,"name":"SHOTGUN FOR TRUE RAIDERS","sku":"vc_test_2","type":"virtual_currency"}]},{"attributes":[],"description":"description","groups":[],"image_url":"http://image.png","inventory_options":{"consumable":{"usages_count":1},"expiration_period":{"type":"day","value":1}},"is_free":true,"name":"SHOTGUN FOR TRUE RAIDERS","sku":"shotgun_raider_2","type":"virtual_good","virtual_item_type":"non_renewing_subscription","virtual_prices":[]}]
items[].​attributesArray of objects(Catalog_client-attributes)

Liste des attributs et de leurs valeurs correspondantes pour le jeu.

Attention. Cette partie de la réponse n'est disponible que si vous envoyez le paramètre de requête `additional_fields[]=attributes`.
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[].​descriptionstring

Description de l'objet.

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

Groupes auxquels l'objet appartient.

Exemple: [{"external_id":"accessory","name":"Accessory"}]
items[].​groups[].​external_idstring
Exemple: "accessory"
items[].​groups[].​namestring
Exemple: "Accessory"
items[].​image_urlstring

URL de l'image.

Exemple: "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png"
items[].​inventory_optionsobject(Catalog_inline_response_200_5_inventory_options)

Définit les propriétés de l'objet d'inventaire.

items[].​inventory_options.​consumableobject or null(Catalog_inline_response_200_5_inventory_options_consumable)

Définit la propriété de consommabilité, s'il s'agit d'un objet consommable, ou null s'il s'agit d'un objet non consommable.

items[].​inventory_options.​consumable.​usages_countinteger or null

Nombre total d'utilisations restantes s'il s'agit d'un objet consommable, ou null s'il s'agit d'un objet non consommable.

Exemple: 1
items[].​inventory_options.​expiration_periodobject or null(Catalog_inline_response_200_5_inventory_options_expiration_period)

Définit la propriété d'expiration s'il s'agit d'un objet à durée limitée, ou null s'il s'agit d'un objet à durée illimitée.

items[].​inventory_options.​expiration_period.​typestring

Définit le type d'expiration de l'objet.

Enum"minute""hour""day""week""month""year"
Exemple: "day"
items[].​inventory_options.​expiration_period.​valueinteger

Définit la valeur du délai d'expiration.

Exemple: 1
items[].​is_freeboolean

Si ce paramètre est défini sur true, l'objet est gratuit.

Exemple: false
items[].​namestring

Nom de l'objet.

Exemple: "Big Rocket"
items[].​priceobject(Catalog_inline_response_200_5_price)

Prix de l'objet.

items[].​price.​amountstring

Prix de l'objet réduit.

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

Prix de l'objet.

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

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

Exemple: "USD"
items[].​skustring

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: "big_rocket"
items[].​typestring

Type d'objet : virtual_good/virtual_currency/bundle.

Exemple: "virtual_good"
items[].​virtual_item_typestring

Type d'objet virtuel.

Enum"consumable""non_consumable""non_renewing_subscription"
Exemple: "non-consumable"
items[].​virtual_pricesArray of objects(Catalog_inline_response_200_virtual_prices)

Prix virtuels.

items[].​virtual_prices[].​amountinteger

Prix de l'objet réduit en monnaie virtuelle.

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

Prix de l'objet.

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

Description de la monnaie virtuelle.

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

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: "SHOTGUN FOR TRUE RAIDERS"
items[].​virtual_prices[].​skustring

UGS de la monnaie virtuelle.

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

Type de monnaie virtuelle.

Exemple: "virtual_currency"
Réponse
application/json
{
  "items": [
    { … },
    { … },
    { … }
  ]
}

Lire une liste d'objets par groupe spécifique

Requête

Récupère une liste d'objets au sein d'un groupe spécifique 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. Pour obtenir plus de données page par page, utilisez les champs limit et offset.
Sécurité
AuthForClient
Chemin
project_idintegerobligatoire

ID de projet.

Exemple: 44056
external_idstringobligatoire

External ID du groupe.

Par défaut "all"
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/virtual_items/group/{external_id}?limit=50&offset=0&locale=en&additional_fields%5B%5D=string&country=US' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Réponses

La liste d'objets du groupe spécifié a été reçue avec succès.

Corpsapplication/json
itemsArray of objects(Catalog_inline_response_200_8_items)
Exemple: [{"attributes":[{"external_id":"stack_size","name":"Stack size","values":[{"value":"5"}]}],"description":"Big Rocket - description","groups":[{"external_id":"accessory","name":"Accessory"}],"image_url":"https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png","inventory_options":{"consumable":{"usages_count":1},"expiration_period":{"type":"day","value":1}},"is_free":false,"name":"Big Rocket","price":{"amount":"100.99","amount_without_discount":"100.99","currency":"USD"},"sku":"big_rocket","type":"virtual_good","virtual_item_type":"non_renewing_subscription","virtual_prices":[{"amount":100,"amount_without_discount":100,"description":"description","image_url":"http://image.png","is_default":true,"name":"SHOTGUN FOR TRUE RAIDERS","sku":"vc_test","type":"virtual_currency"}]},{"attributes":[{"external_id":"stack_size","name":"Stack size","values":[{"value":"5"}]},{"external_id":"rating","name":"Rating","values":[{"value":"3.9"}]},{"external_id":"genre","name":"Genre","values":[{"value":"Strategy"},{"value":"Tactical"},"Turn-based"]}],"description":"description","groups":[{"external_id":"accessory","name":"Accessory"}],"image_url":"http://image.png","inventory_options":{"consumable":{"usages_count":1},"expiration_period":{"type":"day","value":1}},"is_free":false,"name":"SHOTGUN FOR TRUE RAIDERS","price":{"amount":"101.0","amount_without_discount":"101.0","currency":"USD"},"sku":"shotgun_raider","type":"virtual_good","virtual_item_type":"non_renewing_subscription","virtual_prices":[{"amount":100,"amount_without_discount":100,"description":"description","image_url":"http://image.png","is_default":true,"name":"SHOTGUN FOR TRUE RAIDERS","sku":"vc_test","type":"virtual_currency"},{"amount":200,"amount_without_discount":200,"description":"description","image_url":"http://image.png","is_default":false,"name":"SHOTGUN FOR TRUE RAIDERS","sku":"vc_test_2","type":"virtual_currency"}]}]
items[].​attributesArray of objects(Catalog_client-attributes)

Liste des attributs et de leurs valeurs correspondantes pour le jeu.

Attention. Cette partie de la réponse n'est disponible que si vous envoyez le paramètre de requête `additional_fields[]=attributes`.
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[].​descriptionstring

Description de l'objet.

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

Groupes auxquels l'objet appartient.

Exemple: [{"external_id":"accessory","name":"Accessory"}]
items[].​groups[].​external_idstring
Exemple: "accessory"
items[].​groups[].​namestring
Exemple: "Accessory"
items[].​image_urlstring

URL de l'image.

Exemple: "https://popmedia.blob.core.windows.net/popyourself/male/outfit/male_armor_white_a-01.png"
items[].​inventory_optionsobject(Catalog_inline_response_200_7_inventory_options)

Définit les propriétés de l'objet d'inventaire.

items[].​inventory_options.​consumableobject or null(Catalog_inline_response_200_5_inventory_options_consumable)

Définit la propriété de consommabilité, s'il s'agit d'un objet consommable, ou null s'il s'agit d'un objet non consommable.

items[].​inventory_options.​consumable.​usages_countinteger or null

Nombre total d'utilisations restantes s'il s'agit d'un objet consommable, ou null s'il s'agit d'un objet non consommable.

Exemple: 1
items[].​inventory_options.​expiration_periodobject or null(Catalog_inline_response_200_7_inventory_options_expiration_period)

Définit la propriété d'expiration s'il s'agit d'un objet à durée limitée, ou null s'il s'agit d'un objet à durée illimitée.

items[].​inventory_options.​expiration_period.​typestring

Définit le type d'expiration de l'objet.

Enum"minute""hour""day""week""month""year"
Exemple: "day"
items[].​inventory_options.​expiration_period.​valueinteger

Définit la valeur du délai d'expiration.

Exemple: 1
items[].​is_freestring

Si ce paramètre est défini sur true, l'objet est gratuit.

Exemple: "false"
items[].​namestring

Nom de l'objet.

Exemple: "Big Rocket"
items[].​priceobject(Catalog_inline_response_200_5_price)

Prix de l'objet.

items[].​price.​amountstring

Prix de l'objet réduit.

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

Prix de l'objet.

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

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

Exemple: "USD"
items[].​skustring

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: "big_rocket"
items[].​typestring

Type d'objet : consumable/expiration/permanent/lootboxes/physical.

Exemple: "virtual_good"
items[].​virtual_item_typestring

Type d'objet virtuel.

Enum"consumable""non_consumable""non_renewing_subscription"
Exemple: "non_consumable"
items[].​virtual_pricesArray of objects(Catalog_inline_response_200_8_virtual_prices)

Prix virtuels.

items[].​virtual_prices[].​amountinteger

Prix de l'objet réduit en monnaie virtuelle.

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

Prix de l'objet.

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

Description de la monnaie virtuelle.

Exemple: "Big Rocket - description"
items[].​virtual_prices[].​image_urlstring
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: "SHOTGUN FOR TRUE RAIDERS"
items[].​virtual_prices[].​skustring

UGS de la monnaie virtuelle.

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

Type de monnaie virtuelle.

Exemple: "virtual_currency"
Réponse
application/json
{
  "items": [
    { … },
    { … }
  ]
}

Lots

Opérations

Jeton d'utilisateur

Opérations

Notifications

Opérations

Commande

Opérations