Zum Inhalt springen
/
Spiel für den Katalog abr...

Digital Distribution Hub (1.0.0)

Ü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
index.json
index.yaml
Sprachen
Server
https://store.xsolla.com/api/
Mock server
https://xsolla.redocly.app/_mock/de/api/digital-distribution-hub/

Warenkorb

Operationen

Spielschlüssel

Operationen

Liste der Spiele auf einer Plattform anhand von angegebener Gruppe abrufen

Anfrage

Ruft eine Liste von Spielen auf einer Plattform aus der angegebenen Gruppe 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. Verwenden Sie die Felder limit und offset, um mehr Daten pro Seite abzurufen.
Sicherheit
AuthForClient
Pfad
project_idintegererforderlich

Projekt-ID.

Beispiel: 44056
external_idstringerforderlich

external ID der Gruppe.

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

Antworten

Die Liste der Spiele auf einer Plattform wurde erfolgreich empfangen.

Bodyapplication/json
itemsArray of objects(Catalog_inline_response_200_3_items)
Beispiel: [{"attributes":{"$ref":"#/components/examples/client-attribute-game-horror/Catalog_value"},"description":"Game description","drm_name":"Steam","drm_sku":"steam","groups":[{"external_id":"all","name":"All games"},{"external_id":"Xsolla","name":"Xsolla games"}],"has_keys":true,"image_url":"https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png","is_free":false,"is_pre_order":true,"name":"Game name","price":{"amount":"30.5","amount_without_discount":"30.5","currency":"USD"},"release_date":"2020-08-11T10:00:00+03:00","sku":"game_1","type":"game_key","virtual_prices":[]},{"attributes":{"$ref":"#/components/examples/client-attribute-game-horror/Catalog_value"},"description":"Game description","drm_name":"Steam","drm_sku":"steam","groups":[{"external_id":"all","name":"All games"}],"has_keys":true,"image_url":"https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png","is_free":false,"is_pre_order":false,"name":"Game name","price":{"amount":"30.5","amount_without_discount":"30.5","currency":"USD"},"sku":"game_2","type":"game_key","virtual_prices":[]}]
items[].​attributesArray of objects(Catalog_client-attributes)

Liste der dem Spiel zugeordneten Attribute und deren Werte.

Achtung: Dieser Teil der Antwort ist nur verfügbar, wenn Sie den Abfrageparameter "additional_fields[]=attributes" senden.
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[].​descriptionstring

Artikelbeschreibung.

Beispiel: "Game description"
items[].​drm_namestring

DRM-Name.

Beispiel: "Steam"
items[].​drm_skustring

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

Beispiel: "steam"
items[].​groupsArray of objects(Catalog_inline_response_200_groups)

Gruppen, zu denen der Artikel gehört.

Beispiel: [{"external_id":"all","name":"All games"},{"external_id":"Xsolla","name":"Xsolla game"}]
items[].​groups[].​external_idstring
Beispiel: "accessory"
items[].​groups[].​namestring
Beispiel: "Accessory"
items[].​has_keysboolean

Sofern true festgelegt ist, lassen sich Spielschlüssel auf dieser Plattform kaufen.

Beispiel: false
items[].​image_urlstring

Bild-URL.

Beispiel: "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png"
items[].​is_freeboolean

Ist true festgelegt, ist der Artikel kostenlos.

Beispiel: false
items[].​is_pre_orderboolean

Sofern true festgelegt ist, lassen sich Spielschlüssel auf dieser Plattform vorbestellen und der Release-Termin steht noch bevor.

Beispiel: true
items[].​namestring

Artikelname.

Beispiel: "Game name"
items[].​priceobject(Catalog_inline_response_200_price)

Artikelpreise.

items[].​price.​amountstring

Rabattierter Artikelpreis.

Beispiel: "2.9900"
items[].​price.​amount_without_discountstring

Artikelpreis.

Beispiel: "2.9900"
items[].​price.​currencystring

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

Beispiel: "USD"
items[].​release_datestring

Release-Termin des Spiels auf der Plattform im ISO-8601-Format.

Beispiel: "2020-08-11T10:00:00+03:00"
items[].​skustring

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

Beispiel: "game_01"
items[].​typestring

Artikeltyp: game_key.

Beispiel: "game_key"
items[].​virtual_pricesArray of objects(Catalog_inline_response_200_virtual_prices)

Virtuelle Preise.

