Zum Inhalt springen
/
Kampagne mit einer Werbea...

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

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).

Gutschein anfordern

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
}

Subscription management

Operationen