Zum Inhalt springen

Überblick

Der Digital Distribution Hub ist eine neue Lösung von Xsolla, mit der sich digitale und bargeldbasierte Zahlungen über Push-Payment-Technologie und E-Commerce verknüpfen lassen.

Diese Referenz enthält API-Endpunkte für zwei Xsolla-Produkte: Ingame-Online-Shop und Bezahlstation. Es gibt zwei grundlegende URLs:

  • https://store.xsolla.com/api für die Gruppen Allgemeines, Katalog, Warenkorb und Bestellung.
  • https://ps.xsolla.com für die Gruppe Benachrichtigungen.

API-Endpunkte in der Gruppe Katalog erfordern keine Autorisierung.

Um Aufrufe aus den Gruppen Warenkorb und Bestellung nutzen zu können, müssen Sie einen Token mithilfe der Methode Benutzertoken erstellen generieren.

Hinweis:

Diese Referenz beschreibt eine im Entwurfsstadium befindliche zukünftige API, die Schnittstelle ist noch nicht voll funktionsfähig. Derzeit können Sie nur die Endpunkte der Gruppen Katalog und Benachrichtigungen ausprobieren. Feedback können Sie gerne per E-Mail an techdoc@xsolla.com senden.
OpenAPI-Beschreibung herunterladen
Sprachen
Server
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/de/api/digital-distribution-hub/
Operationen
Operationen
Operationen
Operationen

Anfrage

Ruft eine Liste von Bundles zum Erstellen eines Katalogs ab.

Achtung: Bei allen Projekten ist die Anzahl der pro Antwort abrufbaren Elemente begrenzt. Der Standard- und Maximalwert beträgt 50 Elemente pro Antwort.
Sicherheit
AuthForClient
Pfad
project_idintegererforderlich

Projekt-ID.

Beispiel: 44056
Abfrage
limitinteger

Obergrenze der Elementanzahl auf der Seite.

Beispiel: limit=50
offsetinteger

Elementnummer, aus der die Liste generiert wird (die Zählung beginnt bei 0).

Beispiel: offset=0
localestring

Antwortsprache. Sprachcode, bestehend aus zwei Kleinbuchstaben, gemäß ISO 639-1.

Standard "en"
additional_fields[]Array of strings

Die Liste der zusätzlichen Felder. Diese Felder werden in der Antwort angezeigt, sofern sie in der Anfrage gesendet werden. Verfügbare Felder: media_list, order, long_description.

countrystring

Land, für das regionale Preise berechnet und Katalogeinschränkungen festgelegt werden. Ländercode, bestehend aus zwei Großbuchstaben, gemäß ISO 3166-1 Alpha-2. Wenn Sie das Land nicht explizit angeben, wird es anhand der IP-Adresse des Benutzers ermittelt.

Standard "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>'

Antworten

Die Liste der Bundles wurde erfolgreich empfangen.

Bodyapplication/json
itemsArray of objects(Catalog_client_bundle)
items[].​attributesArray of objects(Catalog_client-attributes-common)

Liste der dem Artikel zugeordneten Attribute und deren Werte. Kann für die Katalogfilterung verwendet werden.

Standard []
items[].​attributes[].​external_idstring(Catalog_admin-attribute-external_id)[ 1 .. 255 ] characters^[a-zA-Z0-9-_]+$

Eindeutige Attribut-ID. Die external_id darf nur lateinische alphanumerische Kleinbuchstaben, Bindestriche und Unterstriche enthalten.

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

Name des Attributs.

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

Eindeutige Wert-ID für ein Attribut. Die external_id darf nur lateinische alphanumerische Kleinbuchstaben, Bindestriche und Unterstriche enthalten.

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

Wert des Attributs.

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

Bundle-Typ. In diesem Fall immer standart.

Beispiel: "standart"
items[].​contentArray of objects(Catalog_client_content)

Paketinhalt des Bundles.

