Abonnementinformationen abrufen

Informationen über Abonnementaktivitäten lassen sich auf die folgenden Arten abrufen:

Über API-Aufrufe einrichten

Implementieren Sie im Client Ihrer Anwendung den Abruf von Informationen über Benutzerabonnements mithilfe einer HTTP-GET-Anfrage.

Xsolla-API nutzt HTTP-Authentifizierung. Die Anfrage muss im Header Authorization: Bearer <client_user_jwt> enthalten, wobei <client_user_jwt> ein eindeutiges, nach dem Base64-Xsolla-Standard kodiertes Token ist. Wie erhalten Sie es:

Hinweis
Um die Xsolla-API aufzurufen, können Sie die vorgefertigten SDK-Methoden für Spiel-Engines und Plattformen verwenden:

Geben Sie die Projekt-ID als Pfadparameter projectId an. Sie finden diesen Parameter im Kundenportal neben dem Projektnamen.

Legen Sie als Abfrageparameter Folgendes fest:

  • limit – Obergrenze für die Anzahl der Elemente pro Seite (standardmäßig werden 15 Elemente angezeigt).
  • offset – Elementnummer, bei der die Liste beginnt (die Zählung beginnt bei 0).
  • locale – Sprache der Benutzeroberfläche (standardmäßig ist Englisch voreingestellt). Eingabewerte müssen der Norm ISO 639-1 entsprechen.

Copy
Full screen
Small screen
Beispiel einer Anfrage:
  'https://subscriptions.xsolla.com​/api/user/v1/projects/{projectId}/subscriptions?locale=ru&limit=5&offset=5 ' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer client_user_jwt'

Copy
Full screen
Small screen
Antwortbeispiel:
{
  "items": [
    {
      "id": 11111111,
      "plan_id": 11111,
      "plan_external_id": "TestChangePlanBase",
      "plan_name": "package_recurrent_name_66053",
      "plan_description": "package_recurrent_description_66053",
      "product_id": null,
      "product_external_id": null,
      "product_name": null,
      "product_description": null,
      "status": "active",
      "date_create": "2021-03-11T13:50:11+03:00",
      "date_next_charge": "2031-04-11T13:51:02+03:00",
      "date_last_charge": "2021-03-11T13:51:02+03:00",
      "charge": {
        "amount": "0.2500",
        "currency": "USD"
      },
      "period": {
        "value": 1,
        "unit": "day"
      }
    }
  ],
  "has_more": true
}

Webhooks einrichten

Die Abonnements-Lösung unterstützt Webhooks für die folgenden Ereignisse:

Hinweis
Um ein Abonnement zu kündigen, muss die letzte Zahlung storniert werden. Wenn ein Benutzer sein Abonnement manuell verlängert und für mehrere Zeiträume bezahlt hat, muss er alle Zahlungen stornieren.

  • Erstattung:
    • Rückerstattung (Zahlung wurde im Kundenportal storniert)
    • Aktualisiertes Abonnement (Die Zahlung wurde storniert, das Abonnement ist aber noch aktiv. Das kann passieren, wenn der Benutzer versehentlich zweimal für das Abonnement bezahlt und nur die letzte Zahlung storniert hat.)
    • Gekündigtes Abonnement (Zahlung wurde im Kundenportal storniert oder alle Zahlungen wurden für alle gültigen Zeiträume storniert)

Hinweis
Weitere Informationen zu Webhooks finden Sie in unserer API-Dokumentation.

So richten Sie Webhooks ein:

  1. Navigieren Sie im Kundenportal zu Projekteinstellungen > Webhooks.
  2. Stellen Sie den Umschalter im Block Webhooks auf Ein.

  1. Geben Sie Ihre Webhook-URL an. Klicken Sie auf Einstellungen speichern.

  1. Testen Sie die Webhooks im Kundenportal.
  2. Testen Sie den Abonnementabschluss.
  3. Testen Sie die Abonnementverlängerung.
  4. Testen Sie die Abonnementkündigung.

Webhooks im Kundenportal testen

  1. Navigieren Sie zu Kundenportal > Projekteinstellungen > Webhooks, und wechseln Sie dort zur Registerkarte Abonnements.

  1. Um Webhooks zu testen, geben Sie Werte aus Ihrem Projekt (Benutzer-ID, Rechnungs-ID) an, die in einer Anfrage an die von Ihnen angegebene Webhook-URL gesendet werden sollen. Falls reale Werte fehlen, können Sie beliebige Werte eingeben. Füllen Sie die folgenden Formularfelder aus:

