Artikel-SKU.
/
Spiel für den Katalog abr...
Catalog API (2.0.0)
- Version: 2.0.0
- Servers:
https://store.xsolla.com/api - Contact Us by Email
- Contact URL: https://xsolla.com/
- Required TLS version: 1.2
Catalog API bietet Endpunkte zur Verwaltung Ihres In-Game-Store-Katalogs und zur Abwicklung von Käufen. Verwenden Sie die Endpunkte zum Konfigurieren von virtuellen Gegenständen, virtuellen Währungen, Spielschlüsseln, Bundles, Warenkorb- und Zahlungsabläufen sowie Artikelattributen und zum Importieren von Artikeln aus externen Quellen.
OpenAPI-Beschreibung herunterladen
Sprachen
Server
Mock server
https://xsolla.redocly.app/_mock/de/api/catalog/
https://store.xsolla.com/api/
Anfrage
Ruft einen Spielschlüssel für den Katalog ab.
Hinweis
Auf diesen Endpunkt kann man ohne Autorisierung zugreifen, er gibt generische Daten zurück. Liegt eine Autorisierung vor, ist die Antwort jedoch mit benutzerspezifischen Details (z. B. vorhandene Nutzerlimits und Werbeaktionen) angereichert und sorgt so für ein personalisiertes Ergebnis.
Auf diesen Endpunkt kann man ohne Autorisierung zugreifen, er gibt generische Daten zurück. Liegt eine Autorisierung vor, ist die Antwort jedoch mit benutzerspezifischen Details (z. B. vorhandene Nutzerlimits und Werbeaktionen) angereichert und sorgt so für ein personalisiertes Ergebnis.
Sicherheit
XsollaLoginUserJWT
Pfad
Projekt-ID. Dieser Parameter wird im Kundenportal neben dem Projektnamen angezeigt.
Beispiel: 44056
Abfrage
Antwortsprache. Sprachcode bestehend aus zwei Kleinbuchstaben gemäß ISO 639-1.
Standard "en"
Die Liste der zusätzlichen Felder. Diese Felder sind in der Antwort enthalten, sofern Sie diese in der Anfrage senden.
Elemente Enum"media_list""order""long_description""custom_attributes""item_order_in_group"
Zweistelliger Ländercode in Großbuchstaben gemäß ISO 3166-1 Alpha-2. Weitere Informationen zu den von Xsolla unterstützten Ländern und dazu, wie das Land ermittelt wird, finden Sie in der Dokumentation.
Beispiel: country=US
Eindeutiger Code, es wird zwischen Groß- und Kleinschreibung unterschieden. Enthält Buchstaben und Ziffern.
Beispiel: promo_code=WINTER2021
- Mock serverhttps://xsolla.redocly.app/_mock/de/api/catalog/v2/project/{project_id}/items/game/key/sku/{item_sku}
- https://store.xsolla.com/api/v2/project/{project_id}/items/game/key/sku/{item_sku}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://xsolla.redocly.app/_mock/de/api/catalog/v2/project/44056/items/game/key/sku/{item_sku}?locale=en&additional_fields%5B%5D=media_list&country=US&promo_code=WINTER2021&show_inactive_time_limited_items=1' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Spielschlüssel wurde erfolgreich empfangen.
Liste der Attribute und ihrer Werte, die dem Artikel zugeordnet sind. Kann für die Katalogfilterung verwendet werden.
Standard []
Beispiel: {"value":{"external_id":"genre","name":"Жанр","values":[{"external_id":"genre_e3364991f92e751689a68b96598a5a5a84010b85","value":"Casual"},{"external_id":"genre_eba07bfd0f982940773cba3744d97264dd58acd7","value":"Strategy"},{"external_id":"genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8","value":"Mobile"}]}}
Sofern true, kann der Nutzer einen Artikel kaufen.
Beispiel: true
Eindeutige DRM-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten.
Beispiel: "steam_key_1"
Gruppen, zu denen der Artikel gehört.
Standard []
Beispiel: [{"external_id":"exclusive","name":"Exclusive"}]
Ist true eingestellt, lassen sich Spielschlüssel auf der Plattform kaufen.
Beispiel: true
Bild-URL.
Beispiel: "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png"
Ist true eingestellt, ist der Artikel kostenlos.
Standard false
Beispiel: false
Ist true eingestellt, ist der Spielschlüssel vorbestellbar und der Release-Termin noch nicht verstrichen.
Beispiel: true
Artikelpreise.
Beispiel: {"amount":"30.5","amount_without_discount":"30.5","currency":"USD"}
Auf bestimmte Artikel im Warenkorb angewandte Werbeaktionen. Das array wird in den folgenden Fällen zurückgegeben:
Für einen bestimmten Artikel ist eine Rabattaktion konfiguriert.
Ein Promocode mit der Einstellung Rabatt auf ausgewählte Artikel ist angewandt.
Werden keine Werbeaktionen auf Artikelebene angewandt, wird ein leeres Array zurückgegeben.
Release-Termin des Spielschlüssels im Format ISO 8601.
Beispiel: "2020-08-11T10:00:00+03:00"
Eindeutige Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten.
Beispiel: "com.xsolla.game_1"
Antwort
application/json
{ "attributes": [ { … }, { … } ], "can_be_bought": true, "description": "Game description", "drm_name": "Steam", "drm_sku": "steam_key_1", "groups": [ { … }, { … } ], "has_keys": true, "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "is_free": false, "is_pre_order": true, "limits": null, "name": "Game name", "periods": [ { … } ], "price": { "amount": "30.5", "amount_without_discount": "30.5", "currency": "USD" }, "promotions": [], "release_date": "2020-08-11T10:00:00+03:00", "sku": "com.xsolla.game_1", "type": "game_key", "virtual_prices": [] }
Anfrage
Ruft ein Spiel für den Katalog ab.
Hinweis
Auf diesen Endpunkt kann man ohne Autorisierung zugreifen, er gibt generische Daten zurück. Liegt eine Autorisierung vor, ist die Antwort jedoch mit benutzerspezifischen Details (z. B. vorhandene Nutzerlimits und Werbeaktionen) angereichert und sorgt so für ein personalisiertes Ergebnis.
Auf diesen Endpunkt kann man ohne Autorisierung zugreifen, er gibt generische Daten zurück. Liegt eine Autorisierung vor, ist die Antwort jedoch mit benutzerspezifischen Details (z. B. vorhandene Nutzerlimits und Werbeaktionen) angereichert und sorgt so für ein personalisiertes Ergebnis.
Sicherheit
XsollaLoginUserJWT
Pfad
Projekt-ID. Dieser Parameter wird im Kundenportal neben dem Projektnamen angezeigt.
Beispiel: 44056
Abfrage
Antwortsprache. Sprachcode bestehend aus zwei Kleinbuchstaben gemäß ISO 639-1.
Standard "en"
Die Liste der zusätzlichen Felder. Diese Felder sind in der Antwort enthalten, sofern Sie diese in der Anfrage senden.
Elemente Enum"media_list""order""long_description""custom_attributes""item_order_in_group"
Zweistelliger Ländercode in Großbuchstaben gemäß ISO 3166-1 Alpha-2. Weitere Informationen zu den von Xsolla unterstützten Ländern und dazu, wie das Land ermittelt wird, finden Sie in der Dokumentation.
Beispiel: country=US
Eindeutiger Code, es wird zwischen Groß- und Kleinschreibung unterschieden. Enthält Buchstaben und Ziffern.
Beispiel: promo_code=WINTER2021
- Mock serverhttps://xsolla.redocly.app/_mock/de/api/catalog/v2/project/{project_id}/items/game/sku/{item_sku}
- https://store.xsolla.com/api/v2/project/{project_id}/items/game/sku/{item_sku}
- curl
- JavaScript
- Node.js
- Python
- Java
- C#
- PHP
- Go
- Ruby
- R
- Payload
curl -i -X GET \
'https://xsolla.redocly.app/_mock/de/api/catalog/v2/project/44056/items/game/sku/{item_sku}?locale=en&additional_fields%5B%5D=media_list&country=US&promo_code=WINTER2021&show_inactive_time_limited_items=1' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Das Spiel wurde erfolgreich empfangen.
Liste der Attribute und ihrer Werte, die dem Artikel zugeordnet sind. Kann für die Katalogfilterung verwendet werden.
Standard []
Beispiel: {"value":{"external_id":"genre","name":"Жанр","values":[{"external_id":"genre_e3364991f92e751689a68b96598a5a5a84010b85","value":"Casual"},{"external_id":"genre_eba07bfd0f982940773cba3744d97264dd58acd7","value":"Strategy"},{"external_id":"genre_b8d0c6d8f0524c2b2d79ebb93aa3cd0e8b5199a8","value":"Mobile"}]}}
Gruppen, zu denen der Artikel gehört.
Standard []
Beispiel: [{"external_id":"exclusive","name":"Exclusive"}]
Bild-URL.
Beispiel: "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png"
Auf bestimmte Artikel im Warenkorb angewandte Werbeaktionen. Das array wird in den folgenden Fällen zurückgegeben:
Für einen bestimmten Artikel ist eine Rabattaktion konfiguriert.
Ein Promocode mit der Einstellung Rabatt auf ausgewählte Artikel ist angewandt.
Werden keine Werbeaktionen auf Artikelebene angewandt, wird ein leeres Array zurückgegeben.
Eindeutige Artikel-ID. Die SKU darf nur lateinische Klein- und Großbuchstaben, Ziffern, Punkte, Bindestriche und Unterstriche enthalten.
Beispiel: "game_01"
Antwort
application/json
{ "attributes": [ { … }, { … } ], "description": "Game description", "groups": [ { … }, { … } ], "image_url": "https://cdn.xsolla.net/img/misc/images/b79342cdf24f0f8557b63c87e8326e62.png", "name": "Game name", "promotions": [], "sku": "com.xsolla.game_1", "type": "unit", "unit_items": [ { … }, { … } ], "unit_type": "game" }