Beispiel: [{"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

Artikelbeschreibung.

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

Bild-URL.

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

Artikelname.

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

Artikelpreise.

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

Rabattierter Artikelpreis.

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

Artikelpreis.

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

Standardkaufwährung. Code, bestehend aus drei Buchstaben, gemäß ISO 4217.

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

Artikelmenge in einem Paket.

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

Eindeutige Artikel-ID. Die SKU darf nur lateinische alphanumerische Kleinbuchstaben, Bindestriche und Unterstriche enthalten.

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

Artikeltyp: virtual_good/virtual_currency/bundle.

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

Virtuelle Preise.

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

Rabattierter Artikelpreis in virtueller Währung.

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

Artikelpreis.

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

Beschreibung der virtuellen Währung.

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

Bild der virtuellen Währung.

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

Ob der Preis für einen Artikel voreingestellt ist.

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

Name der virtuellen Währung.

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

Artikel-SKU der virtuellen Währung.

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

Typ der virtuellen Währung.

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

Artikelbeschreibung.

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

Gruppen, zu denen der Artikel gehört.

Standard []
Beispiel: [{"external_id":"horror","name":{"en":"Horror"}}]
items[].​groups[].​external_idstring
Beispiel: "horror"
items[].​groups[].​nameobject
Beispiel: {"en":"Horror"}
items[].​image_urlstring or null(Catalog_image_url)

Bild-URL.

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

Immer false.

Standard "false"
Beispiel: "false"
items[].​namestring(Catalog_client_name)

Artikelname.

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

Artikelpreis.

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

Rabattierter Artikelpreis.

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

Artikelpreis.

Beispiel: "100.99"
items[].​price.​currencystring(Catalog_currency)erforderlich

Kaufwährung. Code, bestehend aus drei Buchstaben, gemäß ISO 4217.

Beispiel: "USD"
items[].​skustring(Catalog_sku)

Eindeutige Artikel-ID. Die SKU darf nur lateinische alphanumerische Kleinbuchstaben, Punkte, Bindestriche und Unterstriche enthalten.

Beispiel: "bundle_1"
items[].​total_content_priceobject or null(Catalog_total_content_price)

Summe der einzelnen Preise der Bundle-Inhalte.

items[].​total_content_price.​amountstring

Rabattierte Summe der einzelnen Preise der Bundle-Inhalte.

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

Summe der einzelnen Preise der Bundle-Inhalte.

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

Kaufwährung. Code, bestehend aus drei Buchstaben, gemäß ISO 4217.

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

Artikeltyp.

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

Virtuelle Preise.

items[].​virtual_prices[].​amountinteger

Rabattierter Artikelpreis in virtueller Währung.

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

Artikelpreis in virtueller Währung.

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

Beschreibung der virtuellen Währung.

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

Bild der virtuellen Währung.

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

Ob der Preis für einen Artikel voreingestellt ist.

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

Name der virtuellen Währung.

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

Artikel-SKU der virtuellen Währung.

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

Typ der virtuellen Währung.

Beispiel: "virtual_currency"
Antwort
application/json
{ "items": [ {} ] }

Anfrage

Ruft ein angegebenes Bundle ab.

Sicherheit
AuthForClient
Pfad
project_idintegererforderlich

Projekt-ID.

Beispiel: 44056
skustringerforderlich

Bundle-SKU.

Beispiel: 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>'

Antworten

Das angegebene Bundle wurde erfolgreich empfangen.

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

Liste der dem Artikel zugeordneten Attribute und deren Werte. Kann für die Katalogfilterung verwendet werden.

Standard []
attributes[].​external_idstring(Catalog_admin-attribute-external_id)[ 1 .. 255 ] characters^[a-zA-Z0-9-_]+$

Eindeutige Attribut-ID. Die external_id darf nur lateinische alphanumerische Kleinbuchstaben, Bindestriche und Unterstriche enthalten.

Beispiel: "attribute_1"
attributes[].​namestring

Name des Attributs.

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

Eindeutige Wert-ID für ein Attribut. Die external_id darf nur lateinische alphanumerische Kleinbuchstaben, Bindestriche und Unterstriche enthalten.

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

Wert des Attributs.

Beispiel: "Strategy"
bundle_typestring(Catalog_bundle_type)

Bundle-Typ. In diesem Fall immer standart.

Beispiel: "standart"
contentArray of objects(Catalog_client_content)

Paketinhalt des Bundles.

Beispiel: [{"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

Artikelbeschreibung.

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

Bild-URL.

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

Artikelname.

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

Artikelpreise.

content[].​price.​amountstring

Rabattierter Artikelpreis.

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

Artikelpreis.

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

Standardkaufwährung. Code, bestehend aus drei Buchstaben, gemäß ISO 4217.

Beispiel: "USD"
content[].​quantityinteger

Artikelmenge in einem Paket.

Beispiel: 250
content[].​skustring

Eindeutige Artikel-ID. Die SKU darf nur lateinische alphanumerische Kleinbuchstaben, Bindestriche und Unterstriche enthalten.

Beispiel: "big_rocket"
content[].​typestring

Artikeltyp: virtual_good/virtual_currency/bundle.

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

Virtuelle Preise.

content[].​virtual_prices[].​amountinteger

Rabattierter Artikelpreis in virtueller Währung.

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

Artikelpreis.

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

Beschreibung der virtuellen Währung.

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

Bild der virtuellen Währung.

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

Ob der Preis für einen Artikel voreingestellt ist.

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

Name der virtuellen Währung.

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

Artikel-SKU der virtuellen Währung.

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

Typ der virtuellen Währung.

Beispiel: "virtual_currency"
descriptionstring or null(Catalog_client_description)

Artikelbeschreibung.

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

Gruppen, zu denen der Artikel gehört.

Standard []
Beispiel: [{"external_id":"horror","name":{"en":"Horror"}}]
groups[].​external_idstring
Beispiel: "horror"
groups[].​nameobject
Beispiel: {"en":"Horror"}
image_urlstring or null(Catalog_image_url)

Bild-URL.

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

Immer false.

Standard "false"
Beispiel: "false"
namestring(Catalog_client_name)

Artikelname.

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

Artikelpreis.

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

Rabattierter Artikelpreis.

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

Artikelpreis.

Beispiel: "100.99"
price.​currencystring(Catalog_currency)erforderlich

Kaufwährung. Code, bestehend aus drei Buchstaben, gemäß ISO 4217.

Beispiel: "USD"
skustring(Catalog_sku)

Eindeutige Artikel-ID. Die SKU darf nur lateinische alphanumerische Kleinbuchstaben, Punkte, Bindestriche und Unterstriche enthalten.

Beispiel: "bundle_1"
total_content_priceobject or null(Catalog_total_content_price)

Summe der einzelnen Preise der Bundle-Inhalte.

total_content_price.​amountstring

Rabattierte Summe der einzelnen Preise der Bundle-Inhalte.

Beispiel: "100.99"
total_content_price.​amount_without_discountstring

Summe der einzelnen Preise der Bundle-Inhalte.

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

Kaufwährung. Code, bestehend aus drei Buchstaben, gemäß ISO 4217.

Beispiel: "USD"
typestring(Catalog_type)

Artikeltyp.

Beispiel: "bundle"
virtual_pricesArray of objects(Catalog_virtual_prices)

Virtuelle Preise.

virtual_prices[].​amountinteger

Rabattierter Artikelpreis in virtueller Währung.

Beispiel: 100
virtual_prices[].​amount_without_discountinteger

Artikelpreis in virtueller Währung.

Beispiel: 200
virtual_prices[].​descriptionstring or null

Beschreibung der virtuellen Währung.

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

Bild der virtuellen Währung.

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

Ob der Preis für einen Artikel voreingestellt ist.

Beispiel: true
virtual_prices[].​namestring

Name der virtuellen Währung.

Beispiel: "Gold"
virtual_prices[].​skustring

Artikel-SKU der virtuellen Währung.

Beispiel: "gold"
virtual_prices[].​typestring

Typ der virtuellen Währung.

Beispiel: "virtual_currency"
Antwort
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": [] }
Operationen
Operationen
Operationen