Zum Inhalt springen
/
Werbeaktion überprüfen

Subscriptions API (2.0)

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

Token

Operationen

Abo-Modelle

Operationen

Produkte

Operationen

Subscription management

Operationen

Zahlungen

Operationen

Werbeaktionen

Operationen

Geltungszeiträume festlegen

Anfrage

Ruft die Liste der Projekte des Händlers ab. Wenn die Aktion schreibgeschützt ist(read_only = true), können Sie die Prämien nicht aktualisieren.

Bemerkung

Dieser API-Aufruf enthält nicht den Pfadparameter project_id, Sie müssen also den API-Schlüssel verwenden, der in allen Projekten des Unternehmens gültig ist, um die Autorisierung einzurichten.

Sicherheit
basicAuth
Pfad
merchant_idintegererforderlich

Händler-ID.

promotion_idintegererforderlich

ID der Werbeaktion.

Bodyapplication/jsonerforderlich
periodsArray of objects

Datumsbereiche/Zeiträume.

periods[].​fromstring(datetime)

Beginn des Zeitraums.

periods[].​offsetstring

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

periods[].​tostring(datetime)

Ende des Zeitraums.

curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/periods' \
  -H 'Content-Type: application/json' \
  -d '{
    "periods": [
      {
        "from": "2019-03-02T00:00:00+04:00",
        "to": "2019-04-02T00:00:00+04:00"
      }
    ]
  }'

Antworten

No Content (Kein Inhalt).

Werbeaktion überprüfen

Anfrage

Ruft die Liste der Projekte des Händlers ab. Diese Methode gibt die Liste der Fehler zurück, sofern welche vorhanden sind.

Bemerkung

Dieser API-Aufruf enthält nicht den Pfadparameter project_id, Sie müssen also den API-Schlüssel verwenden, der in allen Projekten des Unternehmens gültig ist, um die Autorisierung einzurichten.

Sicherheit
basicAuth
Pfad
merchant_idintegererforderlich

Händler-ID.

promotion_idintegererforderlich

ID der Werbeaktion.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/review'

Antworten

OK.

Bodyapplication/jsonArray [
componentstring
messagestring
]
Antwort
application/json
[
  {
    "component": "rewards",
    "message": "Please select a reward"
  }
]

Belohnungen abrufen

Anfrage

Ruft die Liste der Projekte des Händlers ab.

Bemerkung

Dieser API-Aufruf enthält nicht den Pfadparameter project_id, Sie müssen also den API-Schlüssel verwenden, der in allen Projekten des Unternehmens gültig ist, um die Autorisierung einzurichten.

Sicherheit
basicAuth
Pfad
merchant_idintegererforderlich

Händler-ID.

promotion_idintegererforderlich

ID der Werbeaktion.

curl -i -X GET \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/rewards'

Antworten

OK.

Bodyapplication/json
idinteger
itemobject

Legt die Belohnung für bestimmte virtuelle Gegenstände fest.

item.​bonusArray of objects

Zusätzliche virtuelle Gegenstände, die als Bonus verteilt werden.

item.​bonus[].​idinteger
item.​bonus[].​localized_namestring

Name des Abo-Modells in der Standardsprache (en), repliziert den Wert name.en.

item.​bonus[].​quantityinteger

Anzahl der virtuellen Gegenstände, die als Bonus verteilt werden.

item.​bonus[].​skustring

SKU des Gegenstands.

item.​discountArray of objects

Rabatte für bestimmte virtuelle Gegenstände.

item.​discount[].​discount_percentnumber(float)

Prozentualer Rabatt.

item.​discount[].​localized_namestring

Name des Abo-Modells in der Standardsprache (en), repliziert den Wert name.en.

item.​discount[].​max_amountnumber(integer)

Maximale Anzahl an Gegenständen, die für die Werbeaktion verwendet wird.

item.​discount[].​skustring

SKU des Gegenstands.

packageobject

Legt die Belohnung für ein virtuelles Währungspaket fest.

package.​bonus_amountnumber(float)

Belohnung als absolute Menge der virtuellen Währung.

package.​bonus_percentnumber(float)

Belohnung als Prozentsatz der Paketmenge.

purchaseobject

Legt die Belohnung für den gesamten Einkauf fest.

purchase.​discount_percentnumber(float)

Prozentualer Rabatt.

subscriptionobject

Legt die Belohnung für ein Abonnement fest.

subscription.​trial_daysinteger

Probezeitraum in Tagen.

Antwort
application/json
{
  "id": 17840,
  "item": {
    "bonus": [ … ],
    "discount": [ … ]
  },
  "package": {
    "bonus_amount": 5,
    "bonus_percent": 5
  },
  "purchase": {
    "discount_percent": 10
  },
  "subscription": {
    "trial_days": 30
  }
}

Gutscheine

Operationen

Subscription management

Operationen