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
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

Jeton d'utilisateur

Opérations

Notifications

Opérations

Commande

Opérations

Lire une commande

Requête

Récupère des informations sur une commande spécifique.

Sécurité
AuthForClient
Chemin
project_idintegerobligatoire

ID de projet.

Exemple: 44056
order_idstringobligatoire

ID de commande.

Exemple: 656
curl -i -X GET \
  https://store.xsolla.com/api/v2/project/44056/distribution_hub/order/656 \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Réponses

Requête de commande acceptée.

Corpsapplication/json
contentobject(Order_inline_response_200_1_content)

Détails de la commande.

content.​is_freestring

Si ce paramètre est défini sur true, la commande est gratuite.

Exemple: "false"
content.​itemsArray of objects(Order_inline_response_200_1_content_items)

Liste des objets.

Exemple: [{"is_free":false,"price":{"amount":"30","amount_without_discount":"30","currency":"USD"},"quantity":1,"sku":"some_sku"}]
content.​items[].​is_freestring

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

Exemple: "false"
content.​items[].​priceobject(Order_inline_response_200_1_content_price_1)

Prix de l'objet.

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

Prix de l'objet réduit.

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

Prix de l'objet.

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

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

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

Quantité de l'objet.

Exemple: 1
content.​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: "some_sku"
content.​priceobject(Order_inline_response_200_1_content_price)

Prix de la commande.

content.​price.​amountstring

Prix de la commande réduit.

Exemple: "30"
content.​price.​amount_without_discountstring

Prix de la commande.

Exemple: "30"
content.​price.​currencystring

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

Exemple: "USD"
content.​virtual_priceobject(Order_inline_response_200_1_content_virtual_price)

Prix de la commande en monnaie virtuelle.

content.​virtual_price.​amountstring

Prix de la commande réduit.

Exemple: "100"
content.​virtual_price.​amount_without_discountstring

Prix de la commande.

Exemple: "150"
content.​virtual_price.​currencystring

UGS de la monnaie virtuelle utilisée dans la commande.

Exemple: "test_vc"
order_idinteger

ID de commande.

Exemple: 1
statusstring

Statut de la commande : new/paid/done/canceled.

Exemple: "paid"
Réponse
application/json
{
  "content": {
    "is_free": "false",
    "items": [ … ],
    "price": { … }
  },
  "order_id": 1,
  "status": "paid"
}

Créer une commande à partir de tous les objets du panier actuel

Requête

Crée une commande à partir de tous les objets d'un panier. La commande créée aura le statut new.

Sécurité
AuthForClient
Chemin
project_idintegerobligatoire

ID de projet.

Exemple: 44056
Corpsapplication/jsonobligatoire

Données pour la création de la commande.

currencystring(Cart-Payment_settings_currency)obligatoire

Devise de paiement préférée. Code de devise à trois lettres selon la norme ISO 4217.

geotypenumberobligatoire

ID du partenaire distributeur du côté de Xsolla.

Exemple: 13038
quantityinteger

Quantité de l'objet.

Exemple: 1
curl -i -X POST \
  https://store.xsolla.com/api/v2/project/44056/distribution_hub/payment/cart \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "geotype": 13038
  }'

Réponses

La commande a été créée avec succès.

Corpsapplication/json
billing_infoobject(Order_inline_response_200_billing_info)

Informations sur la facturation.

billing_info.​direct_taxArray of objects(Order_inline_response_200_billing_info_direct_tax)
billing_info.​direct_tax[].​amountnumber
Exemple: 150
billing_info.​direct_tax[].​namestring
Exemple: "TAX"
billing_info.​direct_tax[].​ratenumber
Exemple: 10
billing_info.​indirect_taxArray of objects(Order_inline_response_200_billing_info_indirect_tax)
billing_info.​indirect_tax[].​amountnumber
Exemple: 246.75
billing_info.​indirect_tax[].​namestring
Exemple: "VAT"
billing_info.​indirect_tax[].​ratenumber
Exemple: 20
billing_info.​priceobject(Order_inline_response_200_billing_info_price)
billing_info.​price.​amountnumber
Exemple: 1480.45
billing_info.​price.​currencystring= 3 characters

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

Exemple: "USD"
order_idinteger

ID de commande.

Réponse
application/json
{
  "billing_info": {
    "direct_taxes": [ … ],
    "indirect_taxes": [ … ],
    "price": { … }
  },
  "order_id": 641
}

Créer une commande à partir de tous les objets d'un panier spécifique

Requête

Crée une commande à partir de tous les objets d'un panier spécifique. La commande créée aura le statut new.

Sécurité
AuthForClient
Chemin
project_idintegerobligatoire

ID de projet.

Exemple: 44056
cart_idstringobligatoire

ID de panier.

Exemple: custom_id
Corpsapplication/jsonobligatoire

Données pour la création de la commande.

currencystring(Cart-Payment_settings_currency)obligatoire

Devise de paiement préférée. Code de devise à trois lettres selon la norme ISO 4217.

geotypenumberobligatoire

ID du partenaire distributeur du côté de Xsolla.

Exemple: 13038
quantityinteger

Quantité de l'objet.

Exemple: 1
curl -i -X POST \
  https://store.xsolla.com/api/v2/project/44056/distribution_hub/payment/cart/custom_id \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "geotype": 13038
  }'

Réponses

La commande a été créée avec succès.

Corpsapplication/json
billing_infoobject(Order_inline_response_200_billing_info)

Informations sur la facturation.

billing_info.​direct_taxArray of objects(Order_inline_response_200_billing_info_direct_tax)
billing_info.​direct_tax[].​amountnumber
Exemple: 150
billing_info.​direct_tax[].​namestring
Exemple: "TAX"
billing_info.​direct_tax[].​ratenumber
Exemple: 10
billing_info.​indirect_taxArray of objects(Order_inline_response_200_billing_info_indirect_tax)
billing_info.​indirect_tax[].​amountnumber
Exemple: 246.75
billing_info.​indirect_tax[].​namestring
Exemple: "VAT"
billing_info.​indirect_tax[].​ratenumber
Exemple: 20
billing_info.​priceobject(Order_inline_response_200_billing_info_price)
billing_info.​price.​amountnumber
Exemple: 1480.45
billing_info.​price.​currencystring= 3 characters

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

Exemple: "USD"
order_idinteger

ID de commande.

Réponse
application/json
{
  "billing_info": {
    "direct_taxes": [ … ],
    "indirect_taxes": [ … ],
    "price": { … }
  },
  "order_id": 641
}