Katalogbenutzeroberfläche erstellen

Die Katalogbenutzeroberlfäche lässt sich auf drei Wege erstellen:

Mithilfe einer eigenen Benutzeroberfläche

Beim Anlegen eines Verzeichnisses in Ihrer eigenen Benutzeroberfläche können Sie:

  • einen eigenen Datenspeicher und eine beliebige Autorisierungsoption nutzen. Implementieren Sie in diesem Fall die Katalogbenutzeroberfläche Ihrerseits.
  • Ihre eigene Autorisierungsmethode und die Servermethode Abo-Modelle abrufen nutzen. Implementieren Sie die Katalogbenutzeroberfläche Ihrerseits, nachdem Sie die Liste der Abo-Modelle abgerufen haben.
  • Xsolla Login und clientseitige API-Aufrufe.
Hinweis
Ebenso können Sie die SDK-Bibliotheken nutzen und damit einen Katalog in Ihrer eigenen Benutzeroberfläche implementieren. Vorgefertigte Bibliotheken erleichtern es, Xsolla-Produkte in Ihr Projekt zu integrieren, weil sie sofort einsetzbare Datenstrukturen und Methoden für die Arbeit mit der Xsolla-API bereitstellen.

Xsolla Login und clientseitige API-Aufrufe

So implementieren Sie einen Katalog:
  1. Abrufen einer Liste von Abo-Modelle mit Client-Methoden:
  2. Die empfangene Liste der Abo-Modelle muss in der Benutzeroberfläche angezeigt werden; implementieren Sie diesen Vorgang.

Clientseitige Methode zum Abrufen der Abo-Modelle nach Produkten

Nutzen Sie aufseiten Ihres Anwendungs-Clients eine HTTP GET-Anfrage, um den Abruf der Liste der Abo-Modelle zu implementieren: https://subscriptions.xsolla.com​/api/user/v1/projects/{project_id}/products/{​​productId}/plans.

Die Anfrage muss den Header Authorization: Bearer <client_user_jwt> enthalten, wobei <client_user_jwt> der JSON Web Token (JWT) des Benutzer ist – ein eindeutiger, nach dem Base64-Xsolla-Standard kodierter Token. So rufen Sie den Token ab:

  • Nutzen Sie die API-Aufrufe Register new user und Auth by username, sofern die Autorisierung bei Ihrer Anwendung über Benutzername und Passwort erfolgt.
  • Nutzen Sie den API-Aufruf Auth via social network, sofern die Autorisierung bei Ihrer Anwendung über ein soziales Netzwerk erfolgt.

Als Pfadparameter angeben:
  • projectId – Projekt-ID. Diesen Parameter finden Sie im Kundenportal neben dem Projektnamen.
  • productID – ID des abonnementbasierten Produkts. Wenden Sie sich dazu an Ihren Customer Success Manager oder senden Sie eine E-Mail an csm@xsolla.com.

Als Abfrageparameter angeben:
ParameterTypBeschreibung
plan_id
array of integersID des Abo-Modells.
plan_external_id
array of stringsExternal ID des Abo-Modells. Diese finden Sie im Kundenportal unter Subscriptions > Abo-Modelle > Ihr Abo-Modell oder indem Sie den API-Aufruf Abo-Modelle abrufen nutzen.
limit
integerBegrenzung der Elementanzahl auf der Seite. Standardmäßig werden 15 Elemente angezeigt.
offset
integerElementnummer, aus der die Liste generiert wird. Die Zählung beginnt standardmäßig bei 0.
locale
stringSprache der Benutzeroberfläche, Code bestehend aus zwei Kleinbuchstaben gemäß ISO 639-1. Wird dieser Parameter nicht übermittelt, wird die Sprache anhand der IP-Adresse des Benutzer bestimmt.
Verfügbare Werte:
  • en – Englisch
  • ar – Arabisch
  • bg – Bulgarisch
  • cn – Chinesisch (vereinfacht)
  • cs – Tschechisch
  • de – Deutsch
  • es – Spanisch
  • fr – Französisch
  • he – Hebräisch
  • it – Italienisch
  • ja – Japanisch
  • ko – Koreanisch
  • pl – Polnisch
  • pt – Portugiesisch
  • ro – Rumänisch
  • ru – Russisch
  • th – Thai
  • tr – Türkisch
  • tw – Chinesisch (traditionell)
  • vi – Vietnamesisch
