Zum Inhalt springen

Überblick

  • Version: 2.0
  • Servers: https://api.xsolla.com/merchant/v2/

Diese API-Referenz beschreibt Endpunkte für die Verwaltung von Abonnements, Gutscheinen und Werbeaktionen. Weitere Informationen über Subscriptions finden Sie in der Produktanleitung und in der Begriffserläuterung.

OpenAPI-Beschreibung herunterladen
Sprachen
Server
Mock server
https://xsolla.redocly.app/_mock/de/api/subscriptions/
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen
Operationen

Anfrage

Fordert nähere Informationen zum Gutschein mit Hilfe seines Codes an.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

Projekt-ID.

codestringerforderlich

Gutscheincode.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/subscriptions/projects/{project_id}/coupons/{code}/details'

Antworten

OK.

Bodyapplication/json
keystring

Schlüssel des Benutzerattributs.

list_of_valuesArray of objects

Mögliche Werte für type=enum (Array).

nameobject

Lokalisierte Attributbezeichnungen.

skip_condition_on_nonexistent_keyboolean

Legt fest, ob die Bedingung bei nicht vorhandenem Schlüssel übersprungen wird.

typestring

Schlüsseltyp.

Enum"int""string""enum""date"
visibleboolean
Antwort
application/json
{ "key": "12", "list_of_values": [], "name": { "en": "Level", "ru": "Уровень" }, "skip_condition_on_nonexistent_key": true, "type": "int", "visible": false }

Anfrage

Einen Gutschein mittels seines Codes einlösen.

Sicherheit
basicAuth
Pfad
project_idintegererforderlich

Projekt-ID.

codestringerforderlich

Gutscheincode.

Bodyapplication/jsonerforderlich
user_idstringerforderlich

Benutzer-ID.

Beispiel: "1234"
curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/subscriptions/projects/{project_id}/coupons/{code}/redeem' \
  -H 'Content-Type: application/json' \
  -d '{
    "user_id": "1234"
  }'

Antworten

OK.

Bodyapplication/json
campaign_codestring
coupon_codestring
coupon_idinteger
expiration_datestring
is_activeboolean
project_idinteger
redeems_count_for_userinteger
redeems_count_remaininteger
subscription_couponstring or null
virtual_currency_amountinteger
virtual_itemsArray of strings
Antwort
application/json
{ "campaign_code": "new_campaign", "coupon_code": "ddgf5bn4", "coupon_id": 89613996, "expiration_date": "2019-12-31T00:00:00+00:00", "is_active": true, "project_id": 12345, "redeems_count_for_user": 10, "redeems_count_remain": 20, "subscription_coupon": null, "virtual_currency_amount": 200, "virtual_items": [] }
Operationen