items[].​virtual_prices[].​amountinteger

Rabattierter Artikelpreis in virtueller Währung.

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

Artikelpreis.

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

Beschreibung der virtuellen Währung.

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

Bild der virtuellen Währung.

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

Ob der Preis für den Artikel voreingestellt ist.

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

Name der virtuellen Währung.

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

Artikel-SKU der virtuellen Währung.

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

Typ der virtuellen Währung.

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

Spiel für den Katalog abrufen

Anfrage

Ruft ein Spiel für den Katalog ab.

Sicherheit
AuthForClient
Pfad
project_idintegererforderlich

Projekt-ID.

Beispiel: 44056
item_skustringerforderlich

Artikel-SKU.

Beispiel: booster_mega_1
Abfrage
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/game/key/sku/booster_mega_1?locale=en&additional_fields%5B%5D=string&country=US' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Antworten

Spiel 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"
descriptionstring

Artikelbeschreibung.

Beispiel: "Game description"
drm_namestring

DRM-Name.

Beispiel: "Steam"
drm_skustring

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

Beispiel: "steam"
groupsArray of objects(Catalog_inline_response_200_groups)

Gruppen, zu denen der Artikel gehört.

Beispiel: [{"external_id":"all","name":"All games"},{"external_id":"Xsolla","name":"Xsolla games"}]
groups[].​external_idstring
Beispiel: "accessory"
groups[].​namestring
Beispiel: "Accessory"
has_keysboolean

Sofern true festgelegt ist, lassen sich Spielschlüssel auf dieser Plattform kaufen.

Beispiel: true
image_urlstring

Bild-URL.

Beispiel: "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png"
is_freeboolean

Ist true festgelegt, ist der Artikel kostenlos.

Beispiel: false
is_pre_orderboolean

Sofern true festgelegt ist, lassen sich Spielschlüssel auf dieser Plattform vorbestellen und der Release-Termin steht noch bevor.

Beispiel: true
namestring

Artikelname.

Beispiel: "Game name"
priceobject(Catalog_inline_response_200_price)

Artikelpreise.

price.​amountstring

Rabattierter Artikelpreis.

Beispiel: "2.9900"
price.​amount_without_discountstring

Artikelpreis.

Beispiel: "2.9900"
price.​currencystring

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

Beispiel: "USD"
release_datestring

Release-Termin des Spiels auf der Plattform im ISO-8601-Format.

Beispiel: "2020-08-11T10:00:00+03:00"
skustring

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

Beispiel: "game_1"
typestring

Artikeltyp: game_key.

Beispiel: "game_key"
virtual_pricesArray of objects(Catalog_inline_response_200_virtual_prices)

Virtuelle Preise.

Beispiel: []
virtual_prices[].​amountinteger

Rabattierter Artikelpreis in virtueller Währung.

Beispiel: 100
virtual_prices[].​amount_without_discountinteger

Artikelpreis.

Beispiel: 200
virtual_prices[].​descriptionstring

Beschreibung der virtuellen Währung.

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

Bild der virtuellen Währung.

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

Ob der Preis für den Artikel voreingestellt ist.

Beispiel: true
virtual_prices[].​namestring

Name der virtuellen Währung.

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

Artikel-SKU der virtuellen Währung.

Beispiel: "vc_test"
virtual_prices[].​typestring

Typ der virtuellen Währung.

Beispiel: "virtual_currency"
Antwort
application/json
{
  "attributes": {
    "$ref": "#/components/examples/client-attribute-game-horror/Catalog_value"
  },
  "description": "Game description",
  "drm_name": "Steam",
  "drm_sku": "steam",
  "groups": [
    { … },
    { … }
  ],
  "has_keys": true,
  "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
  "is_free": false,
  "is_pre_order": true,
  "name": "Game name",
  "price": {
    "amount": "30.5",
    "amount_without_discount": "30.5",
    "currency": "USD"
  },
  "release_date": "2020-08-11T10:00:00+03:00",
  "sku": "game_1",
  "type": "game_key",
  "virtual_prices": []
}

Spiel für den Katalog abrufen

Anfrage

Ruft ein Spiel für den Katalog ab.

Sicherheit
AuthForClient
Pfad
project_idintegererforderlich

Projekt-ID.

Beispiel: 44056
item_skustringerforderlich

Artikel-SKU.

Beispiel: booster_mega_1
Abfrage
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/game/sku/booster_mega_1?locale=en&additional_fields%5B%5D=string&country=US' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Antworten

