So rufen Sie einen Zahlungstoken ab
Zum Öffnen des Zahlungsportals benötigen Sie einen Token. Ein Token ist ein String, der verschlüsselte Daten über ein Spiel und einen Benutzer enthält. Sie müssen den Abruf eines Tokens implementieren, um den Benutzer zu identifizieren und den Kauf zu ermöglichen.
So rufen Sie einen Zahlungstoken ab:
Benutzerautorisierungstoken abrufen
Der Token verfällt 24 Stunden nach dem letzten Aufruf der Xsolla-API. Implementieren Sie die Logik für den Erhalt eines neuen Tokens nach dessen Verfall. Es wird empfohlen, einen neuen Token im Hintergrund abzurufen, damit sich der Benutzer nicht erneut bei der Anwendung anmelden muss.
Implementieren Sie im Backend Ihrer Anwendung den Abruf eines Benutzerauthentifizierungstokens. Nutzen Sie dafür eine HTTP-POST-Anfrage mit HTTP-Basisauthentifizierung, und übermitteln Sie die erforderlichen Parameter im Anfragerumpf.
HTTP-Basisauthentifizierung
Die Xsolla-API nutzt die Basisauthentifizierung. Alle Anfragen an die API müssen den Header Authorization: Basic <your_authorization_basic_key> enthalten, wobei <your_authorization_basic_key> das gemäß dem Base64-Standard kodierte Paar Händler-ID:API-Schlüssel ist. Die Parameter finden Sie im Kundenportal:
- Die Händler-ID finden Sie:
- unter Firmeneinstellungen > Firma.
- in der URL in der Adresszeile des Browsers auf einer beliebigen Seite im Kundenportal. Die URL weist das folgende Format auf:
https://publisher.xsolla.com/<merchant ID>/<Publisher Account section>.
- Der API-Schlüssel wird im Kundenportal nur einmal angezeigt, nämlich dann, wenn er erstellt wird. Sie sind selbst dafür verantwortlich, den Schlüssel zu speichern. Einen neuen Schlüssel können Sie in den folgenden Abschnitten erstellen:
- Firmeneinstellungen > API-Schlüssel
- Projekteinstellungen > API-Schlüssel
Weitere Informationen über die Arbeit mit API-Schlüsseln finden Sie in der API-Referenz.
Wichtige Empfehlungen:
- Sie sind selbst dafür verantwortlich, den generierten API-Schlüssel zu speichern. Der API-Schlüssel wird im Kundenportal nur einmal angezeigt, nämlich dann, wenn er erstellt wird.
- Halten Sie Ihren API-Schlüssel geheim. Er gewährt den Zugang zu Ihrem persönlichen Konto und Ihren Projekten im Kundenportal.
- Der API-Schlüssel muss auf Ihrem Server gespeichert sein, niemals in Binärdateien oder im Frontend.
Wenn ein API-Aufruf, den Sie benötigen, nicht den Pfadparameter project_id enthält, verwenden Sie den API-Schlüssel, der in allen Projekten des Unternehmens gültig ist, um die Autorisierung einzurichten.
Anfragerumpf
Übermitteln Sie im Anfragerumpf die folgenden erforderlichen Parameter:
| Parameter | Typ | Beschreibung |
|---|---|---|
user.id | string | Eindeutige Benutzer-ID in Ihrem System. |
user.email | string | E-Mail-Adresse des Benutzers, an die Quittungen gesendet werden sollen. Wird der Parameter nicht übermittelt, erscheint auf der Zahlungsseite ein Pflichtfeld zur Eingabe einer E-Mail-Adresse. |
settings.project_id | integer | Xsolla-ID des Spiels. Diese finden Sie im Abschnitt Projekt im Kundenportal. |
Um das Benutzererlebnis weiter zu verbessern, können Sie auch die folgenden Parameter übermitteln:
| Parameter | Typ | Beschreibung |
|---|---|---|
user.name | string | Benutzeranzeigename auf den Quittungen. |
settings.currency | string | Bevorzugte Zahlungswährung. |
settings.language | string | Sprache der Benutzeroberfläche. |
curl -i -X POST \
-u 2340:ZHgbSDVP6LtAJVWu \
https://api.xsolla.com/merchant/v2/merchants/<merchant_id>/token \
-H 'Content-Type: application/json' \
-d '{
"settings": {
"currency": "USD",
"language": "en",
"project_id": <project_id>
}
},
"user": {
"email": {
"value": "<user_email>"
},
"id": {
"value": "<user_id>"
},
"name": {
"value": "<user_name>"
}
}
}'
Beispiel: Antwort mit Benutzerauthentifizierungstoken
{
"token": "1230OWrp0KF6uqvmN8jWuzLyoXMzxTyK_lc_en"
}
Zahlungstoken abrufen
Legen Sie eine Bestellung an, um einen Zahlungstoken abzurufen. Eine Bestellung ist ein Artikel, den ein Nutzer im Shop kaufen möchte. Nachdem eine Bestellung bezahlt wurde, erhält der Nutzer den Artikel. Um den Zahlungsablauf zu testen, erstellen Sie eine Bestellung mit dem API-Aufruf Bestellung mit angegebenem Artikel anlegen:
- Wenn Sie einen Test auf der API-Dokumentationswebsite durchführen möchten, klicken Sie auf
Try it , um die Oberfläche zum Erstellen einer Anfrage zu öffnen. - Geben Sie im Block
Security in das FeldBearer Token den Token ein, den Sie während des Authentifizierungsverfahrens erhalten haben. - Geben Sie im Block
Body die Bestelldetails ein, z. B. die Artikelmenge. Um die Testumgebung zu nutzen, übermitteln Sie"sandbox": true. - Geben Sie im Block
Parameters Folgendes an:project_id– Projekt-ID aus dem Kundenportal.item_sku– Artikel-SKU.
Die Antwort enthält Daten, die Sie für die weitere Arbeit benötigen:
token– Zahlungstoken
Haben Sie einen Tippfehler oder einen anderen Textfehler gefunden? Wählen Sie den Text aus und drücken Sie Strg+Eingabe.