Hinweis
Im Kundenportal können Sie nur die grundlegenden Webhooks (Benutzervalidierung und Zahlung) testen. Wie Sie andere Webhook-Typen testen, erfahren Sie unter:

  1. Klicken Sie auf Test.
  2. Bestätigen Sie, dass Sie die Testnachricht erhalten haben. Sofern der Test erfolgreich ist, antwortet Ihr Server mit dem HTTP-Statuscode 204. Schlägt der Test fehl, antwortet Ihr Server entweder mit dem HTTP-Statuscode 400 oder 500 sowie einer Fehlerbeschreibung.

Abonnementabschluss testen

Beim Testen einer Zahlung werden die Webhooks Gekündigtes Abonnement, Zahlung und Abgeschlossenes Abonnement an die von Ihnen im Schritt Webhooks einrichten angegebene URL gesendet. Um das Zahlungsverfahren zu testen, können Sie:

Hinweis
Abonnements mit einem Probezeitraum lassen sich nur testen, indem man eine echte Zahlung vornimmt, da Sie in der Testumgebung kein Abrechnungskonto mit einem Abonnement verknüpfen können.

Testumgebung

  1. Rufen Sie einen Token für die Testumgebung ab. Übermitteln Sie den Wert 0 an den Probezeitraum-Parameter (trial_days).
  2. Wählen Sie die Zahlungsmethodengruppe Kredit-/Debitkarten aus.
  3. Geben Sie die Daten einer Testbankkarte ein. Geben Sie in den übrigen Felder beliebige Werte ein. Sie können auch falsche Daten (Kartennummer, Ablaufdatum oder CVV) angeben, um einen Fehler zu erzeugen.

Hinweis
In der Testumgebung können Sie nur Testbankkarten verwenden. Testzahlungen lassen sich in folgenden Währungen vornehmen: USD, EUR, RUB, GBP, AED, ALL, AMD, ARS, AUD, AZN, BGN, BRL, BYN, CAD, CHF, CLP, CNY, COP, CZK, DKK, DZD, EGP, GEL, HKD, HRK, HUF, IDR, ILS, INR, ISK, JPY, KES, KGS, KRW, KZT, MAD, MDL, MKD, MNT, MXN, MYR, NGN, PEN, PHP, PKR, PLN, RON, RSD, SAR, SEK, SGD, THB, TRY, TWD, UAH, UYU, UZS, VEF, VND, ZAR.

  1. Empfangen Sie die Benutzervalidierung-, Zahlung- und Aktualisiertes Abonnement-Webhooks unter der von Ihnen im Schritt Webhooks einrichten angegebenen URL.

Echte Zahlung

Um ein Abonnement mit einem Probezeitraum testweise abzuschließen, müssen Sie eine echte Zahlung vornehmen:

  1. Schließen Sie den Schritt Webhooks im Kundenportal testen ab, und aktivieren Sie das Abonnements-Modul.
  2. Unterzeichnen Sie eine Lizenzvereinbarung. Navigieren Sie dafür zu Kundenportal > Finanzen > Lizenzvereinbarung, füllen Sie das Formular aus, und warten Sie auf die Bestätigung.

Hinweis
Mit der Unterzeichnung der Lizenzvereinbarung wird der Verkauf von echten Abonnements aktiviert.

  1. Rufen Sie einen Token ab, um eine echte Zahlungen zu ermöglichen.

Achtung
Löschen Sie den Parameter "mode":"sandbox" aus der Tokenanfrage, bevor Sie damit beginnen, echte Zahlungen zu akzeptieren.

  1. Öffnen Sie das Zahlungsportal mit dem folgenden Link: https://secure.xsolla.com/paystation3/?access_token=ACCESS_TOKEN, wobei ACCESS_TOKEN dem im vorherigen Schritt erlangten Token entspricht.
  2. Wählen Sie die Zahlungsmethodengruppe Kredit-/Debitkarten.
  3. Geben Sie gültige Bankkartendaten ein.

Hinweis
Testbankkarten sind nur für die Testumgebung geeignet. Es wird empfohlen, Visa- und MasterCard-Karten zu verwenden, um echte Zahlungen zu testen.

  1. Empfangen Sie Benutzervalidierung-, Zahlung- und Aktualisiertes Abonnement-Webhooks über die von Ihnen im Schritt Webhooks einrichten angegebene Webhook-URL.
  2. Erstatten Sie Ihre Zahlung. Navigieren Sie dafür zu Kundenportal > Support > Transaktionssuche.
  3. Wählen Sie die testweise getätigte Transaktion aus, und klicken Sie auf die Schaltfläche Mehr (•••). Klicken Sie danach im Pop-up-Menü auf Erstatten (die Transaktion sollte den Status Abgeschlossen aufweisen). Daraufhin werden die Webhooks Gekündigtes Abonnement und Rückerstattung gesendet.