Spiel wurde erfolgreich empfangen.

Bodyapplication/json
attributesArray of objects(Catalog_client-attributes)

Liste der dem Spiel zugeordneten Attribute und deren Werte.

Achtung: Dieser Teil der Antwort ist nur verfügbar, wenn Sie den Abfrageparameter "additional_fields[]=attributes" senden.
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"
descriptionstring

Artikelbeschreibung.

Beispiel: "Game description"
groupsArray of objects(Catalog_inline_response_200_groups)

Gruppen, zu denen der Artikel gehört.

Beispiel: [{"external_id":"all","name":"All games"},{"external_id":"Xsolla","name":"Xsolla games"}]
groups[].​external_idstring
Beispiel: "accessory"
groups[].​namestring
Beispiel: "Accessory"
image_urlstring

Bild-URL.

Beispiel: "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png"
namestring

Artikelname.

Beispiel: "Game name"
skustring

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

Beispiel: "game_1"
typestring

Artikeltyp: virtual_good/virtual_currency/bundle/physical_good/unit.

Beispiel: "unit"
unit_itemsArray of objects(Catalog_inline_response_200_unit_items)
Beispiel: [{"drm_name":"Steam","drm_sku":"steam","has_keys":true,"is_free":false,"is_pre_order":true,"price":{"amount":"30.5","amount_without_discount":"30.5","currency":"USD"},"release_date":"2020-08-11T10:00:00+03:00","sku":"game_key_01","type":"game_key","virtual_prices":[]},{"drm_name":"Origin","drm_sku":"origin","has_keys":false,"is_free":false,"is_pre_order":false,"price":{"amount":"30.5","amount_without_discount":"30.5","currency":"USD"},"sku":"game_key_02","type":"game_key","virtual_prices":[]}]
unit_items[].​drm_namestring

DRM-Name.

Beispiel: "Steam"
unit_items[].​drm_skustring

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

Beispiel: "steam"
unit_items[].​has_keysboolean

Sofern true festgelegt ist, lassen sich Spielschlüssel auf dieser Plattform kaufen.

Beispiel: false
unit_items[].​is_freeboolean

Ist true festgelegt, ist der Artikel kostenlos.

Beispiel: false
unit_items[].​is_pre_orderboolean

Sofern true festgelegt ist, lassen sich Spielschlüssel auf dieser Plattform vorbestellen und der Release-Termin steht noch bevor.

Beispiel: true
unit_items[].​priceobject(Catalog_inline_response_200_price)

Artikelpreise.

unit_items[].​price.​amountstring

Rabattierter Artikelpreis.

Beispiel: "2.9900"
unit_items[].​price.​amount_without_discountstring

Artikelpreis.

Beispiel: "2.9900"
unit_items[].​price.​currencystring

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

Beispiel: "USD"
unit_items[].​release_datestring

Release-Termin des Spiels auf der Plattform im ISO-8601-Format.

Beispiel: "2020-08-11T10:00:00+03:00"
unit_items[].​skustring

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

Beispiel: "game_01"
unit_items[].​typestring

Artikeltyp: game_key.

Beispiel: "game_key"
unit_items[].​virtual_pricesArray of objects(Catalog_inline_response_200_virtual_prices)

Virtuelle Preise.

unit_items[].​virtual_prices[].​amountinteger

Rabattierter Artikelpreis in virtueller Währung.

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

Artikelpreis.

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

Beschreibung der virtuellen Währung.

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

Bild der virtuellen Währung.

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

Ob der Preis für den Artikel voreingestellt ist.

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

Name der virtuellen Währung.

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

Artikel-SKU der virtuellen Währung.

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

Typ der virtuellen Währung.

Beispiel: "virtual_currency"
unit_typestring

Einheiten-Typ: game.

Beispiel: "game"
Antwort
application/json
{
  "attributes": {
    "$ref": "#/components/examples/client-attribute-game/Catalog_value"
  },
  "description": "Game description",
  "groups": [
    { … },
    { … }
  ],
  "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png",
  "name": "Game name",
  "sku": "game_1",
  "type": "unit",
  "unit_items": [
    { … },
    { … }
  ],
  "unit_type": "game"
}

Virtuelle Gegenstände und Währung

Operationen

Bundles

Operationen

Benutzertoken

Operationen

Benachrichtigungen

Operationen

Bestellung

Operationen