Katalogbenutzeroberfläche erstellen
Die Katalogbenutzeroberlfäche lässt sich auf drei Wege erstellen:
- mithilfe einer eigenen Benutzeroberfläche
- mithilfe der Xsolla Pay Station
- mithilfe des Xsolla Site Builders
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.
Xsolla Login und clientseitige API-Aufrufe
So implementieren Sie einen Katalog:- Abrufen einer Liste von Abo-Modelle mit Client-Methoden:
- Wenn in Ihrem Projekt abonnementbasierte Produkte konfiguriert sind, verwenden Sie die clientseitige Methode zum Abruf der Abo-Modelle nach Produkten
- Wenn in Ihrem Projekt keine abonnementbasierten Produkte konfiguriert sind, verwenden Sie die clientseitige Methode zum Abruf der Liste der Abo-Modelle
- 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 undAuth 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.
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.
Parameter | Typ | Beschreibung |
---|---|---|
plan_id | array of integers | ID des Abo-Modells. |
| array of strings | External 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. |
| integer | Begrenzung der Elementanzahl auf der Seite. Standardmäßig werden 15 Elemente angezeigt. |
| integer | Elementnummer, aus der die Liste generiert wird. Die Zählung beginnt standardmäßig bei 0. |
| string | Sprache 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:
|
| string | Code 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. |
- curl
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'
- javascript
{
"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 undAuth 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.
projectId
an. Sie finden diesen Parameter im Kundenportal neben dem Projektnamen.Als Abfrageparameter angeben:
Parameter | Typ | Beschreibung |
---|---|---|
plan_id | array of integers | ID des Abo-Modells. |
| array of strings | External 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. |
| integer | Begrenzung der Elementanzahl auf der Seite. Standardmäßig werden 15 Elemente angezeigt. |
| integer | Elementnummer, aus der die Liste generiert wird. Die Zählung beginnt standardmäßig bei 0. |
| string | Sprache 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:
|
| string | Code 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. |
- curl
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'
- javascript
{
"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
- 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.
- Implementieren Sie, worin das Zahlungsportal geöffnet werden soll. Möglich sind:
- javascript
{
"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.
Haben Sie einen Tippfehler oder einen anderen Textfehler gefunden? Wählen Sie den Text aus und drücken Sie Strg+Eingabe.