Abonnementverlängerung testen

Achtung
Nur verfügbar für Abonnements ohne Probezeitraum.

So testen Sie die Verlängerung eines Abonnements:

  1. Rufen Sie einen Token für die Testumgebung ab. Übermitteln Sie den Wert 0 an den Probezeitraum-Parameter (trial_days).
  2. Bezahlen Sie für das Abonnement mit einer beliebigen Zahlungsmethode.
  3. Öffnen Sie das Zahlungsportal erneut in der Testumgebung.
  4. Zahlen Sie erneut mit einer beliebigen Zahlungsmethode, um das Abonnement zu verlängern.
  5. Empfangen Sie die Webhooks Benutzervalidierung, Zahlung und Aktualisiertes Abonnement an der von Ihnen im Schritt Webhooks einrichten angegebenen Webhook-URL.

Abonnementkündigung testen

So testen Sie die Abonnementkündigung:

Suche anhand von Abonnements

  1. Navigieren Sie im Kundenportal zu Support > Abonnenten.
  2. Suchen Sie das zu kündigende Abonnement.
  3. Öffnen Sie das Abonnementstatusmenü und wählen Sie Folgendes aus:
    1. Kündigen und erstatten, um den Gekündigtes Abonnement- und den Rückerstattung-Webhook zu empfangen.
    2. Ohne Erstattung kündigen, um den Gekündigtes Abonnement-Webhook zu empfangen.

Suche anhand kürzlicher Transaktionen

  1. Navigieren Sie im Kundenportal zu Support > Transaktionssuche.
  2. Suchen Sie die kürzlich getätigten Transaktionen, die Sie stornieren möchten.
  3. Klicken Sie auf das Symbol Mehr (•••). Klicken Sie im Pop-up-Menü auf Erstatten, um den Gekündigtes Abonnement- und den Rückerstattung-Webhook zu empfangen.

Hinweis
Wenn für das Abonnement mehrfach bezahlt wurde, müssen alle Zahlungen storniert werden.

Über API-Aufrufe

Nutzen Sie den API-Aufruf Abonnement aktualisieren, um den Abonnementstatus in Gekündigt zu ändern und den Gekündigtes Abonnement-Webhook zu empfangen.

Zahlungsportal in der Testumgebung öffnen

Rufen Sie im aktivem sandbox-Modus einen Token ab, um das Zahlungsportal in der Testumgebung zu öffnen. Der Link mit dem erforderlichen Token lässt sich auf folgende Weisen abrufen:

Über das Kundenportal

  1. Testen Sie Webhooks im Kundenportal. Geben Sie den Wert 0 im Feld Probezeitraum ein, um ein Abonnement ohne Probezeitraum zu testen. Nachdem Sie eine Bestätigungsmeldung über einen erfolgreichen Test erhalten haben, wird ein Link mit dem erforderlichen Token unter der Überschrift URL der Testumgebung angezeigt.

  1. Klicken Sie auf den Link mit der Bezeichnung URL der Testumgebung.

Über einen API-Aufruf

  1. Übermitteln Sie die Parameter "settings":{"mode":"sandbox"} an die Methode Token erstellen. Übermitteln Sie die Parameter "purchase": {"subscription":{"trial_days": 0}}, um ein Abonnement ohne Probezeitraum zu testen.
  2. Nutzen Sie dafür den folgenden Link: https://sandbox-secure.xsolla.com/paystation3/?access_token=ACCESS_TOKEN, wobei ACCESS_TOKEN dem im vorherigen Schritt abgerufenen Token entspricht.

Ihr Fortschritt
Vielen Dank für Ihr Feedback!
Letztmalig aktualisiert: 3. November 2022

Haben Sie einen Tippfehler oder einen anderen Textfehler gefunden? Wählen Sie den Text aus und drücken Sie Strg+Eingabe.

Problem melden
Wir überprüfen unsere Inhalte ständig. Ihr Feedback hilft uns, sie zu verbessern.
Geben Sie eine E-Mail-Adresse an, damit wir Sie erreichen können
Vielen Dank für Ihr Feedback!