Zum Inhalt springen
/
Gutschein zur Kampagne hi...

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

Gutscheine

Operationen

Kampagne erstellen

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.

Bodyapplication/jsonerforderlich
campaign_codestringerforderlich

Kampagnenname.

campaign_namesobjecterforderlich

Objekt, das lokalisierte Kampagnennamen enthält.

campaign_names.​arstring

Arabisch.

campaign_names.​bgstring

Bulgarisch.

campaign_names.​cnstring

Chinesisch (vereinfacht).

campaign_names.​csstring

Tschechisch.

campaign_names.​destring

Deutsch.

campaign_names.​enstring

Englisch.

campaign_names.​esstring

Spanisch.

campaign_names.​frstring

Französisch.

campaign_names.​hestring

Hebräisch.

campaign_names.​itstring

Italienisch.

campaign_names.​jastring

Japanisch.

campaign_names.​kostring

Koreanisch.

campaign_names.​plstring

Polnisch.

campaign_names.​ptstring

Portugiesisch.

campaign_names.​rostring

Rumänisch.

campaign_names.​rustring

Russisch.

campaign_names.​thstring

Thai.

campaign_names.​trstring

Türkisch.

campaign_names.​twstring

Chinesisch (traditionell).

campaign_names.​vistring

Vietnamesisch.

campaign_redeems_count_for_userinteger

Maximale Anzahl der Gutscheine, die ein Benutzer innerhalb einer Kampagne einlösen kann. Wenn null bestanden wurde, ist die Anzahl Gutscheine unbeschränkt.

expiration_datestring(datetime)

Das Ablaufdatum im YYYY-MM-DD’T’HH:MM:SS-Format laut ISO 8601.

project_idintegererforderlich

Projekt-ID.

redeems_countinteger

Maximale Anzahl der Gutscheine zum Einlösen. Wenn null bestanden wurde, ist die Anzahl Gutscheine unbeschränkt.

redeems_count_for_userinteger

Maximale Anzahl der einlösbaren Gutscheine pro Nutzer. Wenn null übermittelt wurde, ist die Anzahl der einlösbaren Gutscheine unbeschränkt.

subscription_couponobject

Objekt, das die Abo-Parameter einer Belohnung enthält.

subscription_coupon.​plan_idintegererforderlich

ID des Abo-Modells.

subscription_coupon.​product_idintegererforderlich

ID des abonnementbasierten Produkts.

subscription_coupon.​trial_periodintegererforderlich

Probezeitraum in Tagen.

virtual_currency_amountnumber(float)

Betrag der virtuellen Währung in einer Belohnung.

virtual_itemsobject

Array von virtuellen Gegenständen in einer Belohnung.

virtual_items.​quantityintegererforderlich

Menge der virtuellen Gegenstände.

virtual_items.​skustringerforderlich

SKU des virtuellen Gegenstands

curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/subscriptions/merchants/{merchant_id}/coupon_promotions' \
  -H 'Content-Type: application/json' \
  -d '{
    "campaign_code": "sample_campaign",
    "campaign_names": {
      "en": "Campaign Name",
      "ru": "Название кампании"
    },
    "campaign_redeems_count_for_user": 1,
    "expiration_date": "2019-12-31",
    "project_id": 12345,
    "redeems_count": 10,
    "redeems_count_for_user": 1,
    "subscription_coupon": {
      "plan_id": 123,
      "product_id": 456,
      "trial_period": 30
    },
    "virtual_currency_amount": 200
  }'

Antworten

Created.

Bodyapplication/json
idinteger
Beispiel: 9134
Antwort
application/json
{
  "id": 9134
}

Gutschein zur Kampagne hinzufügen

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.

campaign_idintegererforderlich

Kampagnen-ID.

Bodyapplication/jsonerforderlich
coupon_codestringerforderlich

Gutscheincode.

Beispiel: "34bryrb3"
curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/subscriptions/merchants/{merchant_id}/coupon_promotions/{campaign_id}/coupons' \
  -H 'Content-Type: application/json' \
  -d '{
    "coupon_code": "34bryrb3"
  }'

Antworten

No Content (Kein Inhalt).

Kampagne mit einer Werbeaktion verbinden

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.

Bodyapplication/jsonerforderlich
campaignsArray of integerserforderlich

Array von Kampagnen-IDs.

Beispiel: [9135]
curl -i -X PUT \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}/coupons' \
  -H 'Content-Type: application/json' \
  -d '{
    "campaigns": [
      9135
    ]
  }'

Antworten

No Content (Kein Inhalt).

Subscription management

Operationen