Zum Inhalt springen
/
Werbeaktion anlegen

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

Liste der Werbeaktionen 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.

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

Antworten

OK.

Bodyapplication/json
Antwort
application/json
[
  {
    "datetime": { … },
    "enabled": true,
    "id": 17840,
    "is_active": true,
    "is_infinite": false,
    "project": { … },
    "read_only": false,
    "technical_name": "christmas"
  },
  {
    "datetime": null,
    "enabled": false,
    "id": 17891,
    "is_active": false,
    "is_infinite": true,
    "project": { … },
    "read_only": false,
    "technical_name": "Sale promotion"
  }
]

Werbeaktion anlegen

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
descriptionobject

Array der lokalisierten Werbeaktionsbeschreibungen.

description.​arstring

Arabisch.

description.​bgstring

Bulgarisch.

description.​cnstring

Chinesisch (vereinfacht).

description.​csstring

Tschechisch.

description.​destring

Deutsch.

description.​enstring

Englisch.

description.​esstring

Spanisch.

description.​frstring

Französisch.

description.​hestring

Hebräisch.

description.​itstring

Italienisch.

description.​jastring

Japanisch.

description.​kostring

Koreanisch.

description.​plstring

Polnisch.

description.​ptstring

Portugiesisch.

description.​rostring

Rumänisch.

description.​rustring

Russisch.

description.​thstring

Thai.

description.​trstring

Türkisch.

description.​twstring

Chinesisch (traditionell).

description.​vistring

Vietnamesisch.

labelobject

Array der lokalisierten Kennzeichnungen, die im Zahlungsportal angezeigt werden.

label.​arstring

Arabisch.

label.​bgstring

Bulgarisch.

label.​cnstring

Chinesisch (vereinfacht).

label.​csstring

Tschechisch.

label.​destring

Deutsch.

label.​enstring

Englisch.

label.​esstring

Spanisch.

label.​frstring

Französisch.

label.​hestring

Hebräisch.

label.​itstring

Italienisch.

label.​jastring

Japanisch.

label.​kostring

Koreanisch.

label.​plstring

Polnisch.

label.​ptstring

Portugiesisch.

label.​rostring

Rumänisch.

label.​rustring

Russisch.

label.​thstring

Thai.

label.​trstring

Türkisch.

label.​twstring

Chinesisch (traditionell).

label.​vistring

Vietnamesisch.

nameobject

Array der lokalisierten Bezeichnungen der Werbeaktion.

name.​arstring

Arabisch.

name.​bgstring

Bulgarisch.

name.​cnstring

Chinesisch (vereinfacht).

name.​csstring

Tschechisch.

name.​destring

Deutsch.

name.​enstring

Englisch.

name.​esstring

Spanisch.

name.​frstring

Französisch.

name.​hestring

Hebräisch.

name.​itstring

Italienisch.

name.​jastring

Japanisch.

name.​kostring

Koreanisch.

name.​plstring

Polnisch.

name.​ptstring

Portugiesisch.

name.​rostring

Rumänisch.

name.​rustring

Russisch.

name.​thstring

Thai.

name.​trstring

Türkisch.

name.​twstring

Chinesisch (traditionell).

name.​vistring

Vietnamesisch.

project_idintegererforderlich

Projekt-ID.

technical_namestringerforderlich

Arbeitstitel der Werbeaktion.

enabledboolean
idinteger
read_onlyboolean
show_bannerboolean
curl -i -X POST \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/subscriptions/merchants/{merchant_id}/promotions' \
  -H 'Content-Type: application/json' \
  -d '{
    "description": {
      "en": "Promotion with 30% discount",
      "ru": "Акция со скидкой 30%"
    },
    "label": {
      "en": "30%",
      "ru": "30%"
    },
    "name": {
      "en": "30% discount",
      "ru": "скидка 30%"
    },
    "project_id": 12345,
    "technical_name": "Sale promotion"
  }'

Antworten

Created.

Bodyapplication/json
idinteger

ID der Werbeaktion.

Antwort
application/json
{
  "id": 17890
}

Werbeaktion löschen

Anfrage

Ruft die Liste der Projekte des Händlers ab enabled =false.

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 DELETE \
  -u <username>:<password> \
  'https://xsolla.redocly.app/_mock/de/api/subscriptions/merchants/{merchant_id}/promotions/{promotion_id}'

Antworten

No Content (Kein Inhalt).

Gutscheine

Operationen

Subscription management

Operationen