Wird ein Gebietsschema übermittelt, das nicht in der Xsolla-Liste aufgeführt ist, wird das englische Gebietsschema verwendet.
country
stringCode bestehend aus zwei Buchstaben gemäß ISO 3166-1 Alpha-2. Dient dazu, das Land des Benutzers zu bestimmen. Dieser Parameter wirkt sich auf die Wahl des Gebietsschemas und der Währung aus. Wird dieser Parameter nicht übermittelt, wird das Land des Benutzers anhand seiner IP-Adresse bestimmt.
Copy
Full screen
Small screen
curl -X 'GET' \
'https://subscriptions.xsolla.com/api/user/v1/projects/{project_id}/products/{​​productId}/plans?country=RU  ' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer client_user_jwt'
Copy
Full screen
Small screen
{
  "items": [
    {
      "plan_id": 54321,
      "plan_external_id": "PlanExternalId",
      "plan_group_id": "TestGroupId",
      "plan_type": "all",
      "plan_name": "Localized plan name",
      "plan_description": "Localized plan description",
      "plan_start_date": "2021-04-11T13:51:02+03:00",
      "plan_end_date": "2031-04-11T13:51:02+03:00",
      "trial_period": 7,
      "period": {
        "value": 1,
        "unit": "month"
      },
      "charge": {
        "amount": 4.99,
        "setup_fee": 0.99,
        "currency": "USD"
      },
      "promotion": {
        "promotion_charge_amount": 3.99,
        "promotion_remaining_charges": 3
      }
    }
  ],
  "has_more": false
}

Clientseitige Methode für den Abruf der Liste der Abo-Modelle

Nutzen Sie aufseiten Ihres Anwendungs-Clients eine HTTP GET-Anfrage, um den Abruf der Liste der Abo-Modelle zu implementieren: https://subscriptions.xsolla.com​/api/user/v1/projects/{project_id}/plans.

Die Anfrage muss den Header Authorization: Bearer <client_user_jwt> enthalten, wobei <client_user_jwt> der JSON Web Token (JWT) des Benutzer ist – ein eindeutiger, nach dem Base64-Xsolla-Standard kodierter Token. So rufen Sie den Token ab:

  • Nutzen Sie die API-Aufrufe Register new user und Auth by username, sofern die Autorisierung bei Ihrer Anwendung über Benutzername und Passwort erfolgt.
  • Nutzen Sie den API-Aufruf Auth via social network, sofern die Autorisierung bei Ihrer Anwendung über ein soziales Netzwerk erfolgt.

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

Als Abfrageparameter angeben:

ParameterTypBeschreibung
plan_id
array of integersID des Abo-Modells.
plan_external_id
array of stringsExternal ID des Abo-Modells. Diese finden Sie im Kundenportal unter Subscriptions > Abo-Modelle > Ihr Abo-Modell oder indem Sie den API-Aufruf Abo-Modelle abrufen nutzen.
limit
integerBegrenzung der Elementanzahl auf der Seite. Standardmäßig werden 15 Elemente angezeigt.
offset
integerElementnummer, aus der die Liste generiert wird. Die Zählung beginnt standardmäßig bei 0.
locale
stringSprache der Benutzeroberfläche, Code bestehend aus zwei Kleinbuchstaben gemäß ISO 639-1. Wird dieser Parameter nicht übermittelt, wird die Sprache anhand der IP-Adresse des Benutzer bestimmt.
Verfügbare Werte:
  • en – Englisch
  • ar – Arabisch
  • bg – Bulgarisch
  • cn – Chinesisch (vereinfacht)
  • cs – Tschechisch
  • de – Deutsch
  • es – Spanisch
  • fr – Französisch
  • he – Hebräisch
  • it – Italienisch
  • ja – Japanisch
  • ko – Koreanisch
  • pl – Polnisch
  • pt – Portugiesisch
  • ro – Rumänisch
  • ru – Russisch
  • th – Thai
  • tr – Türkisch
  • tw – Chinesisch (traditionell)
  • vi – Vietnamesisch
