Abonnementinformationen abrufen

Wenn Sie Abonnements im Webshop verkaufen wollen, implementieren Sie den Empfang von Informationen über Aktionen mit Abonnements auf eine der folgenden Weisen:

  • über API (geeignet für die serverlose Integration)
  • über Webhooks (automatische Benachrichtigungen, geeignet für die Integration mit Server)

Ü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:

Projekt-ID als Pfadparameter projectIdayngeben. Sie können diesen Parameter in Ihrem Kundenportal neben dem Projektnamen finden. 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": 13371337,
      "plan_id": 66053,
      "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": 5,
        "unit": "day"
      }
    }
  ],
  "has_more": true
}

Über Webhooks einrichten

  1. Konfigurieren Sie Parameter für den Empfang von Webhooks:
    1. Öffnen Sie Ihr Projekt im Kundenportal.
    2. Klicken Sie im seitlichen Menü auf Projekteinstellungen.
    3. Wechseln Sie zum Abschnitt Webhooks.
    4. Setzen Sie den Umschalter Webhooks auf Ein.
    5. Geben Sie im Feld Webhook-URL die URL für den Empfang von Webhooks an.
    6. Standardmäßig wird ein geheimer Schlüssel zum Signieren von Projekt-Webhooks generiert. Wenn Sie einen neuen geheimen Schlüssel generieren möchten, klicken Sie auf das Aktualisieren-Symbol.
    7. Klicken Sie auf Einstellungen speichern.

  1. Implementierung der Verarbeitung von folgenden Webhooks-Typen in Ihrer Anwendung:

  1. Webhooks testen:
    1. ImKundenportal> Projekteinstellungen > Webhooks zur Registrierkarte Abonnements wechseln.

    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:
      • Benutzer-ID
      • Xsolla-Rechnungs-ID
      • Betrag
      • Währung
      • ID des Abo-Plans
      • Abo-Produkt (optional)
      • Rechnungs-ID – interne Bestellnummer (optional)
      • Probezeitraum (Zum Testen der Abonnementzahlung in der Testumgebung oder zum Testen der Abonnementverlängerung, legen Sie als Wert 0 fest.)

Hinweis
Im Kundenportal können Sie nur die grundlegenden Webhooks Benutzervalidierung und Zahlung testen.

    1. Klicken Sie Test.
    2. Bestätigen Sie, dass Sie eine Bestätigungsmeldung über einen erfolgreichen Test erhalten haben. Wenn Ihr Test erfolgreich ist, muss Ihr Server folgendermaßen antworten:
      • HTTP Code 204 ohne Nachrichtentext.
      • HTTP Code 400 oder 500 mit Problembeschreibung erscheint, wenn der eingegebene Benutzer nicht gefunden oder eine ungültige Signatur übermittelt wurde.

  1. Testen Sie den Empfang der übrigen Webhooks:
    1. Verwenden Sie die Testumgebung, um den Kauf und die Verlängerung eines Abonnements zu testen und die Webhooks Erstelltes Abonnement, Aktualisiertes Abonnement und Gekündigtes Abonnement zu erhalten.
    2. Verwenden Sie den Live-Modus, um den Kauf des Abonnements anhand von echten Einzahlungen zu testen und die Webhooks Erstattung und Gekündigtes Abonnement zu erhalten.

Ihr Fortschritt
Vielen Dank für Ihr Feedback!
Letztmalig aktualisiert: 8. August 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!