Abonnementinformationen abrufen

Wenn Sie Abonnements im Web Shop 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:

• Bei Authentifizierung mit Login und Passwort verwenden Sie die API-Aufrufe Register a new user und Auth by username and password.
• Bei Authentifizierung über soziale Netzwerke verwenden Sie den API-Aufruf Auth via social network.

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.

-X 'GET' \
  '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'

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
}

Über Webhooks einrichten

1. Konfigurieren Sie Parameter für den Empfang von Webhooks:
   1. Öffnen Sie Ihr Projekt im Kundenportal.
   2. Klicken Sie in der Seitenleiste auf Projekteinstellungen, und wechseln Sie zur Registerkarte Webhooks.
   3. Geben Sie im Feld Webhook-Server die URL Ihres Servers an, auf dem Sie Webhooks im Format https://example.com empfangen möchten. Sie können auch eine URL aus einem Tool, mit dem sich Webhooks testen lassen, angeben.
   4. 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.
   5. Klicken Sie auf Webhooks aktivieren.

2. Implementierung der Verarbeitung von folgenden Webhooks-Typen in Ihrer Anwendung:
   • Um ein Abonnement zu kaufen und zu erneuern:
     • Benutzervalidierung
     • Zahlung
     • Erstelltes Abonnement
     • Aktualisiertes Abonnement
   • Um ein Abonnement zu kündigen: Gekündigtes Abonnement
   • Um eine Erstattung durchzuführen: Erstatten

3. Webhooks testen:
   1. Im Kundenportal > Projekteinstellungen > Webhooks zur Registrierkarte Subscriptions wechseln.

2. 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 (Legen Sie zum Testen des Abonnementabschlusses in der Testumgebung oder zum Testen der Abonnementverlängerung als Wert 0 fest.)

3. Klicken Sie Test.
4. 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.

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

Nächste Schritte

1. Konfigurieren Sie die Benutzerauthentifizierung.
2. Testen Sie den Web Shop in der Testumgebung.

Nützliche Links

Integrationsablauf