Wird ein Gebietsschema übermittelt, das nicht in der Xsolla-Liste aufgeführt ist, wird das englische Gebietsschema verwendet.
country
stringCode bestehend aus zwei Buchstaben gemäß ISO 3166-1 Alpha-2. Dient dazu, das Land des Benutzers zu bestimmen. Dieser Parameter wirkt sich auf die Wahl des Gebietsschemas und der Währung aus. Wird dieser Parameter nicht übermittelt, wird das Land des Benutzers anhand seiner IP-Adresse bestimmt.
Copy
Full screen
Small screen
curl -X 'GET' \
'https://subscriptions.xsolla.com/api/user/v1/projects/{project_id}/plans?country=RU  ' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer client_user_jwt'
Copy
Full screen
Small screen
{
  "items": [
    {
      "plan_id": 54321,
      "plan_external_id": "PlanExternalId",
      "plan_group_id": "TestGroupId",
      "plan_type": "all",
      "plan_name": "Localized plan name",
      "plan_description": "Localized plan description",
      "plan_start_date": "2021-04-11T13:51:02+03:00",
      "plan_end_date": "2031-04-11T13:51:02+03:00",
      "trial_period": 7,
      "period": {
        "value": 1,
        "unit": "month"
      },
      "charge": {
        "amount": 4.99,
        "setup_fee": 0.99,
        "currency": "USD"
      },
      "promotion": {
        "promotion_charge_amount": 3.99,
        "promotion_remaining_charges": 3
      }
    }
  ],
  "has_more": false
}

Mithilfe der Xsolla Pay Station

  1. Implementieren Sie den Abruf des Tokens über den serverseitigen API-Aufruf Token erstellen. Übermitteln Sie in der Anfrage die folgenden Parameter:
    • user.id – Benutzer-ID in Ihrem Autorisierungssystem.
    • user.email – E-Mail-Adresse des Benutzers. Muss dem Protokoll RFC 822 entsprechen.
    • settings.project_id – Projekt-ID. Diesen Parameter finden Sie im Kundenportal neben dem Namen des Projekts.
  2. Implementieren Sie, worin das Zahlungsportal geöffnet werden soll. Möglich sind:
Copy
Full screen
Small screen
{
    "user": {
        "name": {
            "value": "j.smith@email.com"
        },
        "id": {
            "value": "123a345b678c091d"
        }
    },
    "settings": {
        "project_id": 177226
    }
}

Beispiel für die Anzeige des Abonnementkatalogs in der Xsolla Pay Station:

Mithilfe des Xsolla Site Builders

Mit dem Site Builder von Xsolla können Sie eine Website erstellen und darüber Abonnements verkaufen. Verwenden Sie dazu die Web Shop-Vorlage. Mehr über das Konfigurieren von Rollen erfahren Sie in der Anleitung Web Shop mit Benutzerauthentifizierung.

War dieser Artikel hilfreich?
Vielen Dank!
Gibt es etwas, das wir verbessern können? Nachricht
Das tut uns leid
Bitte erläutern Sie, weshalb dieser Artikel nicht hilfreich ist. Nachricht
Vielen Dank für Ihr Feedback!
Wir werden Ihr Feedback aufgreifen und dazu nutzen, Ihr Erlebnis verbessern.
Letztmalig aktualisiert: 31. Juli 